Skip to content

Commit

Permalink
Add note on Timeline.Break (#850)
Browse files Browse the repository at this point in the history
* Add note on timeline break

* Wording update
  • Loading branch information
TylerJDev committed Aug 29, 2024
1 parent 94dcb19 commit 3ab7a78
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions content/components/timeline.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,12 @@ Timeline displays items on a connected vertical timeline. It's primarily used to

## Accessibility

### Timeline breaks

The `Timeline.Break` component allows for content in `Timeline` to be visually seperated. This should be used for decorative purposes only. Since this component is decorative, it is not conveyed to assistive technologies like screen readers.

The content within `Timeline.Item` should clearly communicate the status and state of that item, so that if there is a need to seperate content, the context of the seperation is communicated in `Timeline.Item`.

### Known accessibility issues (GitHub staff only)

<AccessibilityLink label="Timeline"/>

0 comments on commit 3ab7a78

Please sign in to comment.