Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add aria-labelsynonyms #1794

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from
40 changes: 40 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -12003,6 +12003,45 @@ <h2>Definitions of States and Properties (all aria-* attributes)</h2>
</tbody>
</table>
</div>
<div class="property" id="aria-labelsynonyms">
<pdef>aria-labelsynonyms</pdef>
<div class="property-description">
<p><a>Defines</a> an optional <a data-cite="HTML/common-microsyntaxes.html#comma-separated-tokens">set of comma separated tokens</a> that provides alternate activation labels for the the current element. See related <pref>aria-label</pref> and <pref>aria-labelledby</pref>.</p>
<p>The purpose of <pref>aria-labelsynonyms</pref> is to allow a user of assistive technology such as voice activation software to activate controls using any one of several possible names. Other uses may include "type-ahead" function in a keyboard access utility or search function. For example, a button that closes a dialog may be labeled "close" for a screen reader, but sighted user of voice activation may say "tap x" or "tap dismiss."</p>
cookiecrook marked this conversation as resolved.
Show resolved Hide resolved
<pre class="example highlight">
&lt;button aria-label="close" <strong>aria-labelsynonyms="dismiss, clear, close, x"</strong>&gt;❎&lt;/button&gt;
cookiecrook marked this conversation as resolved.
Show resolved Hide resolved
</pre>
<p>Authors MUST NOT specify <code>aria-labelsynonyms</code> on an element with a role that does not support <a href="#namefromauthor">nameFrom: author</a>.</p>
<p>Authors MUST NOT specify <code>aria-labelsynonyms</code> on an element that is contained in a presentational subtree as defined by the <a href="#childrenArePresentational">Presentational Children</a> characteristic.</p>
</div>
<table class="property-features">
<caption>Characteristics:</caption>
<thead>
<tr>
<th scope="col">Characteristic</th>
<th scope="col">Value</th>
</tr>
</thead>
<tbody>
<tr>
<th class="property-related-head" scope="row">Related Concepts:</th>
<td class="property-related"><a href="https://developer.apple.com/documentation/objectivec/nsobject/3197989-accessibilityuserinputlabels">accessibilityUserInputLabels</a></td>
cookiecrook marked this conversation as resolved.
Show resolved Hide resolved
</tr>
<tr>
<th class="property-applicability-head" scope="row">Used in Roles:</th>
<td class="property-applicability">All elements of the base markup except for some roles or elements that prohibit its use</td>
</tr>
<tr>
<th class="property-descendants-head" scope="row">Inherits into Roles:</th>
<td class="property-descendants">Placeholder</td>
</tr>
<tr>
<th class="property-value-head" scope="row">Value:</th>
<td class="property-value"><a href="#valuetype_string">string</a></td>
</tr>
</tbody>
</table>
</div>
<div class="property" id="aria-level">
<pdef>aria-level</pdef>
<div class="property-description">
Expand Down Expand Up @@ -13640,6 +13679,7 @@ <h2>Interface Mixin <dfn>ARIAMixin</dfn></h2>
[CEReactions] attribute DOMString? ariaKeyShortcuts;
[CEReactions] attribute DOMString? ariaLabel;
[CEReactions] attribute FrozenArray&lt;Element&gt;? ariaLabelledByElements;
[CEReactions] attribute DOMString? ariaLabelSynonyms;
[CEReactions] attribute DOMString? ariaLevel;
[CEReactions] attribute DOMString? ariaLive;
[CEReactions] attribute DOMString? ariaModal;
Expand Down