Skip to content

Commit

Permalink
Merge pull request #3 from Yoast/stories/af/clarify-polite-assertive-…
Browse files Browse the repository at this point in the history
…usage

Clarify usage of polite and assertive messages.
  • Loading branch information
atimmer authored Jul 12, 2016
2 parents 8054038 + c1a38a7 commit af67572
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,9 @@ To make the `wp.a11y.speak` functionality more universally available, we've deci
```JS
var A11ySpeak = require("A11ySpeak");

A11ySpeak( "The message you want to send to the ARIA live region", "polite" );
// For polite messages that shouldn't interrupt what screen readers are currently announcing.
AllySpeak( "The message you want to send to the ARIA live region" );

// For assertive messages that should interrupt what screen readers are currently announcing.
AllySpeak( "The message you want to send to the ARIA live region", "assertive" );
```

0 comments on commit af67572

Please sign in to comment.