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 24, 2023
1 parent ea21e35 commit e407e64
Show file tree
Hide file tree
Showing 93 changed files with 1,124 additions and 2,944 deletions.
25 changes: 10 additions & 15 deletions src/components/sbb-accordion/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,25 +41,20 @@ In the following example, all the `sbb-expansion-panel-header` would be wrapped
</sbb-accordion>
```

<!-- Auto Generated Below -->

<!-- Auto Generated Below -->

## Properties

| Property | Attribute | Description | Type | Default |
| ------------------ | ------------------- | --------------------------------------------------------------------------- | ---------------------------------------- | ----------- |
| `disableAnimation` | `disable-animation` | Whether the animation should be disabled. | `boolean` | `false` |
| `multi` | `multi` | Whether more than one sbb-expansion-panel can be open at the same time. | `boolean` | `false` |
| `titleLevel` | `title-level` | The heading level for the sbb-expansion-panel-headers within the component. | `"1" \| "2" \| "3" \| "4" \| "5" \| "6"` | `undefined` |

| 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. | |

## Slots

| Slot | Description |
| ----------- | ------------------------------------------------ |
| `"unnamed"` | Use this to add one or more sbb-expansion-panel. |


----------------------------------------------

| Name | Description |
| --------- | ------------------------------------------------ |
| `unnamed` | Use this to add one or more sbb-expansion-panel. |

33 changes: 17 additions & 16 deletions src/components/sbb-action-group/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,27 +113,28 @@ The values for `align-group` and `align-self` for the various allocations are as
| 0-0-3 | stretch | Link: 'end' |
| 0-0-2 | stretch | / |

<!-- Auto Generated Below -->

<!-- Auto Generated Below -->

## Properties

| Property | Attribute | Description | Type | Default |
| ---------------- | ----------------- | --------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------- |
| `alignGroup` | `align-group` | Set the slotted `<sbb-action-group>` children's alignment. | `"center" \| "end" \| "start" \| "stretch"` | `'start'` |
| `buttonSize` | `button-size` | Size of the nested sbb-button instances. This will overwrite the size attribute of nested sbb-button instances. | `"l" \| "m"` | `'l'` |
| `horizontalFrom` | `horizontal-from` | Overrides the behaviour of `orientation` property. | `"large" \| "medium" \| "micro" \| "small" \| "ultra" \| "wide" \| "zero"` | `'medium'` |
| `linkSize` | `link-size` | Size of the nested sbb-link instances. This will overwrite the size attribute of nested sbb-link instances. | `"m" \| "s" \| "xs"` | `'m'` |
| `orientation` | `orientation` | Indicates the orientation of the components inside the `<sbb-action-group>`. | `"horizontal" \| "vertical"` | `'horizontal'` |

| 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. | |

## Slots
## Methods

| Slot | Description |
| ----------- | ------------------------------------------------ |
| `"unnamed"` | Slot to render the content inside the container. |
| Name | Privacy | Description | Parameters | Return | Inherited From |
| ------------ | ------- | ----------- | ----------------------------------------- | ------ | -------------- |
| `willUpdate` | public | | `changedProperties: PropertyValues<this>` | `void` | |

## Slots

----------------------------------------------

| Name | Description |
| --------- | ------------------------------------------------ |
| `unnamed` | Slot to render the content inside the container. |

35 changes: 11 additions & 24 deletions src/components/sbb-alert-group/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,34 +39,21 @@ and therefore interrupts screen reader flow, to immediately read out the alert c

**Note that with role `alert`, in some combinations of screen readers and browsers not every part of the alert is fully read.**

<!-- Auto Generated Below -->

<!-- Auto Generated Below -->

## Properties

| Property | Attribute | Description | Type | Default |
| ------------------------- | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | ----------- |
| `accessibilityTitle` | `accessibility-title` | Title for this alert group which is only visible for screen reader users. | `string` | `undefined` |
| `accessibilityTitleLevel` | `accessibility-title-level` | Level of the accessibility title, will be rendered as heading tag (e.g. h2). Defaults to level 2. | `"1" \| "2" \| "3" \| "4" \| "5" \| "6"` | `'2'` |
| `role` | `role` | The role attribute defines how to announce alerts to the user. 'status': sets aria-live to polite and aria-atomic to true. 'alert': sets aria-live to assertive and aria-atomic to true. | `string` | `'status'` |


## Events

| Event | Description | Type |
| ------------------- | ------------------------------------------- | ---------------------------------- |
| `did-dismiss-alert` | Emits when an alert was removed from DOM. | `CustomEvent<HTMLSbbAlertElement>` |
| `empty` | Emits when `sbb-alert-group` becomes empty. | `CustomEvent<void>` |

| 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. | |

## Slots

| Slot | Description |
| ----------------------- | ----------------------------------------------------------------------------- |
| `"accessibility-title"` | title for this sbb-alert-group which is only visible for screen reader users. |
| `"unnamed"` | content slot, should be filled with `sbb-alert` items. |


----------------------------------------------

| Name | Description |
| --------------------- | ----------------------------------------------------------------------------- |
| `unnamed` | content slot, should be filled with \`sbb-alert\` items. |
| `accessibility-title` | title for this sbb-alert-group which is only visible for screen reader users. |

Loading

0 comments on commit e407e64

Please sign in to comment.