Data Grid - Accessibility
Learn how the Data Grid implements accessibility features and guidelines, including keyboard navigation that follows international standards.
Guidelines
Common conformance guidelines for accessibility include:
- Globally accepted standard: WCAG
- US:
- ADA - US Department of Justice
- Section 508 - US federal agencies
- Europe: EAA (European Accessibility Act)
WCAG 2.1 has three levels of conformance: A, AA, and AAA. Level AA exceeds the basic criteria for accessibility and is a common target for most organizations, so this is what we aim to support.
The WAI-ARIA Authoring Practices provide valuable information on how to optimize the accessibility of a Data Grid.
Density
The Data Grid exposes the density prop which supports the following values:
standard(default)compactcomfortable
Set the density programmatically
You can set the density programmatically in one of the following ways:
Uncontrolled – initialize the density with the
initialState.densityprop.<DataGrid initialState={{ density: 'compact', }} />Controlled – pass the
densityandonDensityChangeprops. For more advanced use cases, you can also subscribe to thedensityChangegrid event.const [density, setDensity] = React.useState<GridDensity>('compact'); return ( <DataGrid density={density} onDensityChange={(newDensity) => setDensity(newDensity)} /> );
The density prop applies the values determined by the rowHeight and columnHeaderHeight props, if supplied.
The user can override this setting with the optional toolbar density selector.
You can create a custom toolbar with a density selector that allows users to change the density of the Data Grid, as shown in the demo below.
See the Toolbar component—Settings menu for an example of how to create a settings menu that stores user preferences in local storage.
Keyboard navigation
The Data Grid listens for keyboard interactions from the user and emits events in response to key presses within cells.
Tab sequence
According to WAI-ARIA Authoring Practices, only one of the focusable elements contained by a composite widget should be included in the page tab sequence.
For an element to be included in the tab sequence, it needs to have a tabIndex value of zero or greater.
When a user focuses on a Data Grid cell, the first inner element with tabIndex={0} receives the focus.
If there is no element with tabIndex={0}, the focus is set on the cell itself.
The two Data Grids below illustrate how the user experience is impacted by improper management of the page tab sequence, making it difficult to navigate through the data set:
Without focus management
Correct focus management
If you customize cell rendering with the renderCell method, you become responsible for removing focusable elements from the page tab sequence.
Use the tabIndex prop passed to the renderCell params to determine if the rendered cell has focus and if, as a result, the inner elements should be removed from the tab sequence:
renderCell: (params) => (
<div>
<Link tabIndex={params.tabIndex} href="/#">
more info
</Link>
</div>
);
Navigation
| Keys | Description |
|---|---|
| Arrow Left | Navigate between cell elements |
| Arrow Down | Navigate between cell elements |
| Arrow Right | Navigate between cell elements |
| Arrow Up | Navigate between cell elements |
| Home | Navigate to the first cell of the current row |
| End | Navigate to the last cell of the current row |
| Ctrl+Home | Navigate to the first cell of the first row |
| Ctrl+End | Navigate to the last cell of the last row |
| Space | Navigate to the next scrollable page |
| Page Up | Navigate to the previous scrollable page |
| Page Down | Navigate to the next scrollable page |
| Space | Toggle row children expansion when grouping cell is focused |
Selection
| Keys | Description |
|---|---|
| Shift+Space | Select/Deselect the current row |
| Shift+Arrow Up/Down | Select the current row and the row above or below |
| Shift+ Click on cell | Select the range of rows between the first and the last clicked rows |
| Ctrl+A | Select all rows |
| Ctrl+C | Copy the currently selected rows |
| Ctrl+ Click on cell | Enable multi-selection |
| Ctrl+ Click on a selected row | Deselect the row |
Sorting
| Keys | Description |
|---|---|
| Ctrl+ Click on header | Enable multi-sorting |
| Shift+ Click on header | Enable multi-sorting |
| Shift+Enter | Enable multi-sorting when column header is focused |
| Enter | Sort column when column header is focused |
| Ctrl+Enter | Open column menu when column header is focused |
Group and pivot
| Keys | Description |
|---|---|
| Ctrl+Enter | Toggle the detail panel of a row |