Skip to content

Commit

Permalink
Adding documentation for ariaLabelledBy option.
Browse files Browse the repository at this point in the history
  • Loading branch information
jrparish committed Sep 6, 2017
1 parent 0491c43 commit bfc207a
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -316,6 +316,8 @@ When initializing an autocomplete, there are a number of options you can configu
* `keyboardShortcuts` - Array of shortcut that will focus the input. For example if you want to bind `s` and `/`
you can specify: `keyboardShortcuts: ['s', '/']`

* `ariaLabelledBy` - An optional id to use for the `aria-labelledby` attribute. Specify `false` to exclude the attribute. Defaults to using the `placeholder` as the label if a `placeholder` is specified.

```html
<script type="text/template" id="my-custom-menu-template">
<div class="my-custom-menu">
Expand Down Expand Up @@ -774,7 +776,7 @@ Autocomplete.js is accessible to screen readers, and here's how to test how most
1. Type a search query
1. Use the arrow keys to navigate through the results
✔ SUCCESS: results are read (not necessarily in sync with the visually selected cursor)
✔ SUCCESS: results are read (not necessarily in sync with the visually selected cursor)
𐄂 FAIL: no text is read or the screen reader keeps reading the typed query
#### Recommended testing platforms
Expand Down

0 comments on commit bfc207a

Please sign in to comment.