2.3.1 • Published 1 year ago

ember-aria-utilities v2.3.1

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

ember-aria-utilities

CI npm version

ARIA utilities for helping create some of the more complex ARIA design patterns. Follows https://www.w3.org/TR/wai-aria-practices/

Compatibility

  • ember-source v3.24 or above
  • ember-auto-import v2 or above
  • ember-cli classic build, embroider safe and optimized builds
  • typescript v4.5.2 or above

For testing

  • @ember/test-helpers v2.4 or above

Installation

ember install ember-aria-utilities

{{aria-grid}}

This library provides keyboard interaction for grids based on the ARIA Grid design pattern. This benefits people that interact with grids via keyboard or methods other than a mouse. This includes people such as power users and people that can’t use a mouse. The keyboard interactions make it easier to navigate large data sets.

Interactive Example

This example allows you to try out the keyboard interactions as outlined in §Keyboard Interaction.

Keyboard Interaction

Note: If focus is on a cell inside the “body” and Ctrl+Up Arrow is pressed. Focus will move move to the top most cell in the “body”. A second press is needed to move into the column headers.

Note: There is no such difference between a “data cell” and a “row header”.

Future Support

Future updates will allow for selection of cells/rows. Also included is the following keyboard support.

Related links

How to apply

{{aria-grid}} provides you the keyboard interaction. The component it’s applied to will need to have all the appropriate ARIA roles, states, and properties as outlined in the authoring practices.

<div role="grid" {{aria-grid}}>
  <div role="row">
    <div tabindex="-1" role="columnheader">Name</div>
    <div tabindex="-1" role="columnheader">Function</div>
    <div tabindex="-1" role="columnheader">Username</div>
  </div>
  <div role="row">
    <div tabindex="-1" role="cell">Jenny Judova</div>
    <div tabindex="-1" role="cell">Engineer</div>
    <div tabindex="-1" role="cell">n/a</div>
  </div>
  <div role="row">
    <div tabindex="-1" role="cell">Preston Sego</div>
    <div tabindex="-1" role="cell">Software Artificer</div>
    <div tabindex="-1" role="cell">@nullvoxpopuli</div>
  </div>
  <div role="row">
    <div tabindex="-1" role="cell">Zoë Bijl</div>
    <div tabindex="-1" role="cell">Rambling Accessibility Engineer</div>
    <div tabindex="-1" role="cell">@zoe</div>
  </div>
</div>

Contributing

See the Contributing guide for details.

License

This project is licensed under the MIT License.