Skip to content

Document ARIA mappings for boolean and node-list properties - #760

Open
blinding-pixels wants to merge 1 commit into
AccessKit:mainfrom
blinding-pixels:Docs-boolean-node-properties
Open

Document ARIA mappings for boolean and node-list properties#760
blinding-pixels wants to merge 1 commit into
AccessKit:mainfrom
blinding-pixels:Docs-boolean-node-properties

Conversation

@blinding-pixels

Copy link
Copy Markdown
Contributor

This continues the documentation work from #753 and #757 by covering two boolean properties and eight node-list properties discussed in #749.

Two of these properties, Children and RadioGroup, do not have direct ARIA equivalents. One property, Details, differs from its ARIA 1.2 equivalent because aria-details references a single element, while Details can reference multiple nodes. This difference has been documented.

I ran:

  • cargo fmt --all -- --check
  • RUSTDOCFLAGS="-D warnings" cargo doc -p accesskit --no-deps
  • cargo test -p accesskit

Happy to revise anything if required.

Comment thread accesskit/src/lib.rs
///
/// [`aria-controls`]: https://www.w3.org/TR/wai-aria-1.2/#aria-controls
(Controls, controls, set_controls, push_controlled, clear_controls),
/// The nodes that provide detailed, extended descriptions for this node.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like this documentation is too similar to the one for described_by. ARIA explains the link between the two and maybe we should do the same.

Comment thread accesskit/src/lib.rs
}

node_id_vec_property_methods! {
/// The ordered list of this node's direct children in the tree.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know if the single word "ordered" here is enough. Maybe we should replace it by a second sentence to hammer the fact that the order must be chosen carefully as it directly influences how widgets are placed, akin to the tab index on a web page. Any idea?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants