From 4e3b957dff83139b6b18dda3fabf531047842668 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke Date: Fri, 3 Jan 2025 11:37:39 +0100 Subject: [PATCH 1/3] refactor: using another markdown syntax for this one --- packages/components/src/components/tag/model.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/components/src/components/tag/model.ts b/packages/components/src/components/tag/model.ts index 1a6b94cf68f..e949a695c2f 100644 --- a/packages/components/src/components/tag/model.ts +++ b/packages/components/src/components/tag/model.ts @@ -15,8 +15,8 @@ export type TagBehaviourType = (typeof TagBehaviourList)[number]; export type DBTagDefaultProps = { /** * Defines the behaviour of the component: - * - static: default behaviour without remove button - * - removable: add a remove button at the end of the tag + * * static: default behaviour without remove button + * * removable: add a remove button at the end of the tag */ behaviour?: TagBehaviourType; From b83fe40fab5b63217dea13c684155853228987f7 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke Date: Fri, 3 Jan 2025 13:24:41 +0100 Subject: [PATCH 2/3] Revert "refactor: using another markdown syntax for this one" This reverts commit 4e3b957dff83139b6b18dda3fabf531047842668. --- packages/components/src/components/tag/model.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/components/src/components/tag/model.ts b/packages/components/src/components/tag/model.ts index e949a695c2f..1a6b94cf68f 100644 --- a/packages/components/src/components/tag/model.ts +++ b/packages/components/src/components/tag/model.ts @@ -15,8 +15,8 @@ export type TagBehaviourType = (typeof TagBehaviourList)[number]; export type DBTagDefaultProps = { /** * Defines the behaviour of the component: - * * static: default behaviour without remove button - * * removable: add a remove button at the end of the tag + * - static: default behaviour without remove button + * - removable: add a remove button at the end of the tag */ behaviour?: TagBehaviourType; From 125d820a59a6e6576d2d8b8d62994c92e652d983 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke Date: Fri, 3 Jan 2025 13:48:31 +0100 Subject: [PATCH 3/3] refactor: added more markdown --- .../components/src/components/accordion/model.ts | 4 ++-- packages/components/src/components/header/model.ts | 12 ++++++------ .../components/src/components/notification/model.ts | 6 +++--- packages/components/src/shared/model.ts | 4 ++-- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/packages/components/src/components/accordion/model.ts b/packages/components/src/components/accordion/model.ts index 3a7c1aebb15..03bd1e099d7 100644 --- a/packages/components/src/components/accordion/model.ts +++ b/packages/components/src/components/accordion/model.ts @@ -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; }; diff --git a/packages/components/src/components/header/model.ts b/packages/components/src/components/header/model.ts index 90cd38b5164..3d7e0346b36 100644 --- a/packages/components/src/components/header/model.ts +++ b/packages/components/src/components/header/model.ts @@ -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; diff --git a/packages/components/src/components/notification/model.ts b/packages/components/src/components/notification/model.ts index b243b7e7688..66c7e7c476c 100644 --- a/packages/components/src/components/notification/model.ts +++ b/packages/components/src/components/notification/model.ts @@ -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; }; diff --git a/packages/components/src/shared/model.ts b/packages/components/src/shared/model.ts index 104019e23dd..d57352cd2bc 100644 --- a/packages/components/src/shared/model.ts +++ b/packages/components/src/shared/model.ts @@ -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; };