Skip to content

Commit 850b95a

Browse files
Update docs
1 parent 307282b commit 850b95a

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ Enables external control of the expansion.
138138
139139
Class(es) to apply to the 'heading' element.
140140
141-
#### headingLevel : `number` [*optional*, default: `3`]
141+
#### ariaLevel : `number` [*optional*, default: `3`]
142142
143143
Will determine which 'heading' element is used in the markup. A value of `1`
144144
would make your element an `<h1>` tag, and likewise a value of `6` would make it
@@ -188,7 +188,8 @@ you, including:
188188
189189
- Applying appropriate aria attributes (`aria-expanded`, `aria-controls`,
190190
`aria-disabled`, `aria-hidden` and `aria-labelledby`).
191-
- Applying appropriate `role` attributes (`button`, `heading`, `region`).
191+
- Applying appropriate `role` attributes (`region`).
192+
- Using semantic HTML elements (`h1` - `h6`, `button`).
192193
- Applying appropriate `tabindex` attributes.
193194
- Applying keyboard interactivity ('space', 'end', 'tab', 'up', 'down', 'home'
194195
and 'end' keys).
@@ -199,10 +200,10 @@ spec-compliant:
199200
- Only ever use
200201
[phrasing content](https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/Content_categories#Phrasing_content)
201202
inside of your `AccordionItemHeading` component. If in doubt, use text only.
202-
- Always provide an `aria-level` prop to your `AccordionItemHeading`
203-
component, _especially_ if you are nesting accordions. This attribute is a
204-
signal used by assistive technologies (eg. screenreaders) to determine which
205-
heading level (ie. `h1`-`h6`) to treat your heading as.
203+
- Remember to provide an `ariaLevel` prop to your `AccordionItemHeading`
204+
component, when you are nesting accordions. The levels are used by assistive
205+
technologies (eg. screenreaders) to infer structure, by default each heading
206+
uses `h3` .
206207
207208
If you have any questions about your implementation, then please don't be afraid
208209
to get in touch via our

0 commit comments

Comments
 (0)