Skip to content

Commit

Permalink
Update contained list accessibility.mdx (#3685)
Browse files Browse the repository at this point in the history
* Update accessibility.mdx

First draft of new accessibility content (without images)

* Update accessibility.mdx

* Update accessibility.mdx

some slight editorial updates

* Update accessibility.mdx

Updated the info for the design annotation image set

* First images

* Update accessibility.mdx

Removing the filter functionality information for now, until Carbon addresses issues

* update image and caption

* Update accessibility.mdx

Remove page under development notice

* Replaced images

Used Lauren's version

* Update src/pages/components/contained-list/accessibility.mdx

Co-authored-by: Lauren Rice <43969356+laurenmrice@users.noreply.github.com>

---------

Co-authored-by: Alison Joseph <alison.joseph@us.ibm.com>
Co-authored-by: Lauren Rice <43969356+laurenmrice@users.noreply.github.com>
  • Loading branch information
3 people authored Aug 28, 2023
1 parent 6326df5 commit 9702ec4
Show file tree
Hide file tree
Showing 5 changed files with 90 additions and 7 deletions.
97 changes: 90 additions & 7 deletions src/pages/components/contained-list/accessibility.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,101 @@ tabs: ['Usage', 'Style', 'Code', 'Accessibility']
<PageDescription>

Design annotations are needed for specific instances shown below, but for the
standard accordion component, Carbon already incorporates accessibility.
standard contained list component, Carbon already incorporates accessibility.

</PageDescription>

<InlineNotification>

This page is underdevelopment. Please check back later for updates.

</InlineNotification>

<AnchorLinks>
<AnchorLink>What Carbon provides</AnchorLink>
<AnchorLink>Design recommendations</AnchorLink>
<AnchorLink>Development considerations</AnchorLink>
</AnchorLinks>

## What Carbon provides

Carbon bakes keyboard operation into its components, improving the experience of
blind users and others who operate via the keyboard. Carbon incorporates many
other accessibility considerations, some of which are described below.

### Keyboard interactions

The default contained list is not interactive, but several of its variants
include keyboard operation. In all interactive variants, the `Tab` key is used
for navigation and both `Space` and `Enter` are used to activate components.

Users tab between any actionable items in the list, regardless of whether each
item is clickable or contains an action button (such as ‘delete’). It is
possible for multiple tab stops to exist for each list item.

<Row>
<Column colLg={8}>

![The user tabs to each row of a clickable contained list.](images/contained-list-accessibility-1.png)

<Caption>
In a clickable contained list, each list item is a tab stop, activated with
Enter or Space.
</Caption>

</Column>
</Row>

<Row>
<Column colLg={8}>

![The user tabs to each row of a clickable contained list.](images/contained-list-accessibility-2.png)

<Caption>
Where a contained list has buttons on each row, the buttons are in the tab
order.
</Caption>

</Column>
</Row>

<Row>
<Column colLg={8}>

![The user tabs to the first row of a clickable contained list, and then tabs to an actionable item at the end of the same row.](images/contained-list-accessibility-3.png)

<Caption>
If a contained list contains both clickable rows and action items, there are
multiple tab stops on each row.
</Caption>

</Column>
</Row>

## Design recommendations

### Indicate when the contained list is clickable

There is no persistent visual indicator that the list items in a contained list
are clickable. To help developers distinguish them from the default contained
list in your designs, annotate if each row in a list is intended to be
clickable. There is no need to annotate clickable buttons on each row since
these are visually identifiable.

<Row>
<Column colLg={8}>

![Two contained lists, the first with a pink annotation reading "clickable rows", the second showing a button on each row, with no annotation](images/contained-list-accessibility-5.png)

<Caption>
Annotate if the rows of a contained list are clickable. Do not annotate if it
is only buttons on each row that are actionable.
</Caption>

</Column>
</Row>

## Development considerations

Keep these considerations in mind if you are modifying Carbon or creating a
custom component.

- The contained list is implemented as a list (usually a `<ul>`) with each item
an `<li>`, and the list title associated with the list through use of
`aria-labelledby`.
- Any operable variant, whether a clickable list or a list with action items, is
a `<button>` implemented as a child of the `<li>`.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

1 comment on commit 9702ec4

@vercel
Copy link

@vercel vercel bot commented on 9702ec4 Aug 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.