README.md

ARIA treegrid example

Jump to interactive version

Rationale

The ARIA treegrid has not gotten enough love. Docs the old specs provide recommendations for keyboard shortcuts that would conflict with browser/OS keys.

Challenges

The main challenge is that the left/right arrow key could be used to collapse/expand or to move by column. The few approaches out there take the approach that left/right should move by cell, but this takes the opposite approach. In this example, left/right collapse/expand, and move-by-word keys are used to move by cell.

Assumptions

• Most treegrids don't have that many columns, and are more vertical than horizontal
• Most users know how to navigate a tree
• The most important navigation in a treegrid is by row, like in a normal tree
• Navigation by cell is often more of a convenience than a necessity

Approach

• By default, a user is in row navigation mode. We allow traversal of columns via the move-by-word keys.
• Ideally, screen readers would automatically read from the currently focused cell to the end of the row. The benefit of this would be that the user could effectively always be in row mode, as the screen reader would end up reading the entire line when moving to the next row anyway. However, screen readers don't necessarily do this currently. Thus, the approach was taken that when the first column would have been active, we focus the entire row, to help the screen reader know to read the entire thing.

Keyboard specifics

• Up/down - moves by row is in an ordinary tree
• Left/right - collapses/expands or moves to parent/first-child as in an ordinary tree. TBD, what should these keys do during column navigation?
• Move by word key (ctrl+left/right or alt/left+right depending on the platform) - move by column
• Home/end - move to first/last row or column, depending on whether the last thing focused was a row or column

Markup used

• roles used are treegrid, row and gridcell
• aria-level: used to set the current level of an item, 1, 2, 3, etc.
• aria-posinset, aria-setsize: used to indicate the position of an item within it's local group, such as item 3 of 5. TBD, should we set these on cells as well so that the user knows what column # there are in? Possibly overkill.
• aria-expanded (triststate): this attribute must be removed (not present) if the item cannot be expanded. For expandable items, the value is "true" or "false"
• aria-hidden: set to "true" for child items that are currently hidden because the parent is collapsed
• aria-owns: not currently used, awaiting discussion. Could be used for parents to identify their children, but it doesn't look like any screen readers actually use this so it seems to be a wasteful recommendation.
• aria-labelledby or aria-describedby for headers? Not currently used, awaiting discussion
• aria-activedescendant -- this example does not use, because it is not exposed to ATs in IE, and thus uses tabindex instead
• aria-readonly: be default, a grid/treegrid is editable, but these tend not to be. This is mentioned in the text of the ARIA spec for grid/treegrid but doesn't seem to have made its way into the AAM. This idea originated for grids, which are like spreadsheets, where most cells are probably editable. It may not make sense for a treegrid, but this is the legacy. Bottom line: if you don't want "editable" read for every cell in some browser-screen reader combinations, you'll need to put aria-readonly="true" on the appropriate role="gridcell" elements or on the grid/treegrid itself.
• tabindex is set in the JS, as per the usual roving tabindex methodology. Specifically, we use tabindex="0" for the current item so that it is the subitem that gets focused if user tabs out and back in, and tabindex="-1" for all items where we want click-to-focus behavior enabled.

Questions

• Should a row automatically compute it's name or is this too much given the prevelance of tables on the web? We should look at nameFromContents in the ARIA spec, as well as the Firefox implementation.
• Should treeitem get nameFromContents? What about nested treeitems? Aaron thinks you never nest treeitems for other reasons includings CSS.

Observations with screen readers

Row navigation: requires Chrome Canary otherwise won't ready name

Levels not reported

Collapse/expand, nothing reported

	Chrome (Canary currently required)	Firefox	IE11	Safari
Chomevox	Row nav: Previously did not read name, should be fixed in Canary, needs test Cell nav: Does not read name on cells even if aria-label or aria-labelledby are set
JAWS	Row navigation: levels not reported Column navigation: no issues found Other: when collapsing/expanding: new collapsed/expanded state not spoken, says "row unselected", but nothing useful	Could not figure out how to interact with the control in a reasonable manner
NVDA	Row navigation: requires Chrome Canary otherwise won't ready name Column navigation: Does not read column headers	Row navigation: levels read correctly, all seems good Column navigation: cells are announced as "selected" but this seems redundant since it's not an aria-multiselectable treegrid Has very cool feature where Ctrl+alt arrow can navigate cells of table from current position, without additional help from the ARIA widget. If all screen readers did this then the widget author would not need to implement the cell navigation	Column navigation: unlike in Firefox, NVDA does not read column labels but instead reads the column number Row navigation: row numbers are reported, unlike with NVDA and Firefox. Unfortunately both row 2 and 3 are reported as row 2 :/ The ctrl+alt+arrow feature that is available in Firefox does not work in IE
VoiceOver	First focus: calls it a listbox Column navigation: reads each item twice Row navigation: does not read expanded state, completely skips reading second column for second row			Row navigation: doesn't let us do this, reads cells no matter what