chore: update docs

sbb-design-systems · May 6, 2024 · 75c0e33 · 75c0e33
1 parent 335098e
commit 75c0e33
Show file tree

Hide file tree

Showing 14 changed files with 46 additions and 46 deletions.
diff --git a/src/components/breadcrumb/breadcrumb/readme.md b/src/components/breadcrumb/breadcrumb/readme.md
@@ -46,7 +46,7 @@ By default, the `sbb-breadcrumb-group` component sets `aria-current="page"` on t
 | `target`             | `target`              | public  | `LinkTargetType \| string \| undefined` |         | Where to display the linked URL.                                                                                                 |
 | `rel`                | `rel`                 | public  | `string \| undefined`                   |         | The relationship of the linked URL as space-separated link types.                                                                |
 | `download`           | `download`            | public  | `boolean \| undefined`                  |         | Whether the browser will show the download dialog on click.                                                                      |
-| `accessibilityLabel` | `accessibility-label` | public  | `string \| undefined`                   |         | This will be forwarded as aria-label to the relevant nested element.                                                             |
+| `accessibilityLabel` | `accessibility-label` | public  | `string \| undefined`                   |         | This will be forwarded as aria-label to the inner anchor element.                                                                |
 
 ## Slots
 

diff --git a/src/components/button/button-link/readme.md b/src/components/button/button-link/readme.md
@@ -82,7 +82,7 @@ Use the accessibility properties in case of an icon-only button to describe the
 | `target`             | `target`              | public  | `LinkTargetType \| string \| undefined` |         | Where to display the linked URL.                                                                                                 |
 | `rel`                | `rel`                 | public  | `string \| undefined`                   |         | The relationship of the linked URL as space-separated link types.                                                                |
 | `download`           | `download`            | public  | `boolean \| undefined`                  |         | Whether the browser will show the download dialog on click.                                                                      |
-| `accessibilityLabel` | `accessibility-label` | public  | `string \| undefined`                   |         | This will be forwarded as aria-label to the relevant nested element.                                                             |
+| `accessibilityLabel` | `accessibility-label` | public  | `string \| undefined`                   |         | This will be forwarded as aria-label to the inner anchor element.                                                                |
 
 ## Slots
 

diff --git a/src/components/button/secondary-button-link/readme.md b/src/components/button/secondary-button-link/readme.md
@@ -87,7 +87,7 @@ Use the accessibility properties in case of an icon-only button to describe the
 | `target`             | `target`              | public  | `LinkTargetType \| string \| undefined` |         | Where to display the linked URL.                                                                                                 |
 | `rel`                | `rel`                 | public  | `string \| undefined`                   |         | The relationship of the linked URL as space-separated link types.                                                                |
 | `download`           | `download`            | public  | `boolean \| undefined`                  |         | Whether the browser will show the download dialog on click.                                                                      |
-| `accessibilityLabel` | `accessibility-label` | public  | `string \| undefined`                   |         | This will be forwarded as aria-label to the relevant nested element.                                                             |
+| `accessibilityLabel` | `accessibility-label` | public  | `string \| undefined`                   |         | This will be forwarded as aria-label to the inner anchor element.                                                                |
 
 ## Slots
 

diff --git a/src/components/button/tertiary-button-link/readme.md b/src/components/button/tertiary-button-link/readme.md
@@ -87,7 +87,7 @@ Use the accessibility properties in case of an icon-only button to describe the
 | `target`             | `target`              | public  | `LinkTargetType \| string \| undefined` |         | Where to display the linked URL.                                                                                                 |
 | `rel`                | `rel`                 | public  | `string \| undefined`                   |         | The relationship of the linked URL as space-separated link types.                                                                |
 | `download`           | `download`            | public  | `boolean \| undefined`                  |         | Whether the browser will show the download dialog on click.                                                                      |
-| `accessibilityLabel` | `accessibility-label` | public  | `string \| undefined`                   |         | This will be forwarded as aria-label to the relevant nested element.                                                             |
+| `accessibilityLabel` | `accessibility-label` | public  | `string \| undefined`                   |         | This will be forwarded as aria-label to the inner anchor element.                                                                |
 
 ## Slots
 

diff --git a/src/components/button/transparent-button-link/readme.md b/src/components/button/transparent-button-link/readme.md
@@ -87,7 +87,7 @@ Use the accessibility properties in case of an icon-only button to describe the
 | `target`             | `target`              | public  | `LinkTargetType \| string \| undefined` |         | Where to display the linked URL.                                                                                                 |
 | `rel`                | `rel`                 | public  | `string \| undefined`                   |         | The relationship of the linked URL as space-separated link types.                                                                |
 | `download`           | `download`            | public  | `boolean \| undefined`                  |         | Whether the browser will show the download dialog on click.                                                                      |
