Skip to content

Get Accessibility Properties #1960

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.

Sign up for GitHub

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

Open
spectranaut wants to merge 6 commits into
base: master
Choose a base branch
from
+123 −0
Open

Get Accessibility Properties #1960

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
82d7844
Get Accessibility Properties
spectranaut May 12, 2026
71d6ead
Accessible object to accessibility node and other fixes
spectranaut May 13, 2026
1c104df
Apply suggestions from code review
spectranaut Jun 3, 2026
f02fdbd
Update based on convos
spectranaut Jun 3, 2026
174fccf
Apply suggestion from @jcsteh
spectranaut Jun 4, 2026
55e15b3
Update route name
spectranaut Jun 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
132 changes: 132 additions & 0 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1040,6 +1040,19 @@ <h3>Endpoints</h3>
<td>/session/{<var>session id</var>}/print</td>
<td><a>Print Page</a></td>
</tr>

<tr>
<td>GET</td>
<td>/session/{<var>session id</var>}/element/{<var>element id</var>}/accessibilityproperties</td>
<td><a>Get Accessibility Properties</a></td>
Comment thread
spectranaut marked this conversation as resolved.
Outdated
</tr>

<tr>
<td>GET</td>
<td>/session/{<var>session id</var>}/accessibility/properties/{<var>accessibility id</var>}</td>
<td><a>Get Accessibility Properties For Accessible Object</a></td>
</tr>

</table>
</section> <!-- /Endpoints -->

Expand Down Expand Up @@ -1193,6 +1206,14 @@ <h3>Errors</h3>
and cannot be brought into that viewport.
</tr>

<tr>
<td><dfn>no such accessible</dfn>
<td>404
<td><code>no such accessible</code>
Comment thread
spectranaut marked this conversation as resolved.
Outdated
<td>An accessibility node could not be located on the page
using the given search parameters.
</tr>

<tr>
<td><dfn>no such alert</dfn>
<td>404
Expand Down Expand Up @@ -1255,6 +1276,14 @@ <h3>Errors</h3>
<td>A new <a>session</a> could not be created.
</tr>

<tr>
<td><dfn>stale accessible reference</dfn>
<td>404
<td><code>stale accessible reference</code>
Comment thread
spectranaut marked this conversation as resolved.
Outdated
<td>A <a>command</a> failed because
the referenced <a>accessible</a> is no available.
</tr>

<tr>
<td><dfn>stale element reference</dfn>
<td>404
Expand Down Expand Up @@ -6028,6 +6057,43 @@ <h4><dfn>Get Computed Label</dfn></h4>
<li><p>Return <a>success</a> with data <var>label</var>.
</ol>
</section> <!-- /Get Element Computed Label -->

<section>
<h4><dfn>Get Accessibility Properties</dfn></h4>

<table class="simple jsoncommand">
<tr>
<th>HTTP Method</th>
<th>URI Template</th>
</tr>
<tr>
<td>GET</td>
<td>/session/{<var>session id</var>}/element/{<var>element id</var>}/accessibilityproperties</td>
</tr>
</table>

<p>The <a>remote end steps</a>, given <var>session</var>, <var>URL
variables</var> and <var>parameters</var> are:

<ol>
<li><p>If <var>session</var>&apos;s <a>current browsing context</a> is <a>no longer open</a>,
return <a>error</a> with <a>error code</a> <a>no such window</a>.

<li><p><a>Try</a> to <a>handle any user prompts</a>
with <var>session</var>.

<li><p>Let <var>element</var> be the result
of <a>trying</a> to <a>get a known element</a>
with <var>URL variables</var>["<code>element id</code>"].

<li><p>Let <var>accessible</var> be the <a>accessible object</a> that corrosponds to this element in the <a>accessibility tree</a>.

<li><p>Let <var>properties</var> be the result of computing the <a>accessibility properties</a> of <var>accessible</var>.


<li><p>Return <a>success</a> with data <var>properties</var>.
</ol>
</section> <!-- /Get Element Accessibility Properties -->
</section> <!-- /State -->

<section>
Expand Down Expand Up @@ -11116,6 +11182,68 @@ <h3><dfn>Take Element Screenshot</dfn></h3>
</section> <!-- /Take Element Screenshot -->
</section> <!-- /Screen capture -->

<section>
<h2>Accessibility</h2>

