Skip to content

Commit

Permalink
chore(docs): update readme files
Browse files Browse the repository at this point in the history
  • Loading branch information
@TomMenga
TomMenga committed Oct 27, 2023
1 parent 3f854dc commit a98e629
Show file tree
Hide file tree
Showing 88 changed files with 732 additions and 753 deletions.
12 changes: 6 additions & 6 deletions src/components/sbb-accordion/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,13 @@ In the following example, all the `sbb-expansion-panel-header` would be wrapped
<!-- Auto Generated Below -->


## Properties
## Properties

| Name | Privacy | Type | Default | Description | Inherited From |
| ------------------ | ------- | -------------------- | ------- | --------------------------------------------------------------------------- | -------------- |
| `titleLevel` | public | `TitleLevel \| null` | | The heading level for the sbb-expansion-panel-headers within the component. | |
| `disableAnimation` | public | `boolean` | `false` | Whether the animation should be disabled. | |
| `multi` | public | `boolean` | | Whether more than one sbb-expansion-panel can be open at the same time. | |
| Name | Attribute | Privacy | Type | Default | Description |
| ------------------ | ------------------ | ------- | -------------------- | ------- | --------------------------------------------------------------------------- |
| `titleLevel` | `title-level` | public | `TitleLevel \| null` | | |
| `disableAnimation` | `disable-animation` | public | `boolean` | `false` | Whether the animation should be disabled. |
| `multi` | `multi` | public | `boolean` | | Whether more than one sbb-expansion-panel can be open at the same time. |

## Slots

Expand Down
18 changes: 9 additions & 9 deletions src/components/sbb-action-group/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,15 +116,15 @@ The values for `align-group` and `align-self` for the various allocations are as
<!-- Auto Generated Below -->


## Properties