-| `accessibilityLabel` | `accessibility-label` | public  | `string \| undefined`                   |         | This will be forwarded as aria-label to the relevant nested element.                                                             |
+| `accessibilityLabel` | `accessibility-label` | public  | `string \| undefined`                   |         | This will be forwarded as aria-label to the inner anchor element.                                                                |
 
 ## Slots
 

diff --git a/src/components/card/card-link/readme.md b/src/components/card/card-link/readme.md
@@ -22,14 +22,14 @@ as it is used for search engines and screen-reader users.
 
 ## Properties
 
-| Name                 | Attribute             | Privacy | Type                                    | Default | Description                                                          |
-| -------------------- | --------------------- | ------- | --------------------------------------- | ------- | -------------------------------------------------------------------- |
-| `active`             | `active`              | public  | `boolean`                               | `false` | Whether the card is active.                                          |
-| `href`               | `href`                | public  | `string \| undefined`                   |         | The href value you want to link to.                                  |
-| `target`             | `target`              | public  | `LinkTargetType \| string \| undefined` |         | Where to display the linked URL.                                     |
-| `rel`                | `rel`                 | public  | `string \| undefined`                   |         | The relationship of the linked URL as space-separated link types.    |
-| `download`           | `download`            | public  | `boolean \| undefined`                  |         | Whether the browser will show the download dialog on click.          |
-| `accessibilityLabel` | `accessibility-label` | public  | `string \| undefined`                   |         | This will be forwarded as aria-label to the relevant nested element. |
+| Name                 | Attribute             | Privacy | Type                                    | Default | Description                                                       |
+| -------------------- | --------------------- | ------- | --------------------------------------- | ------- | ----------------------------------------------------------------- |
+| `active`             | `active`              | public  | `boolean`                               | `false` | Whether the card is active.                                       |
+| `href`               | `href`                | public  | `string \| undefined`                   |         | The href value you want to link to.                               |
+| `target`             | `target`              | public  | `LinkTargetType \| string \| undefined` |         | Where to display the linked URL.                                  |
+| `rel`                | `rel`                 | public  | `string \| undefined`                   |         | The relationship of the linked URL as space-separated link types. |
+| `download`           | `download`            | public  | `boolean \| undefined`                  |         | Whether the browser will show the download dialog on click.       |
+| `accessibilityLabel` | `accessibility-label` | public  | `string \| undefined`                   |         | This will be forwarded as aria-label to the inner anchor element. |
 
 ## Slots
 

diff --git a/src/components/header/header-link/readme.md b/src/components/header/header-link/readme.md
@@ -39,7 +39,7 @@ accepting its associated properties (`href`, `target`, `rel` and `download`).
 | `target`             | `target`              | public  | `LinkTargetType \| string \| undefined` |            | Where to display the linked URL.                                                                                                                                                         |
 | `rel`                | `rel`                 | public  | `string \| undefined`                   |            | The relationship of the linked URL as space-separated link types.                                                                                                                        |
 | `download`           | `download`            | public  | `boolean \| undefined`                  |            | Whether the browser will show the download dialog on click.                                                                                                                              |
-| `accessibilityLabel` | `accessibility-label` | public  | `string \| undefined`                   |            | This will be forwarded as aria-label to the relevant nested element.                                                                                                                     |
+| `accessibilityLabel` | `accessibility-label` | public  | `string \| undefined`                   |            | This will be forwarded as aria-label to the inner anchor element.                                                                                                                        |
 
 ## Slots
 

diff --git a/src/components/link/block-link/readme.md b/src/components/link/block-link/readme.md
@@ -61,7 +61,7 @@ The component has three sizes (`xs`, `s`, which is the default, and `m`).
 | `target`             | `target`              | public  | `LinkTargetType \| string \| undefined` |           | Where to display the linked URL.                                                                                                 |
 | `rel`                | `rel`                 | public  | `string \| undefined`                   |           | The relationship of the linked URL as space-separated link types.                                                                |
 | `download`           | `download`            | public  | `boolean \| undefined`                  |           | Whether the browser will show the download dialog on click.                                                                      |
-| `accessibilityLabel` | `accessibility-label` | public  | `string \| undefined`                   |           | This will be forwarded as aria-label to the relevant nested element.                                                             |
+| `accessibilityLabel` | `accessibility-label` | public  | `string \| undefined`                   |           | This will be forwarded as aria-label to the inner anchor element.                                                                |
 
 ## Slots
 

