Table
A table displays data in rows and columns and enables a user to navigate its contents via directional navigation keys, and optionally supports row selection and sorting.
| install | yarn add react-aria-components |
|---|---|
| version | 1.0.0-alpha.0 |
| usage | import {Table} from 'react-aria-components' |
Example#
import {Cell, Column, Row, Table, TableBody, TableHeader} from 'react-aria-components';
<Table aria-label="Files" selectionMode="multiple">
<TableHeader>
<Column>
<MyCheckbox />
</Column>
<Column isRowHeader>Name</Column>
<Column>Type</Column>
<Column>Date Modified</Column>
</TableHeader>
<TableBody>
<Row>
<Cell>
<MyCheckbox />
</Cell>
<Cell>Games</Cell>
<Cell>File folder</Cell>
<Cell>6/7/2020</Cell>
</Row>
<Row>
<Cell>
<MyCheckbox />
</Cell>
<Cell>Program Files</Cell>
<Cell>File folder</Cell>
<Cell>4/7/2021</Cell>
</Row>
<Row>
<Cell>
<MyCheckbox />
</Cell>
<Cell>bootmgr</Cell>
<Cell>System file</Cell>
<Cell>11/20/2010</Cell>
</Row>
<Row>
<Cell>
<MyCheckbox />
</Cell>
<Cell>log.txt</Cell>
<Cell>Text Document</Cell>
<Cell>1/18/2016</Cell>
</Row>
</TableBody>
</Table>import {
Cell,
Column,
Row,
Table,
TableBody,
TableHeader
} from 'react-aria-components';
<Table aria-label="Files" selectionMode="multiple">
<TableHeader>
<Column>
<MyCheckbox />
</Column>
<Column isRowHeader>Name</Column>
<Column>Type</Column>
<Column>Date Modified</Column>
</TableHeader>
<TableBody>
<Row>
<Cell>
<MyCheckbox />
</Cell>
<Cell>Games</Cell>
<Cell>File folder</Cell>
<Cell>6/7/2020</Cell>
</Row>
<Row>
<Cell>
<MyCheckbox />
</Cell>
<Cell>Program Files</Cell>
<Cell>File folder</Cell>
<Cell>4/7/2021</Cell>
</Row>
<Row>
<Cell>
<MyCheckbox />
</Cell>
<Cell>bootmgr</Cell>
<Cell>System file</Cell>
<Cell>11/20/2010</Cell>
</Row>
<Row>
<Cell>
<MyCheckbox />
</Cell>
<Cell>log.txt</Cell>
<Cell>Text Document</Cell>
<Cell>1/18/2016</Cell>
</Row>
</TableBody>
</Table>import {
Cell,
Column,
Row,
Table,
TableBody,
TableHeader
} from 'react-aria-components';
<Table
aria-label="Files"
selectionMode="multiple"
>
<TableHeader>
<Column>
<MyCheckbox />
</Column>
<Column
isRowHeader
>
Name
</Column>
<Column>
Type
</Column>
<Column>
Date Modified
</Column>
</TableHeader>
<TableBody>
<Row>
<Cell>
<MyCheckbox />
</Cell>
<Cell>
Games
</Cell>
<Cell>
File folder
</Cell>
<Cell>
6/7/2020
</Cell>
</Row>
<Row>
<Cell>
<MyCheckbox />
</Cell>
<Cell>
Program Files
</Cell>
<Cell>
File folder
</Cell>
<Cell>
4/7/2021
</Cell>
</Row>
<Row>
<Cell>
<MyCheckbox />
</Cell>
<Cell>
bootmgr
</Cell>
<Cell>
System file
</Cell>
<Cell>
11/20/2010
</Cell>
</Row>
<Row>
<Cell>
<MyCheckbox />
</Cell>
<Cell>
log.txt
</Cell>
<Cell>
Text Document
</Cell>
<Cell>
1/18/2016
</Cell>
</Row>
</TableBody>
</Table>Show CSS
.react-aria-Table {
--highlight-background: slateblue;
--highlight-foreground: white;
--border-color: var(--spectrum-global-color-gray-400);
--background-color: var(--page-background);
--text-color: var(--spectrum-alias-text-color);
--text-color-disabled: var(--spectrum-alias-text-color-disabled);
padding: 0.286rem;
border: 1px solid var(--border-color);
border-radius: 6px;
background: var(--background-color);
outline: none;
border-spacing: 0;
min-height: 100px;
align-self: start;
&[data-focus-visible] {
border-color: var(--highlight-background);
box-shadow: 0 0 0 1px var(--highlight-background);
}
.react-aria-TableHeader {
&:after {
content: '';
display: table-row;
height: 2px;
}
& tr:last-child .react-aria-Column {
border-bottom: 1px solid var(--border-color);
cursor: default;
}
}
.react-aria-Column {
&[colspan] {
text-align: center;
}
.sort-indicator {
padding: 0 2px;
}
&[aria-sort=none] .sort-indicator {
visibility: hidden;
}
}
.react-aria-TableBody {
&[data-empty] {
text-align: center;
font-style: italic;
}
}
.react-aria-Row {
border-radius: 6px;
outline: none;
cursor: default;
color: var(--text-color);
font-size: 1.072rem;
position: relative;
transform: scale(1);
&[data-focus-visible] {
outline: 2px solid var(--highlight-background);
outline-offset: -2px;
}
&[data-pressed] .react-aria-Cell {
background: var(--spectrum-global-color-gray-200);
}
&[aria-selected=true] {
.react-aria-Cell {
background: var(--highlight-background);
color: var(--highlight-foreground);
}
&[data-focus-visible],
.react-aria-Cell[data-focus-visible] {
outline-color: var(--highlight-foreground);
outline-offset: -4px;
}
.react-aria-Button {
color: var(--highlight-foreground);
--focus-ring-color: var(--highlight-foreground);
--hover-highlight: rgb(255 255 255 / 0.1);
--active-highlight: rgb(255 255 255 / 0.2);
}
}
&[aria-disabled] {
color: var(--text-color-disabled);
}
}
.react-aria-Cell,
.react-aria-Column {
padding: 4px 8px;
text-align: left;
outline: none;
&[data-focus-visible] {
outline: 2px solid var(--highlight-background);
outline-offset: -2px;
}
}
.react-aria-Cell {
&:first-child {
border-radius: 6px 0 0 6px;
}
&:last-child {
border-radius: 0 6px 6px 0;
}
}
/* join selected items if :has selector is supported */
@supports selector(:has(.foo)) {
.react-aria-Row[aria-selected=true]:has(+ [aria-selected=true]) .react-aria-Cell {
border-end-start-radius: 0;
border-end-end-radius: 0;
}
.react-aria-Row[aria-selected=true] + [aria-selected=true] .react-aria-Cell {
border-start-start-radius: 0;
border-start-end-radius: 0;
}
}
}
.react-aria-Checkbox {
--deselected-color: gray;
--deselected-color-pressed: dimgray;
--selected-color: slateblue;
--selected-color-pressed: lch(from slateblue calc(l - 10%) c h);
--checkmark-color: white;
--focus-ring-color: slateblue;
width: 1rem;
height: 1rem;
border: 2px solid var(--deselected-color);
border-radius: 4px;
transition: all 200ms;
display: flex;
align-items: center;
justify-content: center;
& svg {
width: 0.857rem;
height: 0.857rem;
fill: none;
stroke: var(--checkmark-color);
stroke-width: 3px;
stroke-dasharray: 22px;
stroke-dashoffset: 66;
transition: all 200ms;
}
&[data-focus-visible] {
box-shadow: 0 0 0 2px var(--spectrum-alias-background-color-default), 0 0 0 4px var(--focus-ring-color);
}
&[data-pressed] {
border-color: var(--deselected-color-pressed);
}
&[data-selected],
&[data-indeterminate] {
border-color: var(--selected-color);
background: var(--selected-color);
&[data-pressed] {
border-color: var(--selected-color-pressed);
background: var(--selected-color-pressed);
}
&[data-focus-visible] {
box-shadow: 0 0 0 2px var(--background-color), 0 0 0 4px var(--selected-color);
}
& svg {
stroke-dashoffset: 44;
}
}
&[data-indeterminate] {
& svg {
stroke: none;
fill: var(--checkmark-color);
}
}
&[data-disabled] {
opacity: 0.4;
}
}
:where(.react-aria-Row) .react-aria-Checkbox {
--selected-color: white;
--selected-color-pressed: #ddd;
--checkmark-color: slateblue;
--background-color: var(--highlight-background);
}
.react-aria-Button {
background: transparent;
border: none;
border-radius: 4px;
appearance: none;
vertical-align: middle;
font-size: 1.2rem;
text-align: center;
line-height: 1.2em;
margin: 0;
outline: none;
padding: 4px 6px;
transition: background 200ms;
--focus-ring-color: slateblue;
--hover-highlight: var(--spectrum-alias-highlight-hover);
--active-highlight: var(--spectrum-alias-highlight-active);
&[data-hovered] {
background: var(--hover-highlight);
}
&[data-pressed] {
background: var(--active-highlight);
}
&[data-focus-visible] {
box-shadow: 0 0 0 2px var(--focus-ring-color);
}
}
@media (forced-colors: active) {
.react-aria-Table {
forced-color-adjust: none;
--highlight-background: Highlight;
--highlight-foreground: HighlightText;
--border-color: ButtonBorder;
--background-color: ButtonFace;
--text-color: ButtonText;
--text-color-disabled: GrayText;
}
.react-aria-Checkbox {
forced-color-adjust: none;
--deselected-color: ButtonBorder;
--deselected-color-pressed: ButtonBorder;
--selected-color: Highlight;
--selected-color-pressed: Highlight;
--checkmark-color: HighlightText;
--spectrum-alias-background-color-default: Canvas;
--focus-ring-color: Highlight;
&[data-disabled] {
opacity: 1;
--deselected-color: GrayText;
--selected-color: GrayText;
}
}
.react-aria-Row .react-aria-Checkbox {
--selected-color: ButtonFace;
--selected-color-pressed: ButtonFace;
--checkmark-color: ButtonText;
}
.react-aria-Button {
forced-color-adjust: none;
--focus-ring-color: Highlight;
}
}.react-aria-Table {
--highlight-background: slateblue;
--highlight-foreground: white;
--border-color: var(--spectrum-global-color-gray-400);
--background-color: var(--page-background);
--text-color: var(--spectrum-alias-text-color);
--text-color-disabled: var(--spectrum-alias-text-color-disabled);
padding: 0.286rem;
border: 1px solid var(--border-color);
border-radius: 6px;
background: var(--background-color);
outline: none;
border-spacing: 0;
min-height: 100px;
align-self: start;
&[data-focus-visible] {
border-color: var(--highlight-background);
box-shadow: 0 0 0 1px var(--highlight-background);
}
.react-aria-TableHeader {
&:after {
content: '';
display: table-row;
height: 2px;
}
& tr:last-child .react-aria-Column {
border-bottom: 1px solid var(--border-color);
cursor: default;
}
}
.react-aria-Column {
&[colspan] {
text-align: center;
}
.sort-indicator {
padding: 0 2px;
}
&[aria-sort=none] .sort-indicator {
visibility: hidden;
}
}
.react-aria-TableBody {
&[data-empty] {
text-align: center;
font-style: italic;
}
}
.react-aria-Row {
border-radius: 6px;
outline: none;
cursor: default;
color: var(--text-color);
font-size: 1.072rem;
position: relative;
transform: scale(1);
&[data-focus-visible] {
outline: 2px solid var(--highlight-background);
outline-offset: -2px;
}
&[data-pressed] .react-aria-Cell {
background: var(--spectrum-global-color-gray-200);
}
&[aria-selected=true] {
.react-aria-Cell {
background: var(--highlight-background);
color: var(--highlight-foreground);
}
&[data-focus-visible],
.react-aria-Cell[data-focus-visible] {
outline-color: var(--highlight-foreground);
outline-offset: -4px;
}
.react-aria-Button {
color: var(--highlight-foreground);
--focus-ring-color: var(--highlight-foreground);
--hover-highlight: rgb(255 255 255 / 0.1);
--active-highlight: rgb(255 255 255 / 0.2);
}
}
&[aria-disabled] {
color: var(--text-color-disabled);
}
}
.react-aria-Cell,
.react-aria-Column {
padding: 4px 8px;
text-align: left;
outline: none;
&[data-focus-visible] {
outline: 2px solid var(--highlight-background);
outline-offset: -2px;
}
}
.react-aria-Cell {
&:first-child {
border-radius: 6px 0 0 6px;
}
&:last-child {
border-radius: 0 6px 6px 0;
}
}
/* join selected items if :has selector is supported */
@supports selector(:has(.foo)) {
.react-aria-Row[aria-selected=true]:has(+ [aria-selected=true]) .react-aria-Cell {
border-end-start-radius: 0;
border-end-end-radius: 0;
}
.react-aria-Row[aria-selected=true] + [aria-selected=true] .react-aria-Cell {
border-start-start-radius: 0;
border-start-end-radius: 0;
}
}
}
.react-aria-Checkbox {
--deselected-color: gray;
--deselected-color-pressed: dimgray;
--selected-color: slateblue;
--selected-color-pressed: lch(from slateblue calc(l - 10%) c h);
--checkmark-color: white;
--focus-ring-color: slateblue;
width: 1rem;
height: 1rem;
border: 2px solid var(--deselected-color);
border-radius: 4px;
transition: all 200ms;
display: flex;
align-items: center;
justify-content: center;
& svg {
width: 0.857rem;
height: 0.857rem;
fill: none;
stroke: var(--checkmark-color);
stroke-width: 3px;
stroke-dasharray: 22px;
stroke-dashoffset: 66;
transition: all 200ms;
}
&[data-focus-visible] {
box-shadow: 0 0 0 2px var(--spectrum-alias-background-color-default), 0 0 0 4px var(--focus-ring-color);
}
&[data-pressed] {
border-color: var(--deselected-color-pressed);
}
&[data-selected],
&[data-indeterminate] {
border-color: var(--selected-color);
background: var(--selected-color);
&[data-pressed] {
border-color: var(--selected-color-pressed);
background: var(--selected-color-pressed);
}
&[data-focus-visible] {
box-shadow: 0 0 0 2px var(--background-color), 0 0 0 4px var(--selected-color);
}
& svg {
stroke-dashoffset: 44;
}
}
&[data-indeterminate] {
& svg {
stroke: none;
fill: var(--checkmark-color);
}
}
&[data-disabled] {
opacity: 0.4;
}
}
:where(.react-aria-Row) .react-aria-Checkbox {
--selected-color: white;
--selected-color-pressed: #ddd;
--checkmark-color: slateblue;
--background-color: var(--highlight-background);
}
.react-aria-Button {
background: transparent;
border: none;
border-radius: 4px;
appearance: none;
vertical-align: middle;
font-size: 1.2rem;
text-align: center;
line-height: 1.2em;
margin: 0;
outline: none;
padding: 4px 6px;
transition: background 200ms;
--focus-ring-color: slateblue;
--hover-highlight: var(--spectrum-alias-highlight-hover);
--active-highlight: var(--spectrum-alias-highlight-active);
&[data-hovered] {
background: var(--hover-highlight);
}
&[data-pressed] {
background: var(--active-highlight);
}
&[data-focus-visible] {
box-shadow: 0 0 0 2px var(--focus-ring-color);
}
}
@media (forced-colors: active) {
.react-aria-Table {
forced-color-adjust: none;
--highlight-background: Highlight;
--highlight-foreground: HighlightText;
--border-color: ButtonBorder;
--background-color: ButtonFace;
--text-color: ButtonText;
--text-color-disabled: GrayText;
}
.react-aria-Checkbox {
forced-color-adjust: none;
--deselected-color: ButtonBorder;
--deselected-color-pressed: ButtonBorder;
--selected-color: Highlight;
--selected-color-pressed: Highlight;
--checkmark-color: HighlightText;
--spectrum-alias-background-color-default: Canvas;
--focus-ring-color: Highlight;
&[data-disabled] {
opacity: 1;
--deselected-color: GrayText;
--selected-color: GrayText;
}
}
.react-aria-Row .react-aria-Checkbox {
--selected-color: ButtonFace;
--selected-color-pressed: ButtonFace;
--checkmark-color: ButtonText;
}
.react-aria-Button {
forced-color-adjust: none;
--focus-ring-color: Highlight;
}
}.react-aria-Table {
--highlight-background: slateblue;
--highlight-foreground: white;
--border-color: var(--spectrum-global-color-gray-400);
--background-color: var(--page-background);
--text-color: var(--spectrum-alias-text-color);
--text-color-disabled: var(--spectrum-alias-text-color-disabled);
padding: 0.286rem;
border: 1px solid var(--border-color);
border-radius: 6px;
background: var(--background-color);
outline: none;
border-spacing: 0;
min-height: 100px;
align-self: start;
&[data-focus-visible] {
border-color: var(--highlight-background);
box-shadow: 0 0 0 1px var(--highlight-background);
}
.react-aria-TableHeader {
&:after {
content: '';
display: table-row;
height: 2px;
}
& tr:last-child .react-aria-Column {
border-bottom: 1px solid var(--border-color);
cursor: default;
}
}
.react-aria-Column {
&[colspan] {
text-align: center;
}
.sort-indicator {
padding: 0 2px;
}
&[aria-sort=none] .sort-indicator {
visibility: hidden;
}
}
.react-aria-TableBody {
&[data-empty] {
text-align: center;
font-style: italic;
}
}
.react-aria-Row {
border-radius: 6px;
outline: none;
cursor: default;
color: var(--text-color);
font-size: 1.072rem;
position: relative;
transform: scale(1);
&[data-focus-visible] {
outline: 2px solid var(--highlight-background);
outline-offset: -2px;
}
&[data-pressed] .react-aria-Cell {
background: var(--spectrum-global-color-gray-200);
}
&[aria-selected=true] {
.react-aria-Cell {
background: var(--highlight-background);
color: var(--highlight-foreground);
}
&[data-focus-visible],
.react-aria-Cell[data-focus-visible] {
outline-color: var(--highlight-foreground);
outline-offset: -4px;
}
.react-aria-Button {
color: var(--highlight-foreground);
--focus-ring-color: var(--highlight-foreground);
--hover-highlight: rgb(255 255 255 / 0.1);
--active-highlight: rgb(255 255 255 / 0.2);
}
}
&[aria-disabled] {
color: var(--text-color-disabled);
}
}
.react-aria-Cell,
.react-aria-Column {
padding: 4px 8px;
text-align: left;
outline: none;
&[data-focus-visible] {
outline: 2px solid var(--highlight-background);
outline-offset: -2px;
}
}
.react-aria-Cell {
&:first-child {
border-radius: 6px 0 0 6px;
}
&:last-child {
border-radius: 0 6px 6px 0;
}
}
/* join selected items if :has selector is supported */
@supports selector(:has(.foo)) {
.react-aria-Row[aria-selected=true]:has(+ [aria-selected=true]) .react-aria-Cell {
border-end-start-radius: 0;
border-end-end-radius: 0;
}
.react-aria-Row[aria-selected=true] + [aria-selected=true] .react-aria-Cell {
border-start-start-radius: 0;
border-start-end-radius: 0;
}
}
}
.react-aria-Checkbox {
--deselected-color: gray;
--deselected-color-pressed: dimgray;
--selected-color: slateblue;
--selected-color-pressed: lch(from slateblue calc(l - 10%) c h);
--checkmark-color: white;
--focus-ring-color: slateblue;
width: 1rem;
height: 1rem;
border: 2px solid var(--deselected-color);
border-radius: 4px;
transition: all 200ms;
display: flex;
align-items: center;
justify-content: center;
& svg {
width: 0.857rem;
height: 0.857rem;
fill: none;
stroke: var(--checkmark-color);
stroke-width: 3px;
stroke-dasharray: 22px;
stroke-dashoffset: 66;
transition: all 200ms;
}
&[data-focus-visible] {
box-shadow: 0 0 0 2px var(--spectrum-alias-background-color-default), 0 0 0 4px var(--focus-ring-color);
}
&[data-pressed] {
border-color: var(--deselected-color-pressed);
}
&[data-selected],
&[data-indeterminate] {
border-color: var(--selected-color);
background: var(--selected-color);
&[data-pressed] {
border-color: var(--selected-color-pressed);
background: var(--selected-color-pressed);
}
&[data-focus-visible] {
box-shadow: 0 0 0 2px var(--background-color), 0 0 0 4px var(--selected-color);
}
& svg {
stroke-dashoffset: 44;
}
}
&[data-indeterminate] {
& svg {
stroke: none;
fill: var(--checkmark-color);
}
}
&[data-disabled] {
opacity: 0.4;
}
}
:where(.react-aria-Row) .react-aria-Checkbox {
--selected-color: white;
--selected-color-pressed: #ddd;
--checkmark-color: slateblue;
--background-color: var(--highlight-background);
}
.react-aria-Button {
background: transparent;
border: none;
border-radius: 4px;
appearance: none;
vertical-align: middle;
font-size: 1.2rem;
text-align: center;
line-height: 1.2em;
margin: 0;
outline: none;
padding: 4px 6px;
transition: background 200ms;
--focus-ring-color: slateblue;
--hover-highlight: var(--spectrum-alias-highlight-hover);
--active-highlight: var(--spectrum-alias-highlight-active);
&[data-hovered] {
background: var(--hover-highlight);
}
&[data-pressed] {
background: var(--active-highlight);
}
&[data-focus-visible] {
box-shadow: 0 0 0 2px var(--focus-ring-color);
}
}
@media (forced-colors: active) {
.react-aria-Table {
forced-color-adjust: none;
--highlight-background: Highlight;
--highlight-foreground: HighlightText;
--border-color: ButtonBorder;
--background-color: ButtonFace;
--text-color: ButtonText;
--text-color-disabled: GrayText;
}
.react-aria-Checkbox {
forced-color-adjust: none;
--deselected-color: ButtonBorder;
--deselected-color-pressed: ButtonBorder;
--selected-color: Highlight;
--selected-color-pressed: Highlight;
--checkmark-color: HighlightText;
--spectrum-alias-background-color-default: Canvas;
--focus-ring-color: Highlight;
&[data-disabled] {
opacity: 1;
--deselected-color: GrayText;
--selected-color: GrayText;
}
}
.react-aria-Row .react-aria-Checkbox {
--selected-color: ButtonFace;
--selected-color-pressed: ButtonFace;
--checkmark-color: ButtonText;
}
.react-aria-Button {
forced-color-adjust: none;
--focus-ring-color: Highlight;
}
}Features#
A table can be built using the <table>, <tr>,
<td>, and other table specific HTML elements, but is very limited in functionality especially when it comes to user interactions.
HTML tables are meant for static content, rather than tables with rich interactions like focusable elements within cells, keyboard navigation, row selection, sorting, etc.
Table helps achieve accessible and interactive table components that can be styled as needed.
- Row selection – Single or multiple selection, with optional checkboxes, disabled rows, and both
toggleandreplaceselection behaviors. - Columns – Support for column sorting, row header columns, and nested column groups.
- Interactive children – Table cells may include interactive elements such as buttons, menus, etc.
- Actions – Rows and cells support optional actions such as navigation via click, tap, double click, or Enter key.
- Async loading – Support for loading and sorting items asynchronously, with infinite and virtualized scrolling.
- Keyboard navigation – Table rows, cells, and focusable children can be navigated using the arrow keys, along with page up/down, home/end, etc. Typeahead, auto scrolling, and selection modifier keys are supported as well.
- Touch friendly – Selection and actions adapt their behavior depending on the device. For example, selection is activated via long press on touch when row actions are present.
- Accessible – Follows the ARIA grid pattern, with additional selection announcements via an ARIA live region. Extensively tested across many devices and assistive technologies to ensure announcements and behaviors are consistent.
Anatomy#
A table consists of a container element, with columns and rows of cells containing data inside. The cells within a table may contain focusable elements or plain text content. If the table supports row selection, each row can optionally include a selection checkbox in the first column. Additionally, a "select all" checkbox is displayed as the first column header if the table supports multiple row selection.
Concepts#
Table makes use of the following concepts:
Props#
Table#
| Name | Type | Default | Description |
children | ReactNode | — | The elements that make up the table. Includes the TableHeader, TableBody, Columns, and Rows. |
selectionBehavior | SelectionBehavior | "toggle" | How multiple selection should behave in the collection. |
disabledBehavior | DisabledBehavior | "selection" | Whether disabledKeys applies to all interactions, or only selection. |
dragAndDropHooks | DragAndDropHooks | — | The drag and drop hooks returned by useDragAndDrop used to enable drag and drop behavior for the Table. |
disabledKeys | Iterable<Key> | — | A list of row keys to disable. |
selectionMode | SelectionMode | — | The type of selection that is allowed in the collection. |
disallowEmptySelection | boolean | — | Whether the collection allows empty selection. |
selectedKeys | 'all' | Iterable<Key> | — | The currently selected keys in the collection (controlled). |
defaultSelectedKeys | 'all' | Iterable<Key> | — | The initial selected keys in the collection (uncontrolled). |
sortDescriptor | SortDescriptor | — | The current sorted column and direction. |
className | string | (
(values: TableRenderProps
)) => string | — | The CSS className for the element. A function may be provided to compute the class based on component state. |
style | CSSProperties | (
(values: TableRenderProps
)) => CSSProperties | — | The inline style for the element. A function may be provided to compute the style based on component state. |
Events
| Name | Type | Default | Description |
onRowAction | (
(key: Key
)) => void | — | Handler that is called when a user performs an action on the row. |
onCellAction | (
(key: Key
)) => void | — | Handler that is called when a user performs an action on the cell. |
onSelectionChange | (
(keys: Selection
)) => any | — | Handler that is called when the selection changes. |
onSortChange | (
(descriptor: SortDescriptor
)) => any | — | Handler that is called when the sorted column or direction changes. |
Layout
| Name | Type | Default | Description |
slot | string | — | A slot name for the component. Slots allow the component to receive props from a parent component. |
Accessibility
| Name | Type | Default | Description |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the object. |
TableHeader#
| Name | Type | Default | Description |
columns | object[] | — | A list of table columns. |
children | ReactNode | (
(item: object
)) => ReactElement | — | A list of Column(s) or a function. If the latter, a list of columns must be provided using the columns prop. |
Column#
| Name | Type | Default | Description |
title | ReactNode | — | Rendered contents of the column if children contains child columns. |
childColumns | object[] | — | A list of child columns used when dynamically rendering nested child columns. |
allowsSorting | boolean | — | Whether the column allows sorting. |
isRowHeader | boolean | — | Whether a column is a row header and should be announced by assistive technology during row navigation. |
textValue | string | — | A string representation of the column's contents, used for accessibility announcements. |
children | ReactNode | (
(values: ColumnRenderProps
)) => ReactNode | — | The children of the component. A function may be provided to alter the children based on component state. |
className | string | (
(values: ColumnRenderProps
)) => string | — | The CSS className for the element. A function may be provided to compute the class based on component state. |
style | CSSProperties | (
(values: ColumnRenderProps
)) => CSSProperties | — | The inline style for the element. A function may be provided to compute the style based on component state. |
Accessibility
| Name | Type | Default | Description |
id | Key | — |
TableBody#
| Name | Type | Default | Description |
renderEmptyState | () => ReactNode | — | Provides content to display when there are no rows in the table. |
children | ReactNode | (
(item: object
)) => ReactElement | — | The contents of the collection. |
items | Iterable<object> | — | Item objects in the collection. |
disabledKeys | Iterable<Key> | — | The item keys that are disabled. These items cannot be selected, focused, or otherwise interacted with. |
className | string | (
(values: TableBodyRenderProps
)) => string | — | The CSS className for the element. A function may be provided to compute the class based on component state. |
style | CSSProperties | (
(values: TableBodyRenderProps
)) => CSSProperties | — | The inline style for the element. A function may be provided to compute the style based on component state. |
Row#
| Name | Type | Default | Description |
columns | Iterable<object> | — | A list of columns used when dynamically rendering cells. |
children | ReactNode | (
(item: object
)) => ReactElement | — | The cells within the row. Supports static items or a function for dynamic rendering. |
textValue | string | — | A string representation of the row's contents, used for features like typeahead. |
className | string | (
(values: RowRenderProps
)) => string | — | The CSS className for the element. A function may be provided to compute the class based on component state. |
style | CSSProperties | (
(values: RowRenderProps
)) => CSSProperties | — | The inline style for the element. A function may be provided to compute the style based on component state. |
Accessibility
| Name | Type | Default | Description |
id | Key | — |
Cell#
| Name | Type | Default | Description |
children | ReactNode | — | The contents of the cell. |
textValue | string | — | A string representation of the cell's contents, used for features like typeahead. |
className | string | (
(values: CellRenderProps
)) => string | — | The CSS className for the element. A function may be provided to compute the class based on component state. |
style | CSSProperties | (
(values: CellRenderProps
)) => CSSProperties | — | The inline style for the element. A function may be provided to compute the style based on component state. |
Accessibility
| Name | Type | Default | Description |
id | Key | — |
Styling#
React Aria components can be styled in many ways, including using CSS classes, inline styles, utility classes (e.g. Tailwind), CSS-in-JS (e.g. Styled Components), etc. By default, all components include a builtin className attribute which can be targeted using CSS selectors. These follow the react-aria-ComponentName naming convention.
.react-aria-Table {
/* ... */
}.react-aria-Table {
/* ... */
}.react-aria-Table {
/* ... */
}A custom className can also be specified on any component. This overrides the default className provided by React Aria with your own.
<Table className="my-table">
{/* ... */}
</Table><Table className="my-table">
{/* ... */}
</Table><Table className="my-table">
{/* ... */}
</Table>In addition, some components support multiple UI states (e.g. pressed, hovered, etc.). React Aria components expose states using DOM attributes, which you can target in CSS selectors. These are ARIA attributes wherever possible, or data attributes when a relevant ARIA attribute does not exist. For example:
.react-aria-Row[aria-selected=true] {
/* ... */
}
.react-aria-Row[data-focused] {
/* ... */
}.react-aria-Row[aria-selected=true] {
/* ... */
}
.react-aria-Row[data-focused] {
/* ... */
}.react-aria-Row[aria-selected=true] {
/* ... */
}
.react-aria-Row[data-focused] {
/* ... */
}The className and style props also accept functions which receive states for styling. This lets you dynamically determine the classes or styles to apply, which is useful when using utility CSS libraries like Tailwind.
<Row
className={({ isSelected }) => isSelected ? 'bg-blue-400' : 'bg-gray-100'}
>
Item
</Row><Row
className={({ isSelected }) =>
isSelected ? 'bg-blue-400' : 'bg-gray-100'}
>
Item
</Row><Row
className={(
{ isSelected }
) =>
isSelected
? 'bg-blue-400'
: 'bg-gray-100'}
>
Item
</Row>Render props may also be used as children to alter what elements are rendered based on the current state. For example, you could render a sort indicator in sortable columns.
<Column>
{({allowsSorting, sortDirection}) => (
<>
Column Title
{allowsSorting && <MySortIndicator direction={sortDirection} />}
</>
)}
</Column><Column>
{({ allowsSorting, sortDirection }) => (
<>
Column Title
{allowsSorting && (
<MySortIndicator direction={sortDirection} />
)}
</>
)}
</Column><Column>
{(
{
allowsSorting,
sortDirection
}
) => (
<>
Column Title
{allowsSorting &&
(
<MySortIndicator
direction={sortDirection}
/>
)}
</>
)}
</Column>The states and selectors for each component used in a Table are documented below.
Table#
A Table can be targeted with the .react-aria-Table CSS selector, or by overriding with a custom className. It supports the following states and render props:
| Name | CSS Selector | Description |
isFocused | [data-focused] | Whether the table is currently focused. |
isFocusVisible | [data-focus-visible] | Whether the table is currently keyboard focused. |
isDropTarget | [data-drop-target] | Whether the table is currently the active drop target. |
TableHeader#
A TableHeader can be targeted with the .react-aria-TableHeader CSS selector, or by overriding with a custom className.
Column#
A Column can be targeted with the .react-aria-Column CSS selector, or by overriding with a custom className. It supports the following states and render props:
| Name | CSS Selector | Description |
isFocused | [data-focused] | Whether the item is currently focused. |
isFocusVisible | [data-focus-visible] | Whether the item is currently keyboard focused. |
allowsSorting | [aria-sort] | Whether the column allows sorting. |
TableBody#
A TableBody can be targeted with the .react-aria-TableBody CSS selector, or by overriding with a custom className.
Row#
A Row can be targeted with the .react-aria-Row CSS selector, or by overriding with a custom className. It supports the following states and render props:
| Name | CSS Selector | Description |
isHovered | [data-hovered] | Whether the item is currently hovered with a mouse. |
isPressed | [data-pressed] | Whether the item is currently in a pressed state. |
isSelected | [aria-selected=true] | Whether the item is currently selected. |
isFocused | [data-focused] | Whether the item is currently focused. |
isFocusVisible | [data-focus-visible] | Whether the item is currently keyboard focused. |
isDisabled | [aria-disabled] | Whether the item is non-interactive, i.e. both selection and actions are disabled and the item may
not be focused. Dependent on |
selectionMode | — | The type of selection that is allowed in the collection. |
selectionBehavior | — | The selection behavior for the collection. |
Cell#
A Cell can be targeted with the .react-aria-Cell CSS selector, or by overriding with a custom className. It supports the following states and render props:
| Name | CSS Selector | Description |
isPressed | [data-pressed] | Whether the cell is currently in a pressed state. |
isFocused | [data-focused] | Whether the cell is currently focused. |
isFocusVisible | [data-focus-visible] | Whether the cell is currently keyboard focused. |
Reusable wrappers#
If you will use a Table in multiple places in your app, you can wrap all of the pieces into a reusable component. This way, the DOM structure, styling code, and other logic are defined in a single place and reused everywhere to ensure consistency.
The following example includes a custom Column component with a sort indicator. It displays an upwards facing arrow when the column is sorted in the ascending direction, and a downward facing arrow otherwise.
import type {ColumnProps} from 'react-aria-components';
function MyColumn<T extends object>(props: ColumnProps<T>) {
return (
<Column {...props}>
{({allowsSorting, sortDirection}) => <>
{props.children}
{allowsSorting && (
<span aria-hidden="true" className="sort-indicator">
{sortDirection === 'ascending' ? '▲' : '▼'}
</span>
)}
</>}
</Column>
);
}import type {ColumnProps} from 'react-aria-components';
function MyColumn<T extends object>(props: ColumnProps<T>) {
return (
<Column {...props}>
{({ allowsSorting, sortDirection }) => (
<>
{props.children}
{allowsSorting && (
<span
aria-hidden="true"
className="sort-indicator"
>
{sortDirection === 'ascending' ? '▲' : '▼'}
</span>
)}
</>
)}
</Column>
);
}
import type {ColumnProps} from 'react-aria-components';
function MyColumn<
T extends object
>(
props: ColumnProps<T>
) {
return (
<Column {...props}>
{(
{
allowsSorting,
sortDirection
}
) => (
<>
{props
.children}
{allowsSorting &&
(
<span
aria-hidden="true"
className="sort-indicator"
>
{sortDirection ===
'ascending'
? '▲'
: '▼'}
</span>
)}
</>
)}
</Column>
);
}
The TableHeader and Row components can also be wrapped to automatically include checkboxes for selection, and a drag handle when drag and drop is enabled, allowing consumers to avoid repeating them in each row. In this example, the select all checkbox is displayed when multiple selection is enabled and the selection behavior is "toggle". These options can be retrieved from the table using the useTableOptions hook. We also use the Collection component to generate children from either static or dynamic collections the same way as the default TableHeader and Row components.
import type {RowProps, TableHeaderProps} from 'react-aria-components';
import {Checkbox, Collection, useTableOptions} from 'react-aria-components';
function MyTableHeader<T extends object>(
{ columns, children }: TableHeaderProps<T>
) {
let { selectionBehavior, selectionMode, allowsDragging } = useTableOptions();
return (
<TableHeader>
{/* Add extra columns for drag and drop and selection. */}
{allowsDragging && <Column />}
{selectionBehavior === 'toggle' && (
<Column>{selectionMode === 'multiple' && <MyCheckbox />}</Column>
)}
<Collection items={columns}>
{children}
</Collection>
</TableHeader>
);
}
function MyRow<T extends object>({ id, columns, children }: RowProps<T>) {
let { selectionBehavior, allowsDragging } = useTableOptions();
return (
<Row id={id}>
{allowsDragging && (
<Cell>
<Button slot="drag">≡</Button>
</Cell>
)}
{selectionBehavior === 'toggle' && (
<Cell>
<MyCheckbox />
</Cell>
)}
<Collection items={columns}>
{children}
</Collection>
</Row>
);
}
function MyCheckbox() {
return (
<Checkbox slot="selection">
{({ isIndeterminate }) => (
<svg viewBox="0 0 18 18" aria-hidden="true">
{isIndeterminate
? <rect x={1} y={7.5} width={15} height={3} />
: <polyline points="1 9 7 14 15 4" />}
</svg>
)}
</Checkbox>
);
}
import type {
RowProps,
TableHeaderProps
} from 'react-aria-components';
import {
Checkbox,
Collection,
useTableOptions
} from 'react-aria-components';
function MyTableHeader<T extends object>(
{ columns, children }: TableHeaderProps<T>
) {
let { selectionBehavior, selectionMode, allowsDragging } =
useTableOptions();
return (
<TableHeader>
{/* Add extra columns for drag and drop and selection. */}
{allowsDragging && <Column />}
{selectionBehavior === 'toggle' && (
<Column>
{selectionMode === 'multiple' && <MyCheckbox />}
</Column>
)}
<Collection items={columns}>
{children}
</Collection>
</TableHeader>
);
}
function MyRow<T extends object>(
{ id, columns, children }: RowProps<T>
) {
let { selectionBehavior, allowsDragging } =
useTableOptions();
return (
<Row id={id}>
{allowsDragging && (
<Cell>
<Button slot="drag">≡</Button>
</Cell>
)}
{selectionBehavior === 'toggle' && (
<Cell>
<MyCheckbox />
</Cell>
)}
<Collection items={columns}>
{children}
</Collection>
</Row>
);
}
function MyCheckbox() {
return (
<Checkbox slot="selection">
{({ isIndeterminate }) => (
<svg viewBox="0 0 18 18" aria-hidden="true">
{isIndeterminate
? <rect x={1} y={7.5} width={15} height={3} />
: <polyline points="1 9 7 14 15 4" />}
</svg>
)}
</Checkbox>
);
}
import type {
RowProps,
TableHeaderProps
} from 'react-aria-components';
import {
Checkbox,
Collection,
useTableOptions
} from 'react-aria-components';
function MyTableHeader<
T extends object
>(
{ columns, children }:
TableHeaderProps<T>
) {
let {
selectionBehavior,
selectionMode,
allowsDragging
} = useTableOptions();
return (
<TableHeader>
{/* Add extra columns for drag and drop and selection. */}
{allowsDragging &&
<Column />}
{selectionBehavior ===
'toggle' && (
<Column>
{selectionMode ===
'multiple' &&
(
<MyCheckbox />
)}
</Column>
)}
<Collection
items={columns}
>
{children}
</Collection>
</TableHeader>
);
}
function MyRow<
T extends object
>(
{
id,
columns,
children
}: RowProps<T>
) {
let {
selectionBehavior,
allowsDragging
} = useTableOptions();
return (
<Row id={id}>
{allowsDragging &&
(
<Cell>
<Button slot="drag">
≡
</Button>
</Cell>
)}
{selectionBehavior ===
'toggle' && (
<Cell>
<MyCheckbox />
</Cell>
)}
<Collection
items={columns}
>
{children}
</Collection>
</Row>
);
}
function MyCheckbox() {
return (
<Checkbox slot="selection">
{(
{
isIndeterminate
}
) => (
<svg
viewBox="0 0 18 18"
aria-hidden="true"
>
{isIndeterminate
? (
<rect
x={1}
y={7.5}
width={15}
height={3}
/>
)
: (
<polyline points="1 9 7 14 15 4" />
)}
</svg>
)}
</Checkbox>
);
}
Now we can render a table with a default selection column built in.
<Table aria-label="Files" selectionMode="multiple">
<MyTableHeader>
<MyColumn isRowHeader>Name</MyColumn>
<MyColumn>Type</MyColumn>
<MyColumn>Date Modified</MyColumn>
</MyTableHeader>
<TableBody>
<MyRow>
<Cell>Games</Cell>
<Cell>File folder</Cell>
<Cell>6/7/2020</Cell>
</MyRow>
<MyRow>
<Cell>Program Files</Cell>
<Cell>File folder</Cell>
<Cell>4/7/2021</Cell>
</MyRow>
<MyRow>
<Cell>bootmgr</Cell>
<Cell>System file</Cell>
<Cell>11/20/2010</Cell>
</MyRow>
</TableBody>
</Table><Table aria-label="Files" selectionMode="multiple">
<MyTableHeader>
<MyColumn isRowHeader>Name</MyColumn>
<MyColumn>Type</MyColumn>
<MyColumn>Date Modified</MyColumn>
</MyTableHeader>
<TableBody>
<MyRow>
<Cell>Games</Cell>
<Cell>File folder</Cell>
<Cell>6/7/2020</Cell>
</MyRow>
<MyRow>
<Cell>Program Files</Cell>
<Cell>File folder</Cell>
<Cell>4/7/2021</Cell>
</MyRow>
<MyRow>
<Cell>bootmgr</Cell>
<Cell>System file</Cell>
<Cell>11/20/2010</Cell>
</MyRow>
</TableBody>
</Table><Table
aria-label="Files"
selectionMode="multiple"
>
<MyTableHeader>
<MyColumn
isRowHeader
>
Name
</MyColumn>
<MyColumn>
Type
</MyColumn>
<MyColumn>
Date Modified
</MyColumn>
</MyTableHeader>
<TableBody>
<MyRow>
<Cell>
Games
</Cell>
<Cell>
File folder
</Cell>
<Cell>
6/7/2020
</Cell>
</MyRow>
<MyRow>
<Cell>
Program Files
</Cell>
<Cell>
File folder
</Cell>
<Cell>
4/7/2021
</Cell>
</MyRow>
<MyRow>
<Cell>
bootmgr
</Cell>
<Cell>
System file
</Cell>
<Cell>
11/20/2010
</Cell>
</MyRow>
</TableBody>
</Table>Usage#
Dynamic collections#
So far, our examples have shown static collections, where the data is hard coded. Dynamic collections, as shown below, can be used when the table data comes from an external data source such as an API, or updates over time. In the example below, both the columns and the rows are provided to the table via a render function. You can also make the columns static and only the rows dynamic.
import type {TableProps} from 'react-aria-components';
function FileTable(props: TableProps) {
let columns = [
{name: 'Name', key: 'name', isRowHeader: true},
{name: 'Type', key: 'type'},
{name: 'Date Modified', key: 'date'}
];
let rows = [
{id: 1, name: 'Games', date: '6/7/2020', type: 'File folder'},
{id: 2, name: 'Program Files', date: '4/7/2021', type: 'File folder'},
{id: 3, name: 'bootmgr', date: '11/20/2010', type: 'System file'},
{id: 4, name: 'log.txt', date: '1/18/2016', type: 'Text Document'}
];
return (
<Table aria-label="Files" {...props}>
<MyTableHeader columns={columns}>
{column => (
<Column isRowHeader={column.isRowHeader}>
{column.name}
</Column>
)}
</MyTableHeader>
<TableBody items={rows}>
{item => (
<MyRow columns={columns}>
{column => <Cell>{item[column.key]}</Cell>}
</MyRow>
)}
</TableBody>
</Table>
);
}import type {TableProps} from 'react-aria-components';
function FileTable(props: TableProps) {
let columns = [
{ name: 'Name', key: 'name', isRowHeader: true },
{ name: 'Type', key: 'type' },
{ name: 'Date Modified', key: 'date' }
];
let rows = [
{
id: 1,
name: 'Games',
date: '6/7/2020',
type: 'File folder'
},
{
id: 2,
name: 'Program Files',
date: '4/7/2021',
type: 'File folder'
},
{
id: 3,
name: 'bootmgr',
date: '11/20/2010',
type: 'System file'
},
{
id: 4,
name: 'log.txt',
date: '1/18/2016',
type: 'Text Document'
}
];
return (
<Table aria-label="Files" {...props}>
<MyTableHeader columns={columns}>
{(column) => (
<Column isRowHeader={column.isRowHeader}>
{column.name}
</Column>
)}
</MyTableHeader>
<TableBody items={rows}>
{(item) => (
<MyRow columns={columns}>
{(column) => <Cell>{item[column.key]}</Cell>}
</MyRow>
)}
</TableBody>
</Table>
);
}
import type {TableProps} from 'react-aria-components';
function FileTable(
props: TableProps
) {
let columns = [
{
name: 'Name',
key: 'name',
isRowHeader: true
},
{
name: 'Type',
key: 'type'
},
{
name:
'Date Modified',
key: 'date'
}
];
let rows = [
{
id: 1,
name: 'Games',
date: '6/7/2020',
type: 'File folder'
},
{
id: 2,
name:
'Program Files',
date: '4/7/2021',
type: 'File folder'
},
{
id: 3,
name: 'bootmgr',
date: '11/20/2010',
type: 'System file'
},
{
id: 4,
name: 'log.txt',
date: '1/18/2016',
type:
'Text Document'
}
];
return (
<Table
aria-label="Files"
{...props}
>
<MyTableHeader
columns={columns}
>
{(column) => (
<Column
isRowHeader={column
.isRowHeader}
>
{column.name}
</Column>
)}
</MyTableHeader>
<TableBody
items={rows}
>
{(item) => (
<MyRow
columns={columns}
>
{(column) => (
<Cell>
{item[
column
.key
]}
</Cell>
)}
</MyRow>
)}
</TableBody>
</Table>
);
}
Single selection#
By default, useTableState doesn't allow row selection but this can be enabled using the selectionMode prop. Use defaultSelectedKeys to provide a default set of selected rows.
Note that the value of the selected keys must match the key prop of the row.
The example below enables single selection mode, and uses defaultSelectedKeys to select the row with key equal to "2".
A user can click on a different row to change the selection, or click on the same row again to deselect it entirely.
// Using the example above
<FileTable selectionMode="single" defaultSelectedKeys={[2]} />// Using the example above
<FileTable
selectionMode="single"
defaultSelectedKeys={[2]}
/>// Using the example above
<FileTable
selectionMode="single"
defaultSelectedKeys={[
2
]}
/>Multiple selection#
Multiple selection can be enabled by setting selectionMode to multiple.
// Using the example above
<FileTable selectionMode="multiple" defaultSelectedKeys={[2, 4]} />// Using the example above
<FileTable
selectionMode="multiple"
defaultSelectedKeys={[2, 4]}
/>// Using the example above
<FileTable
selectionMode="multiple"
defaultSelectedKeys={[
2,
4
]}
/>Disallow empty selection#
Table also supports a disallowEmptySelection prop which forces the user to have at least one row in the Table selected at all times.
In this mode, if a single row is selected and the user presses it, it will not be deselected.
// Using the example above
<FileTable
selectionMode="single"
defaultSelectedKeys={[2]}
disallowEmptySelection
/>// Using the example above
<FileTable
selectionMode="single"
defaultSelectedKeys={[2]}
disallowEmptySelection
/>// Using the example above
<FileTable
selectionMode="single"
defaultSelectedKeys={[
2
]}
disallowEmptySelection
/>Controlled selection#
To programmatically control row selection, use the selectedKeys prop paired with the onSelectionChange callback. The key prop from the selected rows will
be passed into the callback when the row is pressed, allowing you to update state accordingly.
import type {Selection} from 'react-aria-components';
interface Pokemon {
id: number,
name: string,
type: string,
level: string
}
interface PokemonTableProps extends TableProps {
items?: Pokemon[],
renderEmptyState?: () => string
}
function PokemonTable(props: PokemonTableProps) {
let items = props.items || [
{id: 1, name: 'Charizard', type: 'Fire, Flying', level: '67'},
{id: 2, name: 'Blastoise', type: 'Water', level: '56'},
{id: 3, name: 'Venusaur', type: 'Grass, Poison', level: '83'},
{id: 4, name: 'Pikachu', type: 'Electric', level: '100'}
];
let [selectedKeys, setSelectedKeys] = React.useState<Selection>(new Set());
return (
<Table
aria-label="Pokemon table"
{...props}
selectedKeys={selectedKeys}
onSelectionChange={setSelectedKeys} >
<MyTableHeader>
<Column isRowHeader>Name</Column>
<Column>Type</Column>
<Column>Level</Column>
</MyTableHeader>
<TableBody items={items} renderEmptyState={props.renderEmptyState}>
{item => (
<MyRow>
<Cell>{item.name}</Cell>
<Cell>{item.type}</Cell>
<Cell>{item.level}</Cell>
</MyRow>
)}
</TableBody>
</Table>
);
}
<PokemonTable selectionMode="multiple" />import type {Selection} from 'react-aria-components';
interface Pokemon {
id: number;
name: string;
type: string;
level: string;
}
interface PokemonTableProps extends TableProps {
items?: Pokemon[];
renderEmptyState?: () => string;
}
function PokemonTable(props: PokemonTableProps) {
let items = props.items || [
{
id: 1,
name: 'Charizard',
type: 'Fire, Flying',
level: '67'
},
{
id: 2,
name: 'Blastoise',
type: 'Water',
level: '56'
},
{
id: 3,
name: 'Venusaur',
type: 'Grass, Poison',
level: '83'
},
{
id: 4,
name: 'Pikachu',
type: 'Electric',
level: '100'
}
];
let [selectedKeys, setSelectedKeys] = React.useState<
Selection
>(new Set());
return (
<Table
aria-label="Pokemon table"
{...props}
selectedKeys={selectedKeys}
onSelectionChange={setSelectedKeys} >
<MyTableHeader>
<Column isRowHeader>Name</Column>
<Column>Type</Column>
<Column>Level</Column>
</MyTableHeader>
<TableBody
items={items}
renderEmptyState={props.renderEmptyState}
>
{(item) => (
<MyRow>
<Cell>{item.name}</Cell>
<Cell>{item.type}</Cell>
<Cell>{item.level}</Cell>
</MyRow>
)}
</TableBody>
</Table>
);
}
<PokemonTable selectionMode="multiple" />import type {Selection} from 'react-aria-components';
interface Pokemon {
id: number;
name: string;
type: string;
level: string;
}
interface PokemonTableProps
extends TableProps {
items?: Pokemon[];
renderEmptyState?:
() => string;
}
function PokemonTable(
props:
PokemonTableProps
) {
let items =
props.items || [
{
id: 1,
name:
'Charizard',
type:
'Fire, Flying',
level: '67'
},
{
id: 2,
name:
'Blastoise',
type: 'Water',
level: '56'
},
{
id: 3,
name: 'Venusaur',
type:
'Grass, Poison',
level: '83'
},
{
id: 4,
name: 'Pikachu',
type: 'Electric',
level: '100'
}
];
let [
selectedKeys,
setSelectedKeys
] = React.useState<
Selection
>(new Set());
return (
<Table
aria-label="Pokemon table"
{...props}
selectedKeys={selectedKeys}
onSelectionChange={setSelectedKeys} >
<MyTableHeader>
<Column
isRowHeader
>
Name
</Column>
<Column>
Type
</Column>
<Column>
Level
</Column>
</MyTableHeader>
<TableBody
items={items}
renderEmptyState={props
.renderEmptyState}
>
{(item) => (
<MyRow>
<Cell>
{item.name}
</Cell>
<Cell>
{item.type}
</Cell>
<Cell>
{item
.level}
</Cell>
</MyRow>
)}
</TableBody>
</Table>
);
}
<PokemonTable selectionMode="multiple" />Disabled rows#
You can disable specific rows by providing an array of keys to useTableState via the disabledKeys prop. This will prevent rows from being selectable as shown in the example below.
Note that you are responsible for the styling of disabled rows, however, the selection checkbox will be automatically disabled.
// Using the same table as above
<PokemonTable selectionMode="multiple" disabledKeys={[3]} />// Using the same table as above
<PokemonTable selectionMode="multiple" disabledKeys={[3]} />// Using the same table as above
<PokemonTable
selectionMode="multiple"
disabledKeys={[3]}
/>By default, only row selection is disabled. When disabledBehavior is set to all, all interactions such as focus, dragging, and actions are also disabled.
<PokemonTable
selectionMode="multiple"
disabledKeys={[3]}
disabledBehavior="all"
/><PokemonTable
selectionMode="multiple"
disabledKeys={[3]}
disabledBehavior="all"
/><PokemonTable
selectionMode="multiple"
disabledKeys={[3]}
disabledBehavior="all"
/>Selection behavior#
By default, useTable uses the "toggle" selection behavior, which behaves like a checkbox group: clicking, tapping, or pressing the Space or Enter keys toggles selection for the focused row. Using the arrow keys moves focus but does not change selection. The "toggle" selection mode is often paired with a column of checkboxes in each row as an explicit affordance for selection.
When the selectionBehavior prop is set to "replace", clicking a row with the mouse replaces the selection with only that row. Using the arrow keys moves both focus and selection. To select multiple rows, modifier keys such as Ctrl, Cmd, and Shift can be used. To move focus without moving selection, the Ctrl key on Windows or the Option key on macOS can be held while pressing the arrow keys. Holding this modifier while pressing the Space key toggles selection for the focused row, which allows multiple selection of non-contiguous items. On touch screen devices, selection always behaves as toggle since modifier keys may not be available. This behavior emulates native platforms such as macOS and Windows, and is often used when checkboxes in each row are not desired.
<PokemonTable selectionMode="multiple" selectionBehavior="replace" /><PokemonTable
selectionMode="multiple"
selectionBehavior="replace"
/><PokemonTable
selectionMode="multiple"
selectionBehavior="replace"
/>Row actions#
useTable supports row actions via the onRowAction prop, which is useful for functionality such as navigation. In the default "toggle" selection behavior, when nothing is selected, clicking or tapping the row triggers the row action.
When at least one item is selected, the table is in selection mode, and clicking or tapping a row toggles the selection. Actions may also be triggered via the Enter key, and selection using the Space key.
This behavior is slightly different in the "replace" selection behavior, where single clicking selects the row and actions are performed via double click. On touch devices, the action becomes the primary tap interaction,
and a long press enters into selection mode, which temporarily swaps the selection behavior to "toggle" to perform selection (you may wish to display checkboxes when this happens). Deselecting all items exits selection mode
and reverts the selection behavior back to "replace". Keyboard behaviors are unaffected.
<div style={{display: 'flex', flexWrap: 'wrap', gap: '24px'}}>
<PokemonTable
aria-label="Pokemon table with row actions and toggle selection behavior"
onRowAction={key => alert(`Opening item ...`)} selectionMode="multiple" />
<PokemonTable
aria-label="Pokemon table with row actions and replace selection behavior"
onRowAction={key => alert(`Opening item ...`)}
selectionBehavior="replace" selectionMode="multiple" />
</div><div
style={{
display: 'flex',
flexWrap: 'wrap',
gap: '24px'
}}
>
<PokemonTable
aria-label="Pokemon table with row actions and toggle selection behavior"
onRowAction={(key) => alert(`Opening item ...`)} selectionMode="multiple"
/>
<PokemonTable
aria-label="Pokemon table with row actions and replace selection behavior"
onRowAction={(key) => alert(`Opening item ...`)}
selectionBehavior="replace" selectionMode="multiple"
/>
</div><div
style={{
display: 'flex',
flexWrap: 'wrap',
gap: '24px'
}}
>
<PokemonTable
aria-label="Pokemon table with row actions and toggle selection behavior"
onRowAction={(key) =>
alert(
`Opening item ...`
)} selectionMode="multiple"
/>
<PokemonTable
aria-label="Pokemon table with row actions and replace selection behavior"
onRowAction={(key) =>
alert(
`Opening item ...`
)}
selectionBehavior="replace" selectionMode="multiple"
/>
</div>Sorting#
Table supports sorting its data when a column header is pressed. To designate that a Column should support sorting, provide it with
the allowsSorting prop. The Table accepts a sortDescriptor prop that defines the current column key to sort by and the sort direction (ascending/descending).
When the user presses a sortable column header, the column's key and sort direction is passed into the onSortChange callback, allowing you to update
the sortDescriptor appropriately.
This example performs client side sorting by passing a sort function to the useAsyncList hook.
See the docs for more information on how to perform server side sorting.
import {useAsyncList} from '@react-stately/data';
interface Character {
name: string;
height: number;
mass: number;
birth_year: number;
}
function AsyncSortTable() {
let list = useAsyncList<Character>({
async load({ signal }) {
let res = await fetch(`https://swapi.py4e.com/api/people/?search`, {
signal
});
let json = await res.json();
return {
items: json.results
};
},
async sort({ items, sortDescriptor }) {
return {
items: items.sort((a, b) => {
let first = a[sortDescriptor.column];
let second = b[sortDescriptor.column];
let cmp = (parseInt(first) || first) < (parseInt(second) || second)
? -1
: 1;
if (sortDescriptor.direction === 'descending') {
cmp *= -1;
}
return cmp;
})
};
}
});
return (
<Table
aria-label="Example table with client side sorting"
sortDescriptor={list.sortDescriptor}
onSortChange={list.sort}
>
<TableHeader>
<MyColumn id="name" isRowHeader allowsSorting>Name</MyColumn>
<MyColumn id="height" allowsSorting>Height</MyColumn>
<MyColumn id="mass" allowsSorting>Mass</MyColumn>
<MyColumn id="birth_year" allowsSorting>Birth Year</MyColumn>
</TableHeader>
<TableBody items={list.items}>
{(item) => (
<Row id={item.name}>
<Cell>{item.name}</Cell>
<Cell>{item.height}</Cell>
<Cell>{item.mass}</Cell>
<Cell>{item.birth_year}</Cell>
</Row>
)}
</TableBody>
</Table>
);
}
import {useAsyncList} from '@react-stately/data';
interface Character {
name: string;
height: number;
mass: number;
birth_year: number;
}
function AsyncSortTable() {
let list = useAsyncList<Character>({
async load({ signal }) {
let res = await fetch(
`https://swapi.py4e.com/api/people/?search`,
{ signal }
);
let json = await res.json();
return {
items: json.results
};
},
async sort({ items, sortDescriptor }) {
return {
items: items.sort((a, b) => {
let first = a[sortDescriptor.column];
let second = b[sortDescriptor.column];
let cmp =
(parseInt(first) || first) <
(parseInt(second) || second)
? -1
: 1;
if (sortDescriptor.direction === 'descending') {
cmp *= -1;
}
return cmp;
})
};
}
});
return (
<Table
aria-label="Example table with client side sorting"
sortDescriptor={list.sortDescriptor}
onSortChange={list.sort}
>
<TableHeader>
<MyColumn id="name" isRowHeader allowsSorting>
Name
</MyColumn>
<MyColumn id="height" allowsSorting>
Height
</MyColumn>
<MyColumn id="mass" allowsSorting>Mass</MyColumn>
<MyColumn id="birth_year" allowsSorting>
Birth Year
</MyColumn>
</TableHeader>
<TableBody items={list.items}>
{(item) => (
<Row id={item.name}>
<Cell>{item.name}</Cell>
<Cell>{item.height}</Cell>
<Cell>{item.mass}</Cell>
<Cell>{item.birth_year}</Cell>
</Row>
)}
</TableBody>
</Table>
);
}
import {useAsyncList} from '@react-stately/data';
interface Character {
name: string;
height: number;
mass: number;
birth_year: number;
}
function AsyncSortTable() {
let list =
useAsyncList<
Character
>({
async load(
{ signal }
) {
let res =
await fetch(
`https://swapi.py4e.com/api/people/?search`,
{ signal }
);
let json =
await res
.json();
return {
items:
json.results
};
},
async sort(
{
items,
sortDescriptor
}
) {
return {
items: items
.sort(
(a, b) => {
let first =
a[
sortDescriptor
.column
];
let second =
b[
sortDescriptor
.column
];
let cmp =
(parseInt(
first
) ||
first) <
(parseInt(
second
) ||
second)
? -1
: 1;
if (
sortDescriptor
.direction ===
'descending'
) {
cmp *=
-1;
}
return cmp;
}
)
};
}
});
return (
<Table
aria-label="Example table with client side sorting"
sortDescriptor={list
.sortDescriptor}
onSortChange={list
.sort}
>
<TableHeader>
<MyColumn
id="name"
isRowHeader
allowsSorting
>
Name
</MyColumn>
<MyColumn
id="height"
allowsSorting
>
Height
</MyColumn>
<MyColumn
id="mass"
allowsSorting
>
Mass
</MyColumn>
<MyColumn
id="birth_year"
allowsSorting
>
Birth Year
</MyColumn>
</TableHeader>
<TableBody
items={list
.items}
>
{(item) => (
<Row
id={item
.name}
>
<Cell>
{item.name}
</Cell>
<Cell>
{item
.height}
</Cell>
<Cell>
{item.mass}
</Cell>
<Cell>
{item
.birth_year}
</Cell>
</Row>
)}
</TableBody>
</Table>
);
}
Nested columns#
Columns can be nested to create column groups. This will result in more than one header row to be created, with the colspan
attribute of each column header cell set to the appropriate value so that the columns line up. Data for the leaf columns
appears in each row of the table body.
This example also shows the use of the isRowHeader prop for Column, which controls which columns are included in the
accessibility name for each row. By default, only the first column is included, but in some cases more than one column may
be used to represent the row. In this example, the first and last name columns are combined to form the ARIA label for the row.
Only leaf columns may be marked as row headers.
<Table aria-label="Example table with nested columns">
<TableHeader>
<Column title="Name">
<Column isRowHeader>First Name</Column>
<Column isRowHeader>Last Name</Column>
</Column>
<Column title="Information">
<Column>Age</Column>
<Column>Birthday</Column>
</Column>
</TableHeader>
<TableBody>
<Row>
<Cell>Sam</Cell>
<Cell>Smith</Cell>
<Cell>36</Cell>
<Cell>May 3</Cell>
</Row>
<Row>
<Cell>Julia</Cell>
<Cell>Jones</Cell>
<Cell>24</Cell>
<Cell>February 10</Cell>
</Row>
<Row>
<Cell>Peter</Cell>
<Cell>Parker</Cell>
<Cell>28</Cell>
<Cell>September 7</Cell>
</Row>
<Row>
<Cell>Bruce</Cell>
<Cell>Wayne</Cell>
<Cell>32</Cell>
<Cell>December 18</Cell>
</Row>
</TableBody>
</Table><Table aria-label="Example table with nested columns">
<TableHeader>
<Column title="Name">
<Column isRowHeader>First Name</Column>
<Column isRowHeader>Last Name</Column>
</Column>
<Column title="Information">
<Column>Age</Column>
<Column>Birthday</Column>
</Column>
</TableHeader>
<TableBody>
<Row>
<Cell>Sam</Cell>
<Cell>Smith</Cell>
<Cell>36</Cell>
<Cell>May 3</Cell>
</Row>
<Row>
<Cell>Julia</Cell>
<Cell>Jones</Cell>
<Cell>24</Cell>
<Cell>February 10</Cell>
</Row>
<Row>
<Cell>Peter</Cell>
<Cell>Parker</Cell>
<Cell>28</Cell>
<Cell>September 7</Cell>
</Row>
<Row>
<Cell>Bruce</Cell>
<Cell>Wayne</Cell>
<Cell>32</Cell>
<Cell>December 18</Cell>
</Row>
</TableBody>
</Table><Table aria-label="Example table with nested columns">
<TableHeader>
<Column title="Name">
<Column
isRowHeader
>
First Name
</Column>
<Column
isRowHeader
>
Last Name
</Column>
</Column>
<Column title="Information">
<Column>
Age
</Column>
<Column>
Birthday
</Column>
</Column>
</TableHeader>
<TableBody>
<Row>
<Cell>Sam</Cell>
<Cell>
Smith
</Cell>
<Cell>36</Cell>
<Cell>
May 3
</Cell>
</Row>
<Row>
<Cell>
Julia
</Cell>
<Cell>
Jones
</Cell>
<Cell>24</Cell>
<Cell>
February 10
</Cell>
</Row>
<Row>
<Cell>
Peter
</Cell>
<Cell>
Parker
</Cell>
<Cell>28</Cell>
<Cell>
September 7
</Cell>
</Row>
<Row>
<Cell>
Bruce
</Cell>
<Cell>
Wayne
</Cell>
<Cell>32</Cell>
<Cell>
December 18
</Cell>
</Row>
</TableBody>
</Table>Dynamic nested columns#
Nested columns can also be defined dynamically using the function syntax and the childColumns prop.
The following example is the same as the example above, but defined dynamically.
interface ColumnDefinition {
name: string,
key: string,
children?: ColumnDefinition[],
isRowHeader?: boolean
}
let columns: ColumnDefinition[] = [
{name: 'Name', key: 'name', children: [
{name: 'First Name', key: 'first', isRowHeader: true},
{name: 'Last Name', key: 'last', isRowHeader: true}
]},
{name: 'Information', key: 'info', children: [
{name: 'Age', key: 'age'},
{name: 'Birthday', key: 'birthday'}
]}
];
let rows = [
{id: 1, first: 'Sam', last: 'Smith', age: 36, birthday: 'May 3'},
{id: 2, first: 'Julia', last: 'Jones', age: 24, birthday: 'February 10'},
{id: 3, first: 'Peter', last: 'Parker', age: 28, birthday: 'September 7'},
{id: 4, first: 'Bruce', last: 'Wayne', age: 32, birthday: 'December 18'}
];
<Table aria-label="Example table with dynamic nested columns">
<TableHeader columns={columns}>
{column => (
<Column isRowHeader={column.isRowHeader} childColumns={column.children}>
{column.name}
</Column>
)}
</TableHeader>
<TableBody items={rows}>
{item => (
<Row>
<Cell>{item.first}</Cell>
<Cell>{item.last}</Cell>
<Cell>{item.age}</Cell>
<Cell>{item.birthday}</Cell>
</Row>
)}
</TableBody>
</Table>interface ColumnDefinition {
name: string;
key: string;
children?: ColumnDefinition[];
isRowHeader?: boolean;
}
let columns: ColumnDefinition[] = [
{
name: 'Name',
key: 'name',
children: [
{
name: 'First Name',
key: 'first',
isRowHeader: true
},
{ name: 'Last Name', key: 'last', isRowHeader: true }
]
},
{
name: 'Information',
key: 'info',
children: [
{ name: 'Age', key: 'age' },
{ name: 'Birthday', key: 'birthday' }
]
}
];
let rows = [
{
id: 1,
first: 'Sam',
last: 'Smith',
age: 36,
birthday: 'May 3'
},
{
id: 2,
first: 'Julia',
last: 'Jones',
age: 24,
birthday: 'February 10'
},
{
id: 3,
first: 'Peter',
last: 'Parker',
age: 28,
birthday: 'September 7'
},
{
id: 4,
first: 'Bruce',
last: 'Wayne',
age: 32,
birthday: 'December 18'
}
];
<Table aria-label="Example table with dynamic nested columns">
<TableHeader columns={columns}>
{(column) => (
<Column
isRowHeader={column.isRowHeader}
childColumns={column.children}
>
{column.name}
</Column>
)}
</TableHeader>
<TableBody items={rows}>
{(item) => (
<Row>
<Cell>{item.first}</Cell>
<Cell>{item.last}</Cell>
<Cell>{item.age}</Cell>
<Cell>{item.birthday}</Cell>
</Row>
)}
</TableBody>
</Table>interface ColumnDefinition {
name: string;
key: string;
children?:
ColumnDefinition[];
isRowHeader?: boolean;
}
let columns:
ColumnDefinition[] = [
{
name: 'Name',
key: 'name',
children: [
{
name:
'First Name',
key: 'first',
isRowHeader:
true
},
{
name:
'Last Name',
key: 'last',
isRowHeader:
true
}
]
},
{
name:
'Information',
key: 'info',
children: [
{
name: 'Age',
key: 'age'
},
{
name:
'Birthday',
key: 'birthday'
}
]
}
];
let rows = [
{
id: 1,
first: 'Sam',
last: 'Smith',
age: 36,
birthday: 'May 3'
},
{
id: 2,
first: 'Julia',
last: 'Jones',
age: 24,
birthday:
'February 10'
},
{
id: 3,
first: 'Peter',
last: 'Parker',
age: 28,
birthday:
'September 7'
},
{
id: 4,
first: 'Bruce',
last: 'Wayne',
age: 32,
birthday:
'December 18'
}
];
<Table aria-label="Example table with dynamic nested columns">
<TableHeader
columns={columns}
>
{(column) => (
<Column
isRowHeader={column
.isRowHeader}
childColumns={column
.children}
>
{column.name}
</Column>
)}
</TableHeader>
<TableBody
items={rows}
>
{(item) => (
<Row>
<Cell>
{item.first}
</Cell>
<Cell>
{item.last}
</Cell>
<Cell>
{item.age}
</Cell>
<Cell>
{item
.birthday}
</Cell>
</Row>
)}
</TableBody>
</Table>Empty state#
Use the renderEmptyState prop to customize what the TableBody will display if there are no items.
<Table aria-label="Search results">
<TableHeader>
<Column isRowHeader>Name</Column>
<Column>Type</Column>
<Column>Date Modified</Column>
</TableHeader>
<TableBody renderEmptyState={() => 'No results found.'}>
{[]}
</TableBody>
</Table><Table aria-label="Search results">
<TableHeader>
<Column isRowHeader>Name</Column>
<Column>Type</Column>
<Column>Date Modified</Column>
</TableHeader>
<TableBody renderEmptyState={() => 'No results found.'}>
{[]}
</TableBody>
</Table><Table aria-label="Search results">
<TableHeader>
<Column
isRowHeader
>
Name
</Column>
<Column>
Type
</Column>
<Column>
Date Modified
</Column>
</TableHeader>
<TableBody
renderEmptyState={() =>
'No results found.'}
>
{[]}
</TableBody>
</Table>Drag and drop#
Table supports drag and drop interactions when the dragAndDropHooks prop is provided using the useDragAndDrop hook. Users can drop data on the table as a whole, on individual rows, insert new items between existing rows, or reorder rows.
React Aria supports traditional mouse and touch based drag and drop, but also implements keyboard and screen reader friendly interactions. Users can press Enter on a draggable element to enter drag and drop mode. Then, they can press Tab to navigate between drop targets. A table is treated as a single drop target, so that users can easily tab past it to get to the next drop target. Within a table, keys such as ArrowDown and ArrowUp can be used to select a drop position, such as on an row, or between rows.
Draggable rows must include a focusable drag handle using a <Button slot="drag">. This enables keyboard and screen reader users to initiate drag and drop. The MyRow component defined in the reusable wrappers section above includes this as an extra column automatically when the table allows dragging.
See the drag and drop introduction to learn more.
Reorderable#
This example shows a basic table that allows users to reorder rows via drag and drop. This is enabled using the onReorder event handler, provided to the useDragAndDrop hook. The getItems function must also be implemented for items to become draggable. See below for more details.
This uses useListData from React Stately to manage the item list. Note that useListData is a convenience hook, not a requirement. You can manage your state however you wish.
import {useListData} from 'react-stately';
import {useDragAndDrop, Button} from 'react-aria-components';
function Example() {
let list = useListData({
initialItems: [
{id: 1, name: 'Games', date: '6/7/2020', type: 'File folder'},
{id: 2, name: 'Program Files', date: '4/7/2021', type: 'File folder'},
{id: 3, name: 'bootmgr', date: '11/20/2010', type: 'System file'},
{id: 4, name: 'log.txt', date: '1/18/2016', type: 'Text Document'}
]
});
let {dragAndDropHooks} = useDragAndDrop({
getItems: (keys) => [...keys].map(key => ({
'text/plain': list.getItem(key).name
})),
onReorder(e) {
if (e.target.dropPosition === 'before') {
list.moveBefore(e.target.key, e.keys);
} else if (e.target.dropPosition === 'after') {
list.moveAfter(e.target.key, e.keys);
}
}
});
return (
<Table
aria-label="Files"
selectionMode="multiple"
dragAndDropHooks={dragAndDropHooks} >
<TableHeader>
<Column></Column>
<Column><MyCheckbox /></Column>
<Column isRowHeader>Name</Column>
<Column>Type</Column>
<Column>Date Modified</Column>
</TableHeader>
<TableBody items={list.items}>
{item => (
<Row>
<Cell><Button slot="drag">≡</Button></Cell> <Cell><MyCheckbox /></Cell>
<Cell>{item.name}</Cell>
<Cell>{item.type}</Cell>
<Cell>{item.date}</Cell>
</Row>
)}
</TableBody>
</Table>
);
}import {useListData} from 'react-stately';
import {
Button,
useDragAndDrop
} from 'react-aria-components';
function Example() {
let list = useListData({
initialItems: [
{
id: 1,
name: 'Games',
date: '6/7/2020',
type: 'File folder'
},
{
id: 2,
name: 'Program Files',
date: '4/7/2021',
type: 'File folder'
},
{
id: 3,
name: 'bootmgr',
date: '11/20/2010',
type: 'System file'
},
{
id: 4,
name: 'log.txt',
date: '1/18/2016',
type: 'Text Document'
}
]
});
let { dragAndDropHooks } = useDragAndDrop({
getItems: (keys) =>
[...keys].map((key) => ({
'text/plain': list.getItem(key).name
})),
onReorder(e) {
if (e.target.dropPosition === 'before') {
list.moveBefore(e.target.key, e.keys);
} else if (e.target.dropPosition === 'after') {
list.moveAfter(e.target.key, e.keys);
}
}
});
return (
<Table
aria-label="Files"
selectionMode="multiple"
dragAndDropHooks={dragAndDropHooks} >
<TableHeader>
<Column></Column>
<Column>
<MyCheckbox />
</Column>
<Column isRowHeader>Name</Column>
<Column>Type</Column>
<Column>Date Modified</Column>
</TableHeader>
<TableBody items={list.items}>
{(item) => (
<Row>
<Cell>
<Button slot="drag">≡</Button>
</Cell> <Cell>
<MyCheckbox />
</Cell>
<Cell>{item.name}</Cell>
<Cell>{item.type}</Cell>
<Cell>{item.date}</Cell>
</Row>
)}
</TableBody>
</Table>
);
}
import {useListData} from 'react-stately';
import {
Button,
useDragAndDrop
} from 'react-aria-components';
function Example() {
let list = useListData(
{
initialItems: [
{
id: 1,
name: 'Games',
date:
'6/7/2020',
type:
'File folder'
},
{
id: 2,
name:
'Program Files',
date:
'4/7/2021',
type:
'File folder'
},
{
id: 3,
name:
'bootmgr',
date:
'11/20/2010',
type:
'System file'
},
{
id: 4,
name:
'log.txt',
date:
'1/18/2016',
type:
'Text Document'
}
]
}
);
let {
dragAndDropHooks
} = useDragAndDrop({
getItems: (keys) =>
[...keys].map(
(key) => ({
'text/plain':
list.getItem(
key
).name
})
),
onReorder(e) {
if (
e.target
.dropPosition ===
'before'
) {
list.moveBefore(
e.target.key,
e.keys
);
} else if (
e.target
.dropPosition ===
'after'
) {
list.moveAfter(
e.target.key,
e.keys
);
}
}
});
return (
<Table
aria-label="Files"
selectionMode="multiple"
dragAndDropHooks={dragAndDropHooks} >
<TableHeader>
<Column></Column>
<Column>
<MyCheckbox />
</Column>
<Column
isRowHeader
>
Name
</Column>
<Column>
Type
</Column>
<Column>
Date Modified
</Column>
</TableHeader>
<TableBody
items={list
.items}
>
{(item) => (
<Row>
<Cell>
<Button slot="drag">
≡
</Button>
</Cell> <Cell>
<MyCheckbox />
</Cell>
<Cell>
{item.name}
</Cell>
<Cell>
{item.type}
</Cell>
<Cell>
{item.date}
</Cell>
</Row>
)}
</TableBody>
</Table>
);
}
Show CSS
.react-aria-Row {
&[data-dragging] {
opacity: 0.6;
}
[slot=drag] {
all: unset;
width: 15px;
text-align: center;
&[data-focus-visible] {
border-radius: 4px;
box-shadow: 0 0 0 2px var(--highlight-background);
}
}
&[aria-selected=true] {
[slot=drag][data-focus-visible] {
box-shadow: 0 0 0 2px var(--highlight-foreground);
}
}
}
.react-aria-DropIndicator[data-drop-target] {
outline: 1px solid var(--highlight-background);
}.react-aria-Row {
&[data-dragging] {
opacity: 0.6;
}
[slot=drag] {
all: unset;
width: 15px;
text-align: center;
&[data-focus-visible] {
border-radius: 4px;
box-shadow: 0 0 0 2px var(--highlight-background);
}
}
&[aria-selected=true] {
[slot=drag][data-focus-visible] {
box-shadow: 0 0 0 2px var(--highlight-foreground);
}
}
}
.react-aria-DropIndicator[data-drop-target] {
outline: 1px solid var(--highlight-background);
}.react-aria-Row {
&[data-dragging] {
opacity: 0.6;
}
[slot=drag] {
all: unset;
width: 15px;
text-align: center;
&[data-focus-visible] {
border-radius: 4px;
box-shadow: 0 0 0 2px var(--highlight-background);
}
}
&[aria-selected=true] {
[slot=drag][data-focus-visible] {
box-shadow: 0 0 0 2px var(--highlight-foreground);
}
}
}
.react-aria-DropIndicator[data-drop-target] {
outline: 1px solid var(--highlight-background);
}Custom drag preview#
By default, the drag preview shown under the user's pointer or finger is a copy of the original element that started the drag. A custom preview can be rendered by implementing the renderDragPreview function, passed to useDragAndDrop. This receives the dragged data that was returned by getItems, and returns a rendered preview for those items.
This example renders a custom drag preview which shows the number of items being dragged.
import {useListData} from 'react-stately';
import {useDragAndDrop} from 'react-aria-components';
function Example() {
let {dragAndDropHooks} = useDragAndDrop({
// ...
renderDragPreview(items) {
return (
<div className="drag-preview">
{items[0]['text/plain']}
<span className="badge">{items.length}</span>
</div>
);
} });
// ...
}import {useListData} from 'react-stately';
import {useDragAndDrop} from 'react-aria-components';
function Example() {
let {dragAndDropHooks} = useDragAndDrop({
// ...
renderDragPreview(items) {
return (
<div className="drag-preview">
{items[0]['text/plain']}
<span className="badge">{items.length}</span>
</div>
);
} });
// ...
}import {useListData} from 'react-stately';
import {useDragAndDrop} from 'react-aria-components';
function Example() {
let {
dragAndDropHooks
} = useDragAndDrop({
// ...
renderDragPreview(
items
) {
return (
<div className="drag-preview">
{items[0][
'text/plain'
]}
<span className="badge">
{items
.length}
</span>
</div>
);
} });
// ...
}
Show CSS
.drag-preview {
width: 150px;
padding: 4px 8px;
display: flex;
align-items: center;
justify-content: space-between;
gap: 4px;
background: slateblue;
color: white;
border-radius: 4px;
.badge {
background: white;
color: slateblue;
padding: 0 8px;
border-radius: 4px;
}
}.drag-preview {
width: 150px;
padding: 4px 8px;
display: flex;
align-items: center;
justify-content: space-between;
gap: 4px;
background: slateblue;
color: white;
border-radius: 4px;
.badge {
background: white;
color: slateblue;
padding: 0 8px;
border-radius: 4px;
}
}.drag-preview {
width: 150px;
padding: 4px 8px;
display: flex;
align-items: center;
justify-content: space-between;
gap: 4px;
background: slateblue;
color: white;
border-radius: 4px;
.badge {
background: white;
color: slateblue;
padding: 0 8px;
border-radius: 4px;
}
}Drag data#
Data for draggable items can be provided in multiple formats at once. This allows drop targets to choose data in a format that they understand. For example, you could serialize a complex object as JSON in a custom format for use within your own application, and also provide plain text and/or rich HTML fallbacks that can be used when a user drops data in an external application (e.g. an email message).
This can be done by returning multiple keys for an item from the getItems function. Types can either be a standard mime type for interoperability with external applications, or a custom string for use within your own app.
This example provides representations of each item as plain text, HTML, and a custom app-specific data format. Dropping on the drop targets in this page will use the custom data format to render formatted items. If you drop in an external application supporting rich text, the HTML representation will be used. Dropping in a text editor will use the plain text format.
function DraggableTable() {
let items = [
{id: 1, name: 'Charizard', type: 'Fire, Flying', level: '67'},
{id: 2, name: 'Blastoise', type: 'Water', level: '56'},
{id: 3, name: 'Venusaur', type: 'Grass, Poison', level: '83'},
{id: 4, name: 'Pikachu', type: 'Electric', level: '100'}
];
let { dragAndDropHooks } = useDragAndDrop({
getItems(keys) {
return [...keys].map(key => {
let item = items.find(item => item.id === key)!;
return {
'text/plain': ` – `,
'text/html': `<strong></strong> – <em></em>`,
'pokemon': JSON.stringify(item)
};
});
}, });
return (
<PokemonTable
items={items}
selectionMode="multiple"
dragAndDropHooks={dragAndDropHooks} />
);
}
<div style={{display: 'flex', gap: 12, flexWrap: 'wrap'}}>
<DraggableTable />
{/* see below */}
<DroppableTable />
</div>function DraggableTable() {
let items = [
{
id: 1,
name: 'Charizard',
type: 'Fire, Flying',
level: '67'
},
{
id: 2,
name: 'Blastoise',
type: 'Water',
level: '56'
},
{
id: 3,
name: 'Venusaur',
type: 'Grass, Poison',
level: '83'
},
{
id: 4,
name: 'Pikachu',
type: 'Electric',
level: '100'
}
];
let { dragAndDropHooks } = useDragAndDrop({
getItems(keys) {
return [...keys].map((key) => {
let item = items.find((item) => item.id === key)!;
return {
'text/plain': ` – `,
'text/html':
`<strong></strong> – <em></em>`,
'pokemon': JSON.stringify(item)
};
});
} });
return (
<PokemonTable
items={items}
selectionMode="multiple"
dragAndDropHooks={dragAndDropHooks}
/>
);
}
<div
style={{ display: 'flex', gap: 12, flexWrap: 'wrap' }}
>
<DraggableTable />
{/* see below */}
<DroppableTable />
</div>function DraggableTable() {
let items = [
{
id: 1,
name: 'Charizard',
type:
'Fire, Flying',
level: '67'
},
{
id: 2,
name: 'Blastoise',
type: 'Water',
level: '56'
},
{
id: 3,
name: 'Venusaur',
type:
'Grass, Poison',
level: '83'
},
{
id: 4,
name: 'Pikachu',
type: 'Electric',
level: '100'
}
];
let {
dragAndDropHooks
} = useDragAndDrop({
getItems(keys) {
return [...keys]
.map((key) => {
let item =
items.find(
(item) =>
item
.id ===
key
)!;
return {
'text/plain':
` – `,
'text/html':
`<strong></strong> – <em></em>`,
'pokemon':
JSON
.stringify(
item
)
};
});
} });
return (
<PokemonTable
items={items}
selectionMode="multiple"
dragAndDropHooks={dragAndDropHooks}
/>
);
}
<div
style={{
display: 'flex',
gap: 12,
flexWrap: 'wrap'
}}
>
<DraggableTable />
{/* see below */}
<DroppableTable />
</div>Dropping on the collection#
Dropping on the Table as a whole can be enabled using the onRootDrop event. When a valid drag hovers over the Table, it receives the isDropTarget state and can be styled using the [data-drop-target] CSS selector.
import {isTextDropItem} from 'react-aria-components';
function Example() {
let [items, setItems] = React.useState<Pokemon[]>([]);
let { dragAndDropHooks } = useDragAndDrop({
async onRootDrop(e) {
let items = await Promise.all(
e.items
.filter(isTextDropItem)
.map(async item => (
JSON.parse(await item.getText('pokemon'))
)));
setItems(items);
} });
return (
<div style={{display: 'flex', gap: 12, flexWrap: 'wrap'}}>
<DraggableTable />
<PokemonTable
items={items}
dragAndDropHooks={dragAndDropHooks}
renderEmptyState={() => 'Drop items here'} />
</div>
);
}import {isTextDropItem} from 'react-aria-components';
function Example() {
let [items, setItems] = React.useState<Pokemon[]>([]);
let { dragAndDropHooks } = useDragAndDrop({
async onRootDrop(e) {
let items = await Promise.all(
e.items
.filter(isTextDropItem)
.map(async (item) => (
JSON.parse(await item.getText('pokemon'))
))
);
setItems(items);
} });
return (
<div
style={{ display: 'flex', gap: 12, flexWrap: 'wrap' }}
>
<DraggableTable />
<PokemonTable
items={items}
dragAndDropHooks={dragAndDropHooks}
renderEmptyState={() => 'Drop items here'}
/>
</div>
);
}
import {isTextDropItem} from 'react-aria-components';
function Example() {
let [items, setItems] =
React.useState<
Pokemon[]
>([]);
let {
dragAndDropHooks
} = useDragAndDrop({
async onRootDrop(e) {
let items =
await Promise
.all(
e.items
.filter(
isTextDropItem
)
.map(
async (item) => (
JSON
.parse(
await item
.getText(
'pokemon'
)
)
)
)
);
setItems(items);
} });
return (
<div
style={{
display: 'flex',
gap: 12,
flexWrap: 'wrap'
}}
>
<DraggableTable />
<PokemonTable
items={items}
dragAndDropHooks={dragAndDropHooks}
renderEmptyState={() =>
'Drop items here'}
/>
</div>
);
}
Show CSS
.react-aria-Table[data-drop-target] {
border-color: var(--highlight-background);
box-shadow: 0 0 0 1px var(--highlight-background);
background: rgb(from slateblue r g b / 15%);
}.react-aria-Table[data-drop-target] {
border-color: var(--highlight-background);
box-shadow: 0 0 0 1px var(--highlight-background);
background: rgb(from slateblue r g b / 15%);
}.react-aria-Table[data-drop-target] {
border-color: var(--highlight-background);
box-shadow: 0 0 0 1px var(--highlight-background);
background: rgb(from slateblue r g b / 15%);
}Dropping on items#
Dropping on items can be enabled using the onItemDrop event. When a valid drag hovers over an item, it receives the isDropTarget state and can be styled using the [data-drop-target] CSS selector.
function Example() {
let { dragAndDropHooks } = useDragAndDrop({
onItemDrop(e) {
alert(`Dropped on `);
} });
return (
<div style={{display: 'flex', gap: 12, flexWrap: 'wrap'}}>
{/* see above */}
<DraggableTable />
<FileTable dragAndDropHooks={dragAndDropHooks} />
</div>
);
}function Example() {
let { dragAndDropHooks } = useDragAndDrop({
onItemDrop(e) {
alert(`Dropped on `);
} });
return (
<div
style={{ display: 'flex', gap: 12, flexWrap: 'wrap' }}
>
{/* see above */}
<DraggableTable />
<FileTable dragAndDropHooks={dragAndDropHooks} />
</div>
);
}
function Example() {
let {
dragAndDropHooks
} = useDragAndDrop({
onItemDrop(e) {
alert(
`Dropped on `
);
} });
return (
<div
style={{
display: 'flex',
gap: 12,
flexWrap: 'wrap'
}}
>
{/* see above */}
<DraggableTable />
<FileTable
dragAndDropHooks={dragAndDropHooks}
/>
</div>
);
}
Show CSS
.react-aria-Row[data-drop-target] {
outline: 2px solid var(--highlight-background);
background: rgb(from slateblue r g b / 15%);
}.react-aria-Row[data-drop-target] {
outline: 2px solid var(--highlight-background);
background: rgb(from slateblue r g b / 15%);
}.react-aria-Row[data-drop-target] {
outline: 2px solid var(--highlight-background);
background: rgb(from slateblue r g b / 15%);
}Dropping between items#
Dropping between items can be enabled using the onInsert event. Table renders a DropIndicator between items to indicate the insertion position, which can be styled using the .react-aria-DropIndicator selector. When it is active, it receives the [data-drop-target] state.
import {isTextDropItem} from 'react-aria-components';
function Example() {
let list = useListData({
initialItems: [
{ id: 1, name: 'Bulbasaur', type: 'Grass, Poison', level: '65' },
{ id: 2, name: 'Charmander', type: 'Fire', level: '89' },
{ id: 3, name: 'Squirtle', type: 'Water', level: '77' },
{ id: 4, name: 'Caterpie', type: 'Bug', level: '46' }
]
});
let { dragAndDropHooks } = useDragAndDrop({
async onInsert(e) {
let items = await Promise.all(
e.items.filter(isTextDropItem).map(async (item) => {
let { name, type, level } = JSON.parse(await item.getText('pokemon'));
return { id: Math.random(), name, type, level };
})
);
if (e.target.dropPosition === 'before') {
list.insertBefore(e.target.key, ...items);
} else if (e.target.dropPosition === 'after') {
list.insertAfter(e.target.key, ...items);
}
} });
return (
<div style={{ display: 'flex', gap: 12, flexWrap: 'wrap' }}>
<DraggableTable />
<PokemonTable items={list.items} dragAndDropHooks={dragAndDropHooks} />
</div>
);
}
import {isTextDropItem} from 'react-aria-components';
function Example() {
let list = useListData({
initialItems: [
{
id: 1,
name: 'Bulbasaur',
type: 'Grass, Poison',
level: '65'
},
{
id: 2,
name: 'Charmander',
type: 'Fire',
level: '89'
},
{
id: 3,
name: 'Squirtle',
type: 'Water',
level: '77'
},
{ id: 4, name: 'Caterpie', type: 'Bug', level: '46' }
]
});
let { dragAndDropHooks } = useDragAndDrop({
async onInsert(e) {
let items = await Promise.all(
e.items.filter(isTextDropItem).map(async (item) => {
let { name, type, level } = JSON.parse(
await item.getText('pokemon')
);
return { id: Math.random(), name, type, level };
})
);
if (e.target.dropPosition === 'before') {
list.insertBefore(e.target.key, ...items);
} else if (e.target.dropPosition === 'after') {
list.insertAfter(e.target.key, ...items);
}
} });
return (
<div
style={{ display: 'flex', gap: 12, flexWrap: 'wrap' }}
>
<DraggableTable />
<PokemonTable
items={list.items}
dragAndDropHooks={dragAndDropHooks}
/>
</div>
);
}
import {isTextDropItem} from 'react-aria-components';
function Example() {
let list = useListData(
{
initialItems: [
{
id: 1,
name:
'Bulbasaur',
type:
'Grass, Poison',
level: '65'
},
{
id: 2,
name:
'Charmander',
type: 'Fire',
level: '89'
},
{
id: 3,
name:
'Squirtle',
type: 'Water',
level: '77'
},
{
id: 4,
name:
'Caterpie',
type: 'Bug',
level: '46'
}
]
}
);
let {
dragAndDropHooks
} = useDragAndDrop({
async onInsert(e) {
let items =
await Promise
.all(
e.items
.filter(
isTextDropItem
).map(
async (item) => {
let {
name,
type,
level
} =
JSON
.parse(
await item
.getText(
'pokemon'
)
);
return {
id:
Math
.random(),
name,
type,
level
};
}
)
);
if (
e.target
.dropPosition ===
'before'
) {
list
.insertBefore(
e.target.key,
...items
);
} else if (
e.target
.dropPosition ===
'after'
) {
list.insertAfter(
e.target.key,
...items
);
}
} });
return (
<div
style={{
display: 'flex',
gap: 12,
flexWrap: 'wrap'
}}
>
<DraggableTable />
<PokemonTable
items={list
.items}
dragAndDropHooks={dragAndDropHooks}
/>
</div>
);
}
Show CSS
.react-aria-DropIndicator[data-drop-target] {
outline: 1px solid var(--highlight-background);
}.react-aria-DropIndicator[data-drop-target] {
outline: 1px solid var(--highlight-background);
}.react-aria-DropIndicator[data-drop-target] {
outline: 1px solid var(--highlight-background);
}A custom drop indicator can also be rendered with the renderDropIndicator function. This lets you customize the DOM structure and CSS classes applied to the drop indicator.
import {DropIndicator} from 'react-aria-components';
function Example() {
let { dragAndDropHooks } = useDragAndDrop({
// ...
renderDropIndicator(target) {
return (
<DropIndicator
target={target}
className={({ isDropTarget }) =>
`my-drop-indicator `}
/>
);
} });
// ...
}
import {DropIndicator} from 'react-aria-components';
function Example() {
let { dragAndDropHooks } = useDragAndDrop({
// ...
renderDropIndicator(target) {
return (
<DropIndicator
target={target}
className={({ isDropTarget }) =>
`my-drop-indicator `}
/>
);
} });
// ...
}
import {DropIndicator} from 'react-aria-components';
function Example() {
let {
dragAndDropHooks
} = useDragAndDrop({
// ...
renderDropIndicator(
target
) {
return (
<DropIndicator
target={target}
className={(
{
isDropTarget
}
) =>
`my-drop-indicator `}
/>
);
} });
// ...
}
Show CSS
.my-drop-indicator.active {
outline: 1px solid #e70073;
}.my-drop-indicator.active {
outline: 1px solid #e70073;
}.my-drop-indicator.active {
outline: 1px solid #e70073;
}Drop data#
Table allows users to drop one or more drag items, each of which contains data to be transferred from the drag source to drop target. There are three kinds of drag items:
text– represents data inline as a string in one or more formatsfile– references a file on the user's devicedirectory– references the contents of a directory
Text#
A TextDropItem represents textual data in one or more different formats. These may be either standard mime types or custom app-specific formats. Representing data in multiple formats allows drop targets both within and outside an application to choose data in a format that they understand. For example, a complex object may be serialized in a custom format for use within an application, with fallbacks in plain text and/or rich HTML that can be used when a user drops data from an external application.
The example below uses the acceptedDragTypes prop to accept items that include a custom app-specific type, which is retrieved using the item's getText method. The same draggable component as used in the above example is used here, but rather than displaying the plain text representation, the custom format is used instead. When acceptedDragTypes is specified, the dropped items are filtered to include only items that include the accepted types.
import {isTextDropItem} from 'react-aria-components';
function DroppableTable() {
let [items, setItems] = React.useState<Pokemon[]>([]);
let { dragAndDropHooks } = useDragAndDrop({
acceptedDragTypes: ['pokemon'],
async onRootDrop(e) {
let items = await Promise.all(
e.items
.filter(isTextDropItem)
.map(async item => JSON.parse(await item.getText('pokemon')))
);
setItems(items);
} });
return (
<PokemonTable
items={items}
dragAndDropHooks={dragAndDropHooks}
renderEmptyState={() => 'Drop items here'} />
);
}
<div style={{display: 'flex', gap: 12, flexWrap: 'wrap'}}>
{/* see above */}
<DraggableTable />
<DroppableTable />
</div>import {isTextDropItem} from 'react-aria-components';
function DroppableTable() {
let [items, setItems] = React.useState<Pokemon[]>([]);
let { dragAndDropHooks } = useDragAndDrop({
acceptedDragTypes: ['pokemon'],
async onRootDrop(e) {
let items = await Promise.all(
e.items
.filter(isTextDropItem)
.map(async (item) =>
JSON.parse(await item.getText('pokemon'))
)
);
setItems(items);
} });
return (
<PokemonTable
items={items}
dragAndDropHooks={dragAndDropHooks}
renderEmptyState={() => 'Drop items here'}
/>
);
}
<div
style={{ display: 'flex', gap: 12, flexWrap: 'wrap' }}
>
{/* see above */}
<DraggableTable />
<DroppableTable />
</div>import {isTextDropItem} from 'react-aria-components';
function DroppableTable() {
let [items, setItems] =
React.useState<
Pokemon[]
>([]);
let {
dragAndDropHooks
} = useDragAndDrop({
acceptedDragTypes: [
'pokemon'
],
async onRootDrop(e) {
let items =
await Promise
.all(
e.items
.filter(
isTextDropItem
)
.map(
async (item) =>
JSON
.parse(
await item
.getText(
'pokemon'
)
)
)
);
setItems(items);
} });
return (
<PokemonTable
items={items}
dragAndDropHooks={dragAndDropHooks}
renderEmptyState={() =>
'Drop items here'}
/>
);
}
<div
style={{
display: 'flex',
gap: 12,
flexWrap: 'wrap'
}}
>
{/* see above */}
<DraggableTable />
<DroppableTable />
</div>Files#
A FileDropItem references a file on the user's device. It includes the name and mime type of the file, and methods to read the contents as plain text, or retrieve a native File object which can be attached to form data for uploading.
This example accepts JPEG and PNG image files, and renders them by creating a local object URL. When the list is empty, you can drop on the whole collection, and otherwise items can be inserted.
import {isFileDropItem} from 'react-aria-components';
interface ImageItem {
id: number,
url: string,
name: string,
type: string,
lastModified: number
}
function Example() {
let [items, setItems] = React.useState<ImageItem[]>([]);
let { dragAndDropHooks } = useDragAndDrop({
acceptedDragTypes: ['image/jpeg', 'image/png'],
async onRootDrop(e) {
let items = await Promise.all(
e.items.filter(isFileDropItem).map(async item => {
let file = await item.getFile();
return {
id: Math.random(),
url: URL.createObjectURL(file),
name: item.name,
type: file.type,
lastModified: file.lastModified
};
})
);
setItems(items);
} });
return (
<Table
aria-label="Droppable table"
dragAndDropHooks={dragAndDropHooks}>
<TableHeader>
<Column>Image</Column>
<Column isRowHeader>Name</Column>
<Column>Type</Column>
<Column>Last Modified</Column>
</TableHeader>
<TableBody items={items} renderEmptyState={() => 'Drop images here'}>
{item => (
<Row>
<Cell><img src={item.url} /></Cell>
<Cell>{item.name}</Cell>
<Cell>{item.type}</Cell>
<Cell>{new Date(item.lastModified).toLocaleString()}</Cell>
</Row>
)}
</TableBody>
</Table>
);
}import {isFileDropItem} from 'react-aria-components';
interface ImageItem {
id: number;
url: string;
name: string;
type: string;
lastModified: number;
}
function Example() {
let [items, setItems] = React.useState<ImageItem[]>([]);
let { dragAndDropHooks } = useDragAndDrop({
acceptedDragTypes: ['image/jpeg', 'image/png'],
async onRootDrop(e) {
let items = await Promise.all(
e.items.filter(isFileDropItem).map(async (item) => {
let file = await item.getFile();
return {
id: Math.random(),
url: URL.createObjectURL(file),
name: item.name,
type: file.type,
lastModified: file.lastModified
};
})
);
setItems(items);
} });
return (
<Table
aria-label="Droppable table"
dragAndDropHooks={dragAndDropHooks}
>
<TableHeader>
<Column>Image</Column>
<Column isRowHeader>Name</Column>
<Column>Type</Column>
<Column>Last Modified</Column>
</TableHeader>
<TableBody
items={items}
renderEmptyState={() => 'Drop images here'}
>
{(item) => (
<Row>
<Cell>
<img src={item.url} />
</Cell>
<Cell>{item.name}</Cell>
<Cell>{item.type}</Cell>
<Cell>
{new Date(item.lastModified).toLocaleString()}
</Cell>
</Row>
)}
</TableBody>
</Table>
);
}
import {isFileDropItem} from 'react-aria-components';
interface ImageItem {
id: number;
url: string;
name: string;
type: string;
lastModified: number;
}
function Example() {
let [items, setItems] =
React.useState<
ImageItem[]
>([]);
let {
dragAndDropHooks
} = useDragAndDrop({
acceptedDragTypes: [
'image/jpeg',
'image/png'
],
async onRootDrop(e) {
let items =
await Promise
.all(
e.items
.filter(
isFileDropItem
).map(
async (item) => {
let file =
await item
.getFile();
return {
id:
Math
.random(),
url:
URL
.createObjectURL(
file
),
name:
item
.name,
type:
file
.type,
lastModified:
file
.lastModified
};
}
)
);
setItems(items);
} });
return (
<Table
aria-label="Droppable table"
dragAndDropHooks={dragAndDropHooks}
>
<TableHeader>
<Column>
Image
</Column>
<Column
isRowHeader
>
Name
</Column>
<Column>
Type
</Column>
<Column>
Last Modified
</Column>
</TableHeader>
<TableBody
items={items}
renderEmptyState={() =>
'Drop images here'}
>
{(item) => (
<Row>
<Cell>
<img
src={item
.url}
/>
</Cell>
<Cell>
{item.name}
</Cell>
<Cell>
{item.type}
</Cell>
<Cell>
{new Date(
item
.lastModified
).toLocaleString()}
</Cell>
</Row>
)}
</TableBody>
</Table>
);
}
Show CSS
.react-aria-Cell img {
height: 30px;
width: 30px;
object-fit: cover;
display: block;
}.react-aria-Cell img {
height: 30px;
width: 30px;
object-fit: cover;
display: block;
}.react-aria-Cell img {
height: 30px;
width: 30px;
object-fit: cover;
display: block;
}Directories#
A DirectoryDropItem references the contents of a directory on the user's device. It includes the name of the directory, as well as a method to iterate through the files and folders within the directory. The contents of any folders within the directory can be accessed recursively.
The getEntries method returns an async iterable object, which can be used in a for await...of loop. This provides each item in the directory as either a FileDropItem or DirectoryDropItem, and you can access the contents of each file as discussed above.
This example accepts directory drops over the whole collection, and renders the contents as items in the list. DIRECTORY_DRAG_TYPE is imported from react-aria-components and included in the acceptedDragTypes prop to limit the accepted items to only directories.
import File from '@spectrum-icons/workflow/FileTxt';
import Folder from '@spectrum-icons/workflow/Folder';
import {DIRECTORY_DRAG_TYPE, isDirectoryDropItem} from 'react-aria-components';
interface DirItem {
name: string,
kind: string,
type: string
}
function Example() {
let [files, setFiles] = React.useState<DirItem[]>([]);
let { dragAndDropHooks } = useDragAndDrop({
acceptedDragTypes: [DIRECTORY_DRAG_TYPE],
async onRootDrop(e) {
// Read entries in directory and update state with relevant info.
let dir = e.items.find(isDirectoryDropItem)!;
let files = [];
for await (let entry of dir.getEntries()) {
files.push({
name: entry.name,
kind: entry.kind,
type: entry.kind === 'directory' ? 'Directory' : entry.type
});
}
setFiles(files);
} });
return (
<Table
aria-label="Droppable table"
dragAndDropHooks={dragAndDropHooks}>
<TableHeader>
<Column>Kind</Column>
<Column isRowHeader>Name</Column>
<Column>Type</Column>
</TableHeader>
<TableBody items={files} renderEmptyState={() => 'Drop directory here'}>
{item => (
<Row id={item.name}>
<Cell>{item.kind === 'directory' ? <Folder /> : <File />}</Cell>
<Cell>{item.name}</Cell>
<Cell>{item.type}</Cell>
</Row>
)}
</TableBody>
</Table>
);
}import File from '@spectrum-icons/workflow/FileTxt';
import Folder from '@spectrum-icons/workflow/Folder';
import {
DIRECTORY_DRAG_TYPE,
isDirectoryDropItem
} from 'react-aria-components';
interface DirItem {
name: string;
kind: string;
type: string;
}
function Example() {
let [files, setFiles] = React.useState<DirItem[]>([]);
let { dragAndDropHooks } = useDragAndDrop({
acceptedDragTypes: [DIRECTORY_DRAG_TYPE],
async onRootDrop(e) {
// Read entries in directory and update state with relevant info.
let dir = e.items.find(isDirectoryDropItem)!;
let files = [];
for await (let entry of dir.getEntries()) {
files.push({
name: entry.name,
kind: entry.kind,
type: entry.kind === 'directory'
? 'Directory'
: entry.type
});
}
setFiles(files);
} });
return (
<Table
aria-label="Droppable table"
dragAndDropHooks={dragAndDropHooks}
>
<TableHeader>
<Column>Kind</Column>
<Column isRowHeader>Name</Column>
<Column>Type</Column>
</TableHeader>
<TableBody
items={files}
renderEmptyState={() => 'Drop directory here'}
>
{(item) => (
<Row id={item.name}>
<Cell>
{item.kind === 'directory'
? <Folder />
: <File />}
</Cell>
<Cell>{item.name}</Cell>
<Cell>{item.type}</Cell>
</Row>
)}
</TableBody>
</Table>
);
}
import File from '@spectrum-icons/workflow/FileTxt';
import Folder from '@spectrum-icons/workflow/Folder';
import {
DIRECTORY_DRAG_TYPE,
isDirectoryDropItem
} from 'react-aria-components';
interface DirItem {
name: string;
kind: string;
type: string;
}
function Example() {
let [files, setFiles] =
React.useState<
DirItem[]
>([]);
let {
dragAndDropHooks
} = useDragAndDrop({
acceptedDragTypes: [
DIRECTORY_DRAG_TYPE
],
async onRootDrop(e) {
// Read entries in directory and update state with relevant info.
let dir = e.items
.find(
isDirectoryDropItem
)!;
let files = [];
for await (
let entry of dir
.getEntries()
) {
files.push({
name:
entry.name,
kind:
entry.kind,
type:
entry
.kind ===
'directory'
? 'Directory'
: entry
.type
});
}
setFiles(files);
} });
return (
<Table
aria-label="Droppable table"
dragAndDropHooks={dragAndDropHooks}
>
<TableHeader>
<Column>
Kind
</Column>
<Column
isRowHeader
>
Name
</Column>
<Column>
Type
</Column>
</TableHeader>
<TableBody
items={files}
renderEmptyState={() =>
'Drop directory here'}
>
{(item) => (
<Row
id={item
.name}
>
<Cell>
{item
.kind ===
'directory'
? (
<Folder />
)
: (
<File />
)}
</Cell>
<Cell>
{item.name}
</Cell>
<Cell>
{item.type}
</Cell>
</Row>
)}
</TableBody>
</Table>
);
}
Drop operations#
A DropOperation is an indication of what will happen when dragged data is dropped on a particular drop target. These are:
move– indicates that the dragged data will be moved from its source location to the target location.copy– indicates that the dragged data will be copied to the target destination.link– indicates that there will be a relationship established between the source and target locations.cancel– indicates that the drag and drop operation will be canceled, resulting in no changes made to the source or target.
Many operating systems display these in the form of a cursor change, e.g. a plus sign to indicate a copy operation. The user may also be able to use a modifier key to choose which drop operation to perform, such as Option or Alt to switch from move to copy.
onDragEnd#
The onDragEnd event allows the drag source to respond when a drag that it initiated ends, either because it was dropped or because it was canceled by the user. The dropOperation property of the event object indicates the operation that was performed. For example, when data is moved, the UI could be updated to reflect this change by removing the original dragged items.
This example removes the dragged items from the UI when a move operation is completed. Try holding the Option or Alt keys to change the operation to copy, and see how the behavior changes.
function Example() {
let list = useListData({
initialItems: [
{id: 1, name: 'Charizard', type: 'Fire, Flying', level: '67'},
{id: 2, name: 'Blastoise', type: 'Water', level: '56'},
{id: 3, name: 'Venusaur', type: 'Grass, Poison', level: '83'},
{id: 4, name: 'Pikachu', type: 'Electric', level: '100'}
]
});
let { dragAndDropHooks } = useDragAndDrop({
// ...
onDragEnd(e) {
if (e.dropOperation === 'move') {
list.remove(...e.keys);
}
} });
return (
<div style={{display: 'flex', gap: 12, flexWrap: 'wrap'}}>
<PokemonTable
items={list.items}
selectionMode="multiple"
dragAndDropHooks={dragAndDropHooks} />
<DroppableTable />
</div>
);
}function Example() {
let list = useListData({
initialItems: [
{
id: 1,
name: 'Charizard',
type: 'Fire, Flying',
level: '67'
},
{
id: 2,
name: 'Blastoise',
type: 'Water',
level: '56'
},
{
id: 3,
name: 'Venusaur',
type: 'Grass, Poison',
level: '83'
},
{
id: 4,
name: 'Pikachu',
type: 'Electric',
level: '100'
}
]
});
let { dragAndDropHooks } = useDragAndDrop({
// ...
onDragEnd(e) {
if (e.dropOperation === 'move') {
list.remove(...e.keys);
}
} });
return (
<div
style={{ display: 'flex', gap: 12, flexWrap: 'wrap' }}
>
<PokemonTable
items={list.items}
selectionMode="multiple"
dragAndDropHooks={dragAndDropHooks}
/>
<DroppableTable />
</div>
);
}
function Example() {
let list = useListData(
{
initialItems: [
{
id: 1,
name:
'Charizard',
type:
'Fire, Flying',
level: '67'
},
{
id: 2,
name:
'Blastoise',
type: 'Water',
level: '56'
},
{
id: 3,
name:
'Venusaur',
type:
'Grass, Poison',
level: '83'
},
{
id: 4,
name:
'Pikachu',
type:
'Electric',
level: '100'
}
]
}
);
let {
dragAndDropHooks
} = useDragAndDrop({
// ...
onDragEnd(e) {
if (
e.dropOperation ===
'move'
) {
list.remove(
...e.keys
);
}
} });
return (
<div
style={{
display: 'flex',
gap: 12,
flexWrap: 'wrap'
}}
>
<PokemonTable
items={list
.items}
selectionMode="multiple"
dragAndDropHooks={dragAndDropHooks}
/>
<DroppableTable />
</div>
);
}
getAllowedDropOperations#
The drag source can also control which drop operations are allowed for the data. For example, if moving data is not allowed, and only copying is supported, the getAllowedDropOperations function could be implemented to indicate this. When you drag the element below, the cursor now shows the copy affordance by default, and pressing a modifier to switch drop operations results in the drop being canceled.
function Example() {
// ...
let { dragAndDropHooks } = useDragAndDrop({
// ...
getAllowedDropOperations: () => ['copy'] });
return (
<div style={{display: 'flex', gap: 12, flexWrap: 'wrap'}}>
<PokemonTable
items={list.items}
selectionMode="multiple"
dragAndDropHooks={dragAndDropHooks} />
<DroppableTable />
</div>
);
}function Example() {
// ...
let { dragAndDropHooks } = useDragAndDrop({
// ...
getAllowedDropOperations: () => ['copy'] });
return (
<div
style={{ display: 'flex', gap: 12, flexWrap: 'wrap' }}
>
<PokemonTable
items={list.items}
selectionMode="multiple"
dragAndDropHooks={dragAndDropHooks}
/>
<DroppableTable />
</div>
);
}
function Example() {
// ...
let {
dragAndDropHooks
} = useDragAndDrop({
// ...
getAllowedDropOperations:
() => ['copy'] });
return (
<div
style={{
display: 'flex',
gap: 12,
flexWrap: 'wrap'
}}
>
<PokemonTable
items={list
.items}
selectionMode="multiple"
dragAndDropHooks={dragAndDropHooks}
/>
<DroppableTable />
</div>
);
}
getDropOperation#
The getDropOperation function passed to useDragAndDrop can be used to provide appropriate feedback to the user when a drag hovers over the drop target. This function receives the drop target, set of types contained in the drag, and a list of allowed drop operations as specified by the drag source. It should return one of the drop operations in allowedOperations, or a specific drop operation if only that drop operation is supported. It may also return 'cancel' to reject the drop. If the returned operation is not in allowedOperations, then the drop target will act as if 'cancel' was returned.
In the below example, the drop target only supports dropping PNG images. If a PNG is dragged over the target, it will be highlighted and the operating system displays a copy cursor. If another type is dragged over the target, then there is no visual feedback, indicating that a drop is not accepted there. If the user holds a modifier key such as Control while dragging over the drop target in order to change the drop operation, then the drop target does not accept the drop.
function Example() {
let [items, setItems] = React.useState<ImageItem[]>([]);
let { dragAndDropHooks } = useDragAndDrop({
getDropOperation: () => 'copy', acceptedDragTypes: ['image/png'],
async onRootDrop(e) {
// ...
}
});
// See "Files" example above...
}function Example() {
let [items, setItems] = React.useState<ImageItem[]>([]);
let { dragAndDropHooks } = useDragAndDrop({
getDropOperation: () => 'copy', acceptedDragTypes: ['image/png'],
async onRootDrop(e) {
// ...
}
});
// See "Files" example above...
}function Example() {
let [items, setItems] =
React.useState<
ImageItem[]
>([]);
let {
dragAndDropHooks
} = useDragAndDrop({
getDropOperation:
() => 'copy', acceptedDragTypes: [
'image/png'
],
async onRootDrop(e) {
// ...
}
});
// See "Files" example above...
}
Drop events#
Drop events such as onInsert, onItemDrop, etc. also include the dropOperation. This can be used to perform different actions accordingly, for example, when communicating with a backend API.
let onItemDrop = async (e) => {
let data = JSON.parse(await e.items[0].getText('my-app-file'));
switch (e.dropOperation) {
case 'move':
MyAppFileService.move(data.filePath, props.filePath);
break;
case 'copy':
MyAppFileService.copy(data.filePath, props.filePath);
break;
case 'link':
MyAppFileService.link(data.filePath, props.filePath);
break;
}};let onItemDrop = async (e) => {
let data = JSON.parse(
await e.items[0].getText('my-app-file')
);
switch (e.dropOperation) {
case 'move':
MyAppFileService.move(data.filePath, props.filePath);
break;
case 'copy':
MyAppFileService.copy(data.filePath, props.filePath);
break;
case 'link':
MyAppFileService.link(data.filePath, props.filePath);
break;
}};
let onItemDrop = async (
e
) => {
let data = JSON.parse(
await e.items[0]
.getText(
'my-app-file'
)
);
switch (
e.dropOperation
) {
case 'move':
MyAppFileService
.move(
data.filePath,
props.filePath
);
break;
case 'copy':
MyAppFileService
.copy(
data.filePath,
props.filePath
);
break;
case 'link':
MyAppFileService
.link(
data.filePath,
props.filePath
);
break;
}};
Drag between tables#
This example puts together many of the concepts described above, allowing users to drag items between tables bidirectionally. It also supports reordering items within the same table. When a table is empty, it accepts drops on the whole collection. getDropOperation ensures that items are always moved rather than copied, which avoids duplicate items.
import {isTextDropItem} from 'react-aria-components';
interface FileItem {
id: string,
name: string,
type: string
}
interface DndTableProps {
initialItems: FileItem[],
'aria-label': string
}
function DndTable(props: DndTableProps) {
let list = useListData({
initialItems: props.initialItems
});
let { dragAndDropHooks } = useDragAndDrop({
// Provide drag data in a custom format as well as plain text.
getItems(keys) {
return [...keys].map((key) => {
let item = list.getItem(key);
return {
'custom-app-type': JSON.stringify(item),
'text/plain': item.name
};
});
},
// Accept drops with the custom format.
acceptedDragTypes: ['custom-app-type'],
// Ensure items are always moved rather than copied.
getDropOperation: () => 'move',
// Handle drops between items from other lists.
async onInsert(e) {
let processedItems = await Promise.all(
e.items
.filter(isTextDropItem)
.map(async item => JSON.parse(await item.getText('custom-app-type')))
);
if (e.target.dropPosition === 'before') {
list.insertBefore(e.target.key, ...processedItems);
} else if (e.target.dropPosition === 'after') {
list.insertAfter(e.target.key, ...processedItems);
}
},
// Handle drops on the collection when empty.
async onRootDrop(e) {
let processedItems = await Promise.all(
e.items
.filter(isTextDropItem)
.map(async item => JSON.parse(await item.getText('custom-app-type')))
);
list.append(...processedItems);
},
// Handle reordering items within the same list.
onReorder(e) {
if (e.target.dropPosition === 'before') {
list.moveBefore(e.target.key, e.keys);
} else if (e.target.dropPosition === 'after') {
list.moveAfter(e.target.key, e.keys);
}
},
// Remove the items from the source list on drop
// if they were moved to a different list.
onDragEnd(e) {
if (e.dropOperation === 'move' && !e.isInternal) {
list.remove(...e.keys);
}
}
});
return (
<Table
aria-label={props['aria-label']}
selectionMode="multiple"
selectedKeys={list.selectedKeys}
onSelectionChange={list.setSelectedKeys}
dragAndDropHooks={dragAndDropHooks}>
<TableHeader>
<Column />
<Column><MyCheckbox /></Column>
<Column>ID</Column>
<Column isRowHeader>Name</Column>
<Column>Type</Column>
</TableHeader>
<TableBody items={list.items} renderEmptyState={() => 'Drop items here'}>
{item => (
<Row>
<Cell><Button slot="drag">≡</Button></Cell>
<Cell><MyCheckbox /></Cell>
<Cell>{item.id}</Cell>
<Cell>{item.name}</Cell>
<Cell>{item.type}</Cell>
</Row>
)}
</TableBody>
</Table>
);
}
<div style={{display: 'flex', gap: 12, flexWrap: 'wrap'}}>
<DndTable
initialItems={[
{ id: '1', type: 'file', name: 'Adobe Photoshop' },
{ id: '2', type: 'file', name: 'Adobe XD' },
{ id: '3', type: 'folder', name: 'Documents' },
{ id: '4', type: 'file', name: 'Adobe InDesign' },
{ id: '5', type: 'folder', name: 'Utilities' },
{ id: '6', type: 'file', name: 'Adobe AfterEffects' }
]}
aria-label="First Table"
/>
<DndTable
initialItems={[
{ id: '7', type: 'folder', name: 'Pictures' },
{ id: '8', type: 'file', name: 'Adobe Fresco' },
{ id: '9', type: 'folder', name: 'Apps' },
{ id: '10', type: 'file', name: 'Adobe Illustrator' },
{ id: '11', type: 'file', name: 'Adobe Lightroom' },
{ id: '12', type: 'file', name: 'Adobe Dreamweaver' }
]}
aria-label="Second Table"
/>
</div>import {isTextDropItem} from 'react-aria-components';
interface FileItem {
id: string;
name: string;
type: string;
}
interface DndTableProps {
initialItems: FileItem[];
'aria-label': string;
}
function DndTable(props: DndTableProps) {
let list = useListData({
initialItems: props.initialItems
});
let { dragAndDropHooks } = useDragAndDrop({
// Provide drag data in a custom format as well as plain text.
getItems(keys) {
return [...keys].map((key) => {
let item = list.getItem(key);
return {
'custom-app-type': JSON.stringify(item),
'text/plain': item.name
};
});
},
// Accept drops with the custom format.
acceptedDragTypes: ['custom-app-type'],
// Ensure items are always moved rather than copied.
getDropOperation: () => 'move',
// Handle drops between items from other lists.
async onInsert(e) {
let processedItems = await Promise.all(
e.items
.filter(isTextDropItem)
.map(async (item) =>
JSON.parse(
await item.getText('custom-app-type')
)
)
);
if (e.target.dropPosition === 'before') {
list.insertBefore(e.target.key, ...processedItems);
} else if (e.target.dropPosition === 'after') {
list.insertAfter(e.target.key, ...processedItems);
}
},
// Handle drops on the collection when empty.
async onRootDrop(e) {
let processedItems = await Promise.all(
e.items
.filter(isTextDropItem)
.map(async (item) =>
JSON.parse(
await item.getText('custom-app-type')
)
)
);
list.append(...processedItems);
},
// Handle reordering items within the same list.
onReorder(e) {
if (e.target.dropPosition === 'before') {
list.moveBefore(e.target.key, e.keys);
} else if (e.target.dropPosition === 'after') {
list.moveAfter(e.target.key, e.keys);
}
},
// Remove the items from the source list on drop
// if they were moved to a different list.
onDragEnd(e) {
if (e.dropOperation === 'move' && !e.isInternal) {
list.remove(...e.keys);
}
}
});
return (
<Table
aria-label={props['aria-label']}
selectionMode="multiple"
selectedKeys={list.selectedKeys}
onSelectionChange={list.setSelectedKeys}
dragAndDropHooks={dragAndDropHooks}
>
<TableHeader>
<Column />
<Column>
<MyCheckbox />
</Column>
<Column>ID</Column>
<Column isRowHeader>Name</Column>
<Column>Type</Column>
</TableHeader>
<TableBody
items={list.items}
renderEmptyState={() => 'Drop items here'}
>
{(item) => (
<Row>
<Cell>
<Button slot="drag">≡</Button>
</Cell>
<Cell>
<MyCheckbox />
</Cell>
<Cell>{item.id}</Cell>
<Cell>{item.name}</Cell>
<Cell>{item.type}</Cell>
</Row>
)}
</TableBody>
</Table>
);
}
<div
style={{ display: 'flex', gap: 12, flexWrap: 'wrap' }}
>
<DndTable
initialItems={[
{ id: '1', type: 'file', name: 'Adobe Photoshop' },
{ id: '2', type: 'file', name: 'Adobe XD' },
{ id: '3', type: 'folder', name: 'Documents' },
{ id: '4', type: 'file', name: 'Adobe InDesign' },
{ id: '5', type: 'folder', name: 'Utilities' },
{
id: '6',
type: 'file',
name: 'Adobe AfterEffects'
}
]}
aria-label="First Table"
/>
<DndTable
initialItems={[
{ id: '7', type: 'folder', name: 'Pictures' },
{ id: '8', type: 'file', name: 'Adobe Fresco' },
{ id: '9', type: 'folder', name: 'Apps' },
{
id: '10',
type: 'file',
name: 'Adobe Illustrator'
},
{ id: '11', type: 'file', name: 'Adobe Lightroom' },
{
id: '12',
type: 'file',
name: 'Adobe Dreamweaver'
}
]}
aria-label="Second Table"
/>
</div>import {isTextDropItem} from 'react-aria-components';
interface FileItem {
id: string;
name: string;
type: string;
}
interface DndTableProps {
initialItems:
FileItem[];
'aria-label': string;
}
function DndTable(
props: DndTableProps
) {
let list = useListData(
{
initialItems:
props
.initialItems
}
);
let {
dragAndDropHooks
} = useDragAndDrop({
// Provide drag data in a custom format as well as plain text.
getItems(keys) {
return [...keys]
.map((key) => {
let item = list
.getItem(
key
);
return {
'custom-app-type':
JSON
.stringify(
item
),
'text/plain':
item.name
};
});
},
// Accept drops with the custom format.
acceptedDragTypes: [
'custom-app-type'
],
// Ensure items are always moved rather than copied.
getDropOperation:
() => 'move',
// Handle drops between items from other lists.
async onInsert(e) {
let processedItems =
await Promise
.all(
e.items
.filter(
isTextDropItem
)
.map(
async (item) =>
JSON
.parse(
await item
.getText(
'custom-app-type'
)
)
)
);
if (
e.target
.dropPosition ===
'before'
) {
list
.insertBefore(
e.target.key,
...processedItems
);
} else if (
e.target
.dropPosition ===
'after'
) {
list.insertAfter(
e.target.key,
...processedItems
);
}
},
// Handle drops on the collection when empty.
async onRootDrop(e) {
let processedItems =
await Promise
.all(
e.items
.filter(
isTextDropItem
)
.map(
async (item) =>
JSON
.parse(
await item
.getText(
'custom-app-type'
)
)
)
);
list.append(
...processedItems
);
},
// Handle reordering items within the same list.
onReorder(e) {
if (
e.target
.dropPosition ===
'before'
) {
list.moveBefore(
e.target.key,
e.keys
);
} else if (
e.target
.dropPosition ===
'after'
) {
list.moveAfter(
e.target.key,
e.keys
);
}
},
// Remove the items from the source list on drop
// if they were moved to a different list.
onDragEnd(e) {
if (
e.dropOperation ===
'move' &&
!e.isInternal
) {
list.remove(
...e.keys
);
}
}
});
return (
<Table
aria-label={props[
'aria-label'
]}
selectionMode="multiple"
selectedKeys={list
.selectedKeys}
onSelectionChange={list
.setSelectedKeys}
dragAndDropHooks={dragAndDropHooks}
>
<TableHeader>
<Column />
<Column>
<MyCheckbox />
</Column>
<Column>
ID
</Column>
<Column
isRowHeader
>
Name
</Column>
<Column>
Type
</Column>
</TableHeader>
<TableBody
items={list
.items}
renderEmptyState={() =>
'Drop items here'}
>
{(item) => (
<Row>
<Cell>
<Button slot="drag">
≡
</Button>
</Cell>
<Cell>
<MyCheckbox />
</Cell>
<Cell>
{item.id}
</Cell>
<Cell>
{item.name}
</Cell>
<Cell>
{item.type}
</Cell>
</Row>
)}
</TableBody>
</Table>
);
}
<div
style={{
display: 'flex',
gap: 12,
flexWrap: 'wrap'
}}
>
<DndTable
initialItems={[
{
id: '1',
type: 'file',
name:
'Adobe Photoshop'
},
{
id: '2',
type: 'file',
name:
'Adobe XD'
},
{
id: '3',
type: 'folder',
name:
'Documents'
},
{
id: '4',
type: 'file',
name:
'Adobe InDesign'
},
{
id: '5',
type: 'folder',
name:
'Utilities'
},
{
id: '6',
type: 'file',
name:
'Adobe AfterEffects'
}
]}
aria-label="First Table"
/>
<DndTable
initialItems={[
{
id: '7',
type: 'folder',
name:
'Pictures'
},
{
id: '8',
type: 'file',
name:
'Adobe Fresco'
},
{
id: '9',
type: 'folder',
name: 'Apps'
},
{
id: '10',
type: 'file',
name:
'Adobe Illustrator'
},
{
id: '11',
type: 'file',
name:
'Adobe Lightroom'
},
{
id: '12',
type: 'file',
name:
'Adobe Dreamweaver'
}
]}
aria-label="Second Table"
/>
</div>Advanced customization#
Hooks#
If you need to customize things even further, such as accessing internal state or customizing DOM structure, you can drop down to the lower level Hook-based API. See useTable for more details.