| Name | Privacy | Type | Default | Description | Inherited From |
| ---------------- | ------- | ------------------------------------------------------------------ | -------------- | ------------------------------------------------------------------------------------------------------------------- | -------------- |
| `alignGroup` | public | `InterfaceSbbActionGroupAttributes['alignGroup']` | `'start'` | Set the slotted \`\<sbb-action-group>\` children's alignment. | |
| `horizontalFrom` | public | `InterfaceSbbActionGroupAttributes['horizontalFrom'] \| undefined` | `'medium'` | Overrides the behaviour of \`orientation\` property. | |
| `orientation` | public | `InterfaceSbbActionGroupAttributes['orientation']` | `'horizontal'` | Indicates the orientation of the components inside the \`\<sbb-action-group>\`. | |
| `buttonSize` | public | `InterfaceButtonAttributes['size'] \| undefined` | `'l'` | Size of the nested sbb-button instances. This will overwrite the size attribute of nested&#xA;sbb-button instances. | |
| `linkSize` | public | `InterfaceLinkAttributes['size'] \| undefined` | `'m'` | Size of the nested sbb-link instances. This will overwrite the size attribute of nested&#xA;sbb-link instances. | |
## Properties

| Name | Attribute | Privacy | Type | Default | Description |
| ---------------- | ---------------- | ------- | ------------------------------------------------------------------ | -------------- | ------------------------------------------------------------------------------------------------------------------- |
| `alignGroup` | `align-group` | public | `InterfaceSbbActionGroupAttributes['alignGroup']` | `'start'` | Set the slotted \`\<sbb-action-group>\` children's alignment. |
| `horizontalFrom` | `horizontal-from` | public | `InterfaceSbbActionGroupAttributes['horizontalFrom'] \| undefined` | `'medium'` | |
| `orientation` | `orientation` | public | `InterfaceSbbActionGroupAttributes['orientation']` | `'horizontal'` | Indicates the orientation of the components inside the \`\<sbb-action-group>\`. |
| `buttonSize` | `button-size` | public | `InterfaceButtonAttributes['size'] \| undefined` | `'l'` | |
| `linkSize` | `link-size` | public | `InterfaceLinkAttributes['size'] \| undefined` | `'m'` | |

## Slots

Expand Down
12 changes: 6 additions & 6 deletions src/components/sbb-alert-group/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,13 @@ and therefore interrupts screen reader flow, to immediately read out the alert c
<!-- Auto Generated Below -->


## Properties
## Properties

| Name | Privacy | Type | Default | Description | Inherited From |
| ------------------------- | ------- | ------------------------------------------ | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
| `role` | public | `InterfaceSbbAlertGroupAttributes['role']` | `'status'` | The role attribute defines how to announce alerts to the user.&#xA;&#xA;'status': sets aria-live to polite and aria-atomic to true.&#xA;'alert': sets aria-live to assertive and aria-atomic to true. | |
| `accessibilityTitle` | public | `string` | | Title for this alert group which is only visible for screen reader users. | |
| `accessibilityTitleLevel` | public | `TitleLevel` | `'2'` | Level of the accessibility title, will be rendered as heading tag (e.g. h2). Defaults to level 2. | |
| Name | Attribute | Privacy | Type | Default | Description |
| ------------------------- | ------------------------- | ------- | ------------------------------------------ | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `role` | `role` | public | `InterfaceSbbAlertGroupAttributes['role']` | `'status'` | The role attribute defines how to announce alerts to the user.&#xA;&#xA;'status': sets aria-live to polite and aria-atomic to true.&#xA;'alert': sets aria-live to assertive and aria-atomic to true. |
| `accessibilityTitle` | `accessibility-title` | public | `string` | | Title for this alert group which is only visible for screen reader users. |
| `accessibilityTitleLevel` | `accessibility-title-level` | public | `TitleLevel` | `'2'` | Level of the accessibility title, will be rendered as heading tag (e.g. h2). Defaults to level 2. |

## Slots

Expand Down
30 changes: 15 additions & 15 deletions src/components/sbb-alert/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,21 +71,21 @@ Avoid slotting block elements (e.g. `<div>`) as this violates semantic rules and
<!-- Auto Generated Below -->


## Properties

| Name | Privacy | Type | Default | Description | Inherited From |
| -------------------- | ------- | --------------------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
| `readonly` | public | `boolean` | `false` | Whether the alert is readonly.&#xA;In readonly mode, there is no dismiss button offered to the user. | |
| `size` | public | `InterfaceAlertAttributes['size']` | `'m'` | You can choose between \`m\` or \`l\` size. | |
| `disableAnimation` | public | `boolean` | `false` | Whether the fade in animation should be disabled. | |
| `iconName` | public | `string \| undefined` | | Name of the icon which will be forward to the nested \`sbb-icon\`.&#xA;Choose the icons from https\://icons.app.sbb.ch.&#xA;Styling is optimized for icons of type HIM-CUS. | |
| `titleContent` | public | `string \| undefined` | | Content of title. | |
| `titleLevel` | public | `TitleLevel` | `'3'` | Level of title, will be rendered as heading tag (e.g. h3). Defaults to level 3. | |
| `linkContent` | public | `string \| undefined` | | Content of the link. | |
| `href` | public | `string \| undefined` | | The href value you want to link to. | |
| `target` | public | `LinkTargetType \| string \| undefined` | | Where to display the linked URL. | |
| `rel` | public | `string \| undefined` | | The relationship of the linked URL as space-separated link types. | |
| `accessibilityLabel` | public | `string \| undefined` | | This will be forwarded as aria-label to the relevant nested element. | |
## Properties

| Name | Attribute | Privacy | Type | Default | Description |
| -------------------- | -------------------- | ------- | --------------------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `readonly` | `readonly` | public | `boolean` | `false` | Whether the alert is readonly.&#xA;In readonly mode, there is no dismiss button offered to the user. |
| `size` | `size` | public | `InterfaceAlertAttributes['size']` | `'m'` | You can choose between \`m\` or \`l\` size. |
| `disableAnimation` | `disable-animation` | public | `boolean` | `false` | Whether the fade in animation should be disabled. |
| `iconName` | `icon-name` | public | `string \| undefined` | | |
| `titleContent` | `title-content` | public | `string \| undefined` | | |
| `titleLevel` | `title-level` | public | `TitleLevel` | `'3'` | Level of title, will be rendered as heading tag (e.g. h3). Defaults to level 3. |
| `linkContent` | `link-content` | public | `string \| undefined` | | |
| `href` | `href` | public | `string \| undefined` | | |
| `target` | `target` | public | `LinkTargetType \| string \| undefined` | Where to display the linked URL. | |
| `rel` | `rel` | public | `string \| undefined` | | |
| `accessibilityLabel` | `accessibility-label` | public | `string \| undefined` | | |

## Methods

Expand Down
Loading

0 comments on commit a98e629

Please sign in to comment.