Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: using another markdown syntax for this one #3639

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/components/src/components/accordion/model.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ export type DBAccordionDefaultProps = {

/**
* Defines the display of the accordion and the items:
* "default": with a dividing line between the items
* "card": w/o dividing line, but items are shown in the card variant
* - "default": with a dividing line between the items
* - "card": w/o dividing line, but items are shown in the card variant
*/
variant?: AccordionVariantType;
};
Expand Down
12 changes: 6 additions & 6 deletions packages/components/src/components/header/model.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,20 @@ export type DBHeaderDefaultProps = {
brand?: any;
/**
* Slot to pass in a meta navigation.
* Desktop: Above the regular header
* Mobile: Inside the drawer
* - Desktop: Above the regular header
* - Mobile: Inside the drawer
*/
metaNavigation?: any;
/**
* Slot to pass one or more elements like DBButton (e.g. search) as primary action.
* Desktop: Shown next to the main-navigation
* Mobile: Shown next to the brand
* - Desktop: Shown next to the main-navigation
* - Mobile: Shown next to the brand
*/
primaryAction?: any;
/**
* Slot to pass one or more elements like DBButton (e.g. profile, language, etc.) as secondary action.
* Desktop: Shown seperated by divider at the end of the header
* Mobile: Shown inside the drawer at the bottom.
* - Desktop: Shown seperated by divider at the end of the header
* - Mobile: Shown inside the drawer at the bottom.
*/
secondaryAction?: any;

Expand Down
6 changes: 3 additions & 3 deletions packages/components/src/components/notification/model.ts
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,9 @@ export type DBNotificationDefaultProps = {

/**
* The variant attribute changes the styling of the notification.
* The docked notifications are used e.g. between header and main content to show a global alert.
* The standalone notifications are used e.g. inside a form to show an alert for a specific field.
* The overlay notifications are used for absolute and floating notifications like snackbars etc.
* - The docked notifications are used e.g. between header and main content to show a global alert.
* - The standalone notifications are used e.g. inside a form to show an alert for a specific field.
* - The overlay notifications are used for absolute and floating notifications like snackbars etc.
*/
variant?: NotificationVariantType;
};
Expand Down
4 changes: 2 additions & 2 deletions packages/components/src/shared/model.ts
Original file line number Diff line number Diff line change
Expand Up @@ -590,14 +590,14 @@ export type NavigationBackButtonProps = {

export type AriaLabelledByProps = {
/**
* Pass aria-labelledby to inner element
* Pass `aria-labelledby` to inner element
*/
labelledBy?: string;
};

export type AriaControlsProps = {
/**
* Pass aria-controls to inner element
* Pass `aria-controls` to inner element
*/
controls?: string;
};
Expand Down
Loading