<p> An <dfn>accessibility ID</dfn> is a string value representing a handle to an <a>accessible object</a> in a specific WebDriver session.

<p> <dfn>Accessibility properties</dfn> is a JSON <a>Object</a> that contains the relevant <a>WAI-ARIA states and properties</a> of an <a>accessible object</a>, as well as the following properties:
Comment thread
spectranaut marked this conversation as resolved.
Outdated

<dl>
<dt>"<code>accessibilityId</code>"
<dd>The <a>accessibility ID</a> of this <a>accessible object</a>.
Comment thread
spectranaut marked this conversation as resolved.
Outdated

<dt>"<code>parent</code>"
<dd>The <a>accessibility ID</a> of the parent of this <a>accessible object</a> in the <a>accessibility tree</a>, including <a>ignored accessible objects</a>.

<dt>"<code>children</code>"
<dd>A list of <a>accessibility IDs</a> representing the children of this <a>accessible object</a> in the <a>accessibility tree</a>, including <a>ignored accessible objects</a>.
Comment thread
spectranaut marked this conversation as resolved.
Outdated
</dl>

<p> <dfn>Ignored accessible objects</dfn> are accessible objects that represent <a>elements which are excluded from the accessibility tree</a>. The <a>accessibility properties</a> of these <a>accessible objects</a> must only have the keys <va>accessibilityID</var>, <va>parent</var>, <va>children</var> and <va>role</var> set to <code>"none"</code>.
Comment thread
spectranaut marked this conversation as resolved.
Outdated

<p>To <dfn>get a known accessible object</dfn> given <var>session</var> and <var>reference</var>:

<ol class="algorithm">
<li><p>TO DO: Should we create a parallel to the specification of <a>get a known element</a>? Do we need to make a parallel structure to <a>browsing context group node map</a> and <a>node id map</a>?
Comment thread
spectranaut marked this conversation as resolved.
Outdated
</ol>

<section>
<h3><dfn>Get Accessibility Properties for Accessible Object</dfn></h3>
Comment thread
spectranaut marked this conversation as resolved.
Outdated

<table class="simple jsoncommand">
<tr>
<th>HTTP Method</th>
<th>URI Template</th>
</tr>
<tr>
<td>GET</td>
<td>/session/{<var>session id</var>}/accessibiltiy/properties/{<var>accessibility id</var>}/</td>
</tr>
</table>

<p>The <a>remote end steps</a>, given <var>session</var>, <var>URL
variables</var> and <var>parameters</var> are:

<ol>
<li><p>If <var>session</var>&apos;s <a>current browsing context</a> is <a>no longer open</a>,
return <a>error</a> with <a>error code</a> <a>no such window</a>.

<li><p><a>Try</a> to <a>handle any user prompts</a>
with <var>session</var>.

<li><p>Let <var>node</var> be the result
of <a>trying</a> to <a>get a known accessible object</a>
with <var>URL variables</var>["<code>accessibility id</code>"].

<li><p>Let <var>properties</var> be the result of computing the <a>accessibility properties</a> of <var>node</var>.

<li><p>Return <a>success</a> with data <var>properties</var>.
</ol>

</section> <!-- /Get Accessibility Properties for Accessible Object -->
</section> <!-- /Accessibility -->

<section>
<h2>Print</h2>

Expand Down Expand Up @@ -11602,7 +11730,11 @@ <h2>Index</h2>
<p>The following terms are defined
in the Accessible Rich Internet Applications (WAI-ARIA) 1.2 specification: [[wai-aria-1.2]]
<ul>
<li><dfn><a href="https://w3c.github.io/aria/#dfn-accessible-object"></a>accessible object</dfn>
Comment thread
spectranaut marked this conversation as resolved.
Outdated
<li><dfn><a href="https://w3c.github.io/aria/#accessibility_tree">accessibility tree</a></dfn>
<li><dfn><a href="https://w3c.github.io/aria/#tree_exclusion">elements which are excluded from the accessibility tree</a></dfn>
<li><dfn><a href="https://w3c.github.io/aria/#introroles">WAI-ARIA role</a></dfn>
<li><dfn><a href="https://w3c.github.io/aria/#introstates">WAI-ARIA states and properties</a></dfn>
Comment thread
spectranaut marked this conversation as resolved.
Outdated
</ul>

<dd>
Expand Down
Loading