diff --git a/src/components/link/link/readme.md b/src/components/link/link/readme.md
@@ -40,7 +40,7 @@ accepting its associated properties (`href`, `target`, `rel` and `download`).
 | `target`             | `target`              | public  | `LinkTargetType \| string \| undefined` |         | Where to display the linked URL.                                                                                           |
 | `rel`                | `rel`                 | public  | `string \| undefined`                   |         | The relationship of the linked URL as space-separated link types.                                                          |
 | `download`           | `download`            | public  | `boolean \| undefined`                  |         | Whether the browser will show the download dialog on click.                                                                |
-| `accessibilityLabel` | `accessibility-label` | public  | `string \| undefined`                   |         | This will be forwarded as aria-label to the relevant nested element.                                                       |
+| `accessibilityLabel` | `accessibility-label` | public  | `string \| undefined`                   |         | This will be forwarded as aria-label to the inner anchor element.                                                          |
 
 ## Slots
 

diff --git a/src/components/menu/menu-link/readme.md b/src/components/menu/menu-link/readme.md
@@ -39,7 +39,7 @@ accepting its associated properties (`href`, `target`, `rel` and `download`).
 | `target`             | `target`              | public  | `LinkTargetType \| string \| undefined` |         | Where to display the linked URL.                                                                                                 |
 | `rel`                | `rel`                 | public  | `string \| undefined`                   |         | The relationship of the linked URL as space-separated link types.                                                                |
 | `download`           | `download`            | public  | `boolean \| undefined`                  |         | Whether the browser will show the download dialog on click.                                                                      |
-| `accessibilityLabel` | `accessibility-label` | public  | `string \| undefined`                   |         | This will be forwarded as aria-label to the relevant nested element.                                                             |
+| `accessibilityLabel` | `accessibility-label` | public  | `string \| undefined`                   |         | This will be forwarded as aria-label to the inner anchor element.                                                                |
 
 ## CSS Properties
 

diff --git a/src/components/navigation/navigation-link/readme.md b/src/components/navigation/navigation-link/readme.md
@@ -31,17 +31,17 @@ The component has three different sizes, which can be changed using the `size` p
 
 ## Properties
 
-| Name                 | Attribute             | Privacy | Type                                       | Default | Description                                                          |
-| -------------------- | --------------------- | ------- | ------------------------------------------ | ------- | -------------------------------------------------------------------- |
-| `size`               | `size`                | public  | `SbbNavigationActionSize \| undefined`     | `'l'`   | Action size variant.                                                 |
-| `connectedSection`   | -                     | public  | `SbbNavigationSectionElement \| undefined` |         | The section that is beign controlled by the action, if any.          |
-| `marker`             | -                     | public  | `SbbNavigationMarkerElement \| null`       |         | The navigation marker in which the action is nested.                 |
-| `section`            | -                     | public  | `SbbNavigationSectionElement \| null`      |         | The section in which the action is nested.                           |
-| `href`               | `href`                | public  | `string \| undefined`                      |         | The href value you want to link to.                                  |
-| `target`             | `target`              | public  | `LinkTargetType \| string \| undefined`    |         | Where to display the linked URL.                                     |
-| `rel`                | `rel`                 | public  | `string \| undefined`                      |         | The relationship of the linked URL as space-separated link types.    |
-| `download`           | `download`            | public  | `boolean \| undefined`                     |         | Whether the browser will show the download dialog on click.          |
-| `accessibilityLabel` | `accessibility-label` | public  | `string \| undefined`                      |         | This will be forwarded as aria-label to the relevant nested element. |
+| Name                 | Attribute             | Privacy | Type                                       | Default | Description                                                       |
+| -------------------- | --------------------- | ------- | ------------------------------------------ | ------- | ----------------------------------------------------------------- |
+| `size`               | `size`                | public  | `SbbNavigationActionSize \| undefined`     | `'l'`   | Action size variant.                                              |
+| `connectedSection`   | -                     | public  | `SbbNavigationSectionElement \| undefined` |         | The section that is beign controlled by the action, if any.       |
+| `marker`             | -                     | public  | `SbbNavigationMarkerElement \| null`       |         | The navigation marker in which the action is nested.              |
+| `section`            | -                     | public  | `SbbNavigationSectionElement \| null`      |         | The section in which the action is nested.                        |
+| `href`               | `href`                | public  | `string \| undefined`                      |         | The href value you want to link to.                               |
+| `target`             | `target`              | public  | `LinkTargetType \| string \| undefined`    |         | Where to display the linked URL.                                  |
+| `rel`                | `rel`                 | public  | `string \| undefined`                      |         | The relationship of the linked URL as space-separated link types. |
+| `download`           | `download`            | public  | `boolean \| undefined`                     |         | Whether the browser will show the download dialog on click.       |
+| `accessibilityLabel` | `accessibility-label` | public  | `string \| undefined`                      |         | This will be forwarded as aria-label to the inner anchor element. |
 
 ## Slots