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

docs(brand): add a11y documentation #2778

Merged
merged 1 commit into from
Jan 18, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions packages/v4/src/content/accessibility/brand/brand.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
id: Brand
section: components
---

A **brand** is used to place a product logotype on a screen.

**Keyboard users** should not be able to focus on the brand, as it is not interactive.

**Screen reader users** should be able to navigate to the brand and have a screen reader read the brand’s descriptive text.

The following props/attributes have been added for you or are customizable in PatternFly:

| React prop | React component it should be applied to | Which HTML element it appears on in markup | Reason used |
| -- | -- | -- | -- |
| alt | Brand | `.pf-c-brand` | Descriptive alternative text for the image of the Brand |