Skip to content

Commit

Permalink
#8 documenting Prev/Next button changes in README
Browse files Browse the repository at this point in the history
  • Loading branch information
jasonwebb committed Aug 17, 2020
1 parent ea64d24 commit 60fc471
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,13 @@ In the short term, we're releasing our take on an accessible Slick Slider implem

Feature | Why
--------|----
Wrapper now has `role="region"` and a configurable `aria-label` | Tells screen reader users exactly where the carousel begins and ends in the DOM and gives them a landmark they can jump to or skip easily. Use the [`regionLabel` setting](#new-settings) to change the `aria-label` text (defaults to `'carousel'`).
[Wrapper](https://github.com/Accessible360/accessible-slick/issues/7) now has `role="region"` and a configurable `aria-label` | Tells screen reader users exactly where the carousel begins and ends in the DOM and gives them a landmark they can jump to or skip easily. Use the [`regionLabel` setting](#new-settings) to change the `aria-label` text (defaults to `'carousel'`).

### Feature changes ⚠️

`TODO: list out changes made to original package with reasoning.`
Feature | Why
--------|----
[Previous and Next button markup](https://github.com/Accessible360/accessible-slick/issues/8) improved to no longer use `aria-label`, and to safely hide the icons from screen readers | See the [First Rule of ARIA Use](https://www.w3.org/TR/using-aria/#rule1). Also, custom font icons are read out as "unrecognizable characters" by screen readers, so they need to be hidden from them.

### Deprecated features ❌

Expand Down

0 comments on commit 60fc471

Please sign in to comment.