Skip to content
Closed
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
9 changes: 9 additions & 0 deletions packages/components/pie-icon-with-background/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
- [CSS Variables](#css-variables)
- [CSS Parts](#css-parts)
- [Events](#events)
- [Accessibility](#accessibility)
- [Usage Examples](#usage-examples)
- [Questions and Support](#questions-and-support)
- [Contributing](#contributing)
Expand Down Expand Up @@ -57,6 +58,14 @@ This component does not expose any CSS variables for style overrides.

This component does not emit any custom events. In order to add event listening to this component, you can treat it like a native HTML element in your application.

### Accessibility

This component is decorative and non-interactive, and it intentionally applies no ARIA attributes of its own.

PIE icons already render with `role="presentation"` and `focusable="false"`, so an icon passed into the default slot is not announced by screen readers without any further work. Adding `aria-hidden` to the container would therefore be redundant.

If the icon conveys meaning on its own rather than being purely decorative, labelling it is the consumer's responsibility. Provide an accessible name on the surrounding interactive element, or on the slotted content, rather than expecting this component to supply one.

## Usage Examples

**For HTML:**
Expand Down
Loading