Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Condition builder: Draft Accessibility docs #5044

Open
3 tasks
Tracked by #3776
elycheea opened this issue May 1, 2024 · 0 comments
Open
3 tasks
Tracked by #3776

Condition builder: Draft Accessibility docs #5044

elycheea opened this issue May 1, 2024 · 0 comments
Labels
role: design type: a11y ♿ Issues not following accessibility standards

Comments

@elycheea
Copy link
Contributor

elycheea commented May 1, 2024

Draft the Accessibility docs for Condition builder

Figma file here

Write a rough draft of the Accessibility docs for Condition builder covering keyboard interactions (tab stops and selecting from the dropdown menus)
Can work with @mbgower and Jess Lin as needed.

Sections to cover:

  • Page description
  • What Carbon Provides
  • Keyboard interactions

Reference

Accessibility docs

Carbon components examples

Page contents:

PageDescription

There are 2 stock page descriptions.
Choose the first example if designers need to include annotations in their wireframes to make the component accessible. Choose the second if the component is accessible without additional design decisions.
** If example 2 is used, the Design recommendations section and its anchor link should be removed.

Example 1:
Design annotations are needed for specific instances shown below, but for the
standard [component_name] component, Carbon already incorporates accessibility.

Example 2:
No accessibility annotations are needed for [component_name]s, but keep these considerations in
mind if you are modifying Carbon or creating a custom component.

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 interaction

This keyboard section introduction text can give details of keyboard operation. For actionable components, begin by talking about the navigation via the tab stop, then discuss common interactions keys. For components with subcomponents, unless there is little interaction for the subcomponent, consider splitting the subcomponent considerations into a separate paragraph, separated by an illustration. Where operation is more complicated, separate headings for Keyboard navigation and Keyboard interaction can exist.Keyboard keys should be referred to with code styling.

Example 1:

Each accordion is a tab stop. Space or Enter keys expand or collapse
accordions, which are collapsed by default. Interactive elements within expanded
accordions integrate into the tab order automatically.

Example 2:
Each page link in the breadcrumb is reached by Tab and activated by Enter. The current
page, if listed in the breadcrumb, is not a link. If the breadcrumb is truncated, the ellipsis button
for the overflow menu is in the tab order. See overflow menu for details on its keyboard operation

Images
Use one image to document keyboard navigation. If the component has limited operation functionality, it may also be incorporated in the same image. Otherwise, the operation should be dealt with in a separate image.
Normally these images go across 8 columns.
images should follow the naming convention (component_name-accessibility-1.png
The ALT text text for the first image can be fairly generic, since the image is just restating information in the prior paragraph.
The caption should likewise summarize something already described in the preceding paragraph. No new information should be given in the caption. Due to technology constraints, keystroke names in the captions are not given any markdown styling.
Example:
example of breadcrumb keyboard interaction

The breadcrumb's links are reached by Tab and activated by Enter.

example of (componet_name) keyboard interaction

The (component_name) is reached by Tab and activated by Enter.

The Design recommendations section should only be included if annotations are needed

Design recommendations

Design annotations are needed for the following instances.

Some of the possible subheadings here include:

  • headings
  • alignment
  • labeling
  • meaningful order

Each should have a level 3 heading, a descriptive paragraph and a supporting image.

Example:

Headings

Carbon accordions are not set as headings by default. For improved accessibility, annotate accordions as headings on the first occurrence in a product. Annotate the heading level of accordions as needed.

@github-project-automation github-project-automation bot moved this to Needs triage 🧐 in Carbon for IBM Products May 1, 2024
@sstrubberg sstrubberg moved this from Needs triage 🧐 to Backlog 🌋 in Carbon for IBM Products May 8, 2024
@sstrubberg sstrubberg added this to the 2024 Q2 milestone May 8, 2024
@sstrubberg sstrubberg added the type: a11y ♿ Issues not following accessibility standards label May 8, 2024
@oliviaflory oliviaflory moved this from Backlog 🌋 to In progress in Carbon for IBM Products Jun 5, 2024
@ljcarot ljcarot modified the milestones: 2024 Q2, 2024 Q3 Jul 17, 2024
@oliviaflory oliviaflory moved this from In progress to Backlog 🌋 in Carbon for IBM Products Jul 17, 2024
@ljcarot ljcarot moved this from Backlog 🌋 to In progress in Carbon for IBM Products Aug 2, 2024
@ljcarot ljcarot moved this from In progress to Backlog 🌋 in Carbon for IBM Products Sep 19, 2024
@ljcarot ljcarot removed this from the 2024 Q3 milestone Sep 19, 2024
@ljcarot ljcarot moved this from Backlog 🌋 to Icebox 🧊 in Carbon for IBM Products Oct 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
role: design type: a11y ♿ Issues not following accessibility standards
Projects
Status: Icebox 🧊
Development

No branches or pull requests

5 participants