Skip to content

Commit

Permalink
docs(button-elements): add a11y docs for disabled elements
Browse files Browse the repository at this point in the history
  • Loading branch information
TomMenga committed Sep 2, 2024
1 parent 134e06e commit aebbfdf
Show file tree
Hide file tree
Showing 10 changed files with 66 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/elements/button/button/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,12 @@ sbb-button {

Use the accessibility properties in case of an icon-only button to describe the purpose of the `sbb-button` for screen-reader users.

### Disabled buttons

Generally speaking, `disabled` elements are considered a bad pattern for a11y. They are invisible to assistive technology and do not provide the reason for which they are disabled.
To partially address the problem, disabled elements are kept focusable (other interactions are still prevented).
Still, the consumer's responsible for providing the reason for a disabled element.

<!-- Auto Generated Below -->

## Properties
Expand Down
6 changes: 6 additions & 0 deletions src/elements/button/mini-button/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,12 @@ sbb-mini-button {

Use the accessibility properties to describe the purpose of the `sbb-mini-button` for screen-reader users.

### Disabled buttons

Generally speaking, `disabled` elements are considered a bad pattern for a11y. They are invisible to assistive technology and do not provide the reason for which they are disabled.
To partially address the problem, disabled elements are kept focusable (other interactions are still prevented).
Still, the consumer's responsible for providing the reason for a disabled element.

<!-- Auto Generated Below -->

## Properties
Expand Down
6 changes: 6 additions & 0 deletions src/elements/button/secondary-button/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,12 @@ sbb-secondary-button {

Use the accessibility properties in case of an icon-only button to describe the purpose of the `sbb-secondary-button` for screen-reader users.

### Disabled buttons

Generally speaking, `disabled` elements are considered a bad pattern for a11y. They are invisible to assistive technology and do not provide the reason for which they are disabled.
To partially address the problem, disabled elements are kept focusable (other interactions are still prevented).
Still, the consumer's responsible for providing the reason for a disabled element.

<!-- Auto Generated Below -->

## Properties
Expand Down
6 changes: 6 additions & 0 deletions src/elements/button/tertiary-button/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,12 @@ sbb-tertiary-button {

Use the accessibility properties in case of an icon-only button to describe the purpose of the `sbb-tertiary-button` for screen-reader users.

### Disabled buttons

Generally speaking, `disabled` elements are considered a bad pattern for a11y. They are invisible to assistive technology and do not provide the reason for which they are disabled.
To partially address the problem, disabled elements are kept focusable (other interactions are still prevented).
Still, the consumer's responsible for providing the reason for a disabled element.

<!-- Auto Generated Below -->

## Properties
Expand Down
6 changes: 6 additions & 0 deletions src/elements/button/transparent-button/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,12 @@ sbb-transparent-button {

Use the accessibility properties in case of an icon-only button to describe the purpose of the `sbb-transparent-button` for screen-reader users.

### Disabled buttons

Generally speaking, `disabled` elements are considered a bad pattern for a11y. They are invisible to assistive technology and do not provide the reason for which they are disabled.
To partially address the problem, disabled elements are kept focusable (other interactions are still prevented).
Still, the consumer's responsible for providing the reason for a disabled element.

<!-- Auto Generated Below -->

## Properties
Expand Down
6 changes: 6 additions & 0 deletions src/elements/expansion-panel/expansion-panel/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,12 @@ and the header's `id` is set as `aria-labelledby` attribute on the content.
The `expanded` attribute is used to correctly set the `aria-expanded` attribute on the header
and the `aria-hidden` attribute on the content.

### Disabled elements

Generally speaking, `disabled` elements are considered a bad pattern for a11y. They are invisible to assistive technology and do not provide the reason for which they are disabled.
To partially address the problem, disabled elements are kept focusable (other interactions are still prevented).
Still, the consumer's responsible for providing the reason for a disabled element.

<!-- Auto Generated Below -->

## Properties
Expand Down
8 changes: 8 additions & 0 deletions src/elements/link/block-link-button/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,14 @@ The component has three sizes (`xs`, `s`, which is the default, and `m`).
<sbb-block-link-button size="m">Refunds</sbb-block-link-button>
```

## Accessibility

### Disabled buttons

Generally speaking, `disabled` elements are considered a bad pattern for a11y. They are invisible to assistive technology and do not provide the reason for which they are disabled.
To partially address the problem, disabled elements are kept focusable (other interactions are still prevented).
Still, the consumer's responsible for providing the reason for a disabled element.

<!-- Auto Generated Below -->

## Properties
Expand Down
8 changes: 8 additions & 0 deletions src/elements/link/link-button/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,14 @@ accepting its associated properties (`type`, `name`, `value` and `form`).
</sbb-link-button>
```

## Accessibility

### Disabled buttons

Generally speaking, `disabled` elements are considered a bad pattern for a11y. They are invisible to assistive technology and do not provide the reason for which they are disabled.
To partially address the problem, disabled elements are kept focusable (other interactions are still prevented).
Still, the consumer's responsible for providing the reason for a disabled element.

<!-- Auto Generated Below -->

## Properties
Expand Down
8 changes: 8 additions & 0 deletions src/elements/menu/menu-button/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,14 @@ accepting its associated properties (`type`, `name`, `value` and `form`).
<sbb-menu-button value="menu" name="menu">Button</sbb-menu-button>
```

## Accessibility

### Disabled buttons

Generally speaking, `disabled` elements are considered a bad pattern for a11y. They are invisible to assistive technology and do not provide the reason for which they are disabled.
To partially address the problem, disabled elements are kept focusable (other interactions are still prevented).
Still, the consumer's responsible for providing the reason for a disabled element.

<!-- Auto Generated Below -->

## Properties
Expand Down
6 changes: 6 additions & 0 deletions src/elements/tag/tag/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,12 @@ It's recommended to check the parent's `sbb-tag-group` for the value.
The component imitates an `button` element to provide an accessible experience.
The state is reflected via `aria-pressed` attribute.

### Disabled elements

Generally speaking, `disabled` elements are considered a bad pattern for a11y. They are invisible to assistive technology and do not provide the reason for which they are disabled.
To partially address the problem, disabled elements are kept focusable (other interactions are still prevented).
Still, the consumer's responsible for providing the reason for a disabled element.

<!-- Auto Generated Below -->

## Properties
Expand Down

0 comments on commit aebbfdf

Please sign in to comment.