TreeView

A tree view provides users with a way to navigate nested hierarchical information.

Example#

<TreeView
  aria-label="Example tree with static contents"
  defaultExpandedKeys={new Set(['documents', 'photos'])}
  height="size-4600"
  maxWidth="size-6000"
>
  <TreeViewItem id="documents" textValue="Documents">
    <Text>Documents</Text>
    <Folder />
    <TreeViewItem id="project-a" textValue="Project A">
      <Text>Project A</Text>
      <Folder />
      <TreeViewItem id="weekly-report" textValue="Weekly-Report">
        <Text>Weekly Report</Text>
        <FileTxt />
      </TreeViewItem>
    </TreeViewItem>
    <TreeViewItem id="document-1" textValue="Document 1">
      <Text>Document 1</Text>
      <FileTxt />
    </TreeViewItem>
    <TreeViewItem id="document-2" textValue="Document 2">
      <Text>Document 2</Text>
      <FileTxt />
    </TreeViewItem>
  </TreeViewItem>
  <TreeViewItem id="photos" textValue="Photos">
    <Text>Photos</Text>
    <Folder />
    <TreeViewItem id="image-1" textValue="Image 1">
      <Text>Image 1</Text>
      <Image />
    </TreeViewItem>
    <TreeViewItem id="image-2" textValue="Image 2">
      <Text>Image 2</Text>
      <Image />
    </TreeViewItem>
    <TreeViewItem id="image-3" textValue="Image 3">
      <Text>Image 3</Text>
      <Image />
    </TreeViewItem>
  </TreeViewItem>
</TreeView>

<TreeView
  aria-label="Example tree with static contents"
  defaultExpandedKeys={new Set(['documents', 'photos'])}
  height="size-4600"
  maxWidth="size-6000"
>
  <TreeViewItem id="documents" textValue="Documents">
    <Text>Documents</Text>
    <Folder />
    <TreeViewItem id="project-a" textValue="Project A">
      <Text>Project A</Text>
      <Folder />
      <TreeViewItem
        id="weekly-report"
        textValue="Weekly-Report"
      >
        <Text>Weekly Report</Text>
        <FileTxt />
      </TreeViewItem>
    </TreeViewItem>
    <TreeViewItem id="document-1" textValue="Document 1">
      <Text>Document 1</Text>
      <FileTxt />
    </TreeViewItem>
    <TreeViewItem id="document-2" textValue="Document 2">
      <Text>Document 2</Text>
      <FileTxt />
    </TreeViewItem>
  </TreeViewItem>
  <TreeViewItem id="photos" textValue="Photos">
    <Text>Photos</Text>
    <Folder />
    <TreeViewItem id="image-1" textValue="Image 1">
      <Text>Image 1</Text>
      <Image />
    </TreeViewItem>
    <TreeViewItem id="image-2" textValue="Image 2">
      <Text>Image 2</Text>
      <Image />
    </TreeViewItem>
    <TreeViewItem id="image-3" textValue="Image 3">
      <Text>Image 3</Text>
      <Image />
    </TreeViewItem>
  </TreeViewItem>
</TreeView>

<TreeView
  aria-label="Example tree with static contents"
  defaultExpandedKeys={new Set(
    [
      'documents',
      'photos'
    ]
  )}
  height="size-4600"
  maxWidth="size-6000"
>
  <TreeViewItem
    id="documents"
    textValue="Documents"
  >
    <Text>
      Documents
    </Text>
    <Folder />
    <TreeViewItem
      id="project-a"
      textValue="Project A"
    >
      <Text>
        Project A
      </Text>
      <Folder />
      <TreeViewItem
        id="weekly-report"
        textValue="Weekly-Report"
      >
        <Text>
          Weekly Report
        </Text>
        <FileTxt />
      </TreeViewItem>
    </TreeViewItem>
    <TreeViewItem
      id="document-1"
      textValue="Document 1"
    >
      <Text>
        Document 1
      </Text>
      <FileTxt />
    </TreeViewItem>
    <TreeViewItem
      id="document-2"
      textValue="Document 2"
    >
      <Text>
        Document 2
      </Text>
      <FileTxt />
    </TreeViewItem>
  </TreeViewItem>
  <TreeViewItem
    id="photos"
    textValue="Photos"
  >
    <Text>Photos</Text>
    <Folder />
    <TreeViewItem
      id="image-1"
      textValue="Image 1"
    >
      <Text>
        Image 1
      </Text>
      <Image />
    </TreeViewItem>
    <TreeViewItem
      id="image-2"
      textValue="Image 2"
    >
      <Text>
        Image 2
      </Text>
      <Image />
    </TreeViewItem>
    <TreeViewItem
      id="image-3"
      textValue="Image 3"
    >
      <Text>
        Image 3
      </Text>
      <Image />
    </TreeViewItem>
  </TreeViewItem>
</TreeView>

Content#

TreeView is a collection component that provides users with a way to navigate nested hierarchical information.

Basic usage of TreeView, seen in the example above, shows the use of a static collection where the contents of the TreeView are hard coded. Dynamic collections, as shown below, can be used when the options come from an external data source, such as an API, or update over time. Providing the data in this way allows TreeView to automatically cache the rendering of each item, which dramatically improves performance.

Items can be statically defined as children, or generated dynamically using a function based on the data passed to the items prop.

Each item has a unique key defined by the data. The key of each item element is implicitly defined by the id property of the item object. See collections to learn more about keys in dynamic collections.

type MyItem = {
  id: string;
  name: string;
  icon: JSX.Element;
  childItems?: MyItem[];
};

let items: MyItem[] = [
  {
    id: 'projects',
    name: 'Projects',
    icon: <Folder />,
    childItems: [
      { id: 'project-1', name: 'Project 1', icon: <FileTxt /> },
      {
        id: 'project-2',
        name: 'Project 2',
        icon: <Folder />,
        childItems: [
          { id: 'document-a', name: 'Document A', icon: <FileTxt /> },
          { id: 'document-b', name: 'Document B', icon: <FileTxt /> }
        ]
      }
    ]
  },
  {
    id: 'reports',
    name: 'Reports',
    icon: <Folder />,
    childItems: [
      { id: 'report-1', name: 'Reports 1', icon: <FileTxt /> }
    ]
  }
];

function ExampleTree(props) {
  return (
    <TreeView
      aria-label="Example tree with dynamic content"
      height="size-3000"
      maxWidth="size-6000"
      items={items}
      {...props}
    >
      {(item: MyItem) => (
        <TreeViewItem childItems={item.childItems} textValue={item.name}>
          <Text>{item.name}</Text>
          {item.icon}
        </TreeViewItem>
      )}
    </TreeView>
  );
}

type MyItem = {
  id: string;
  name: string;
  icon: JSX.Element;
  childItems?: MyItem[];
};

let items: MyItem[] = [
  {
    id: 'projects',
    name: 'Projects',
    icon: <Folder />,
    childItems: [
      {
        id: 'project-1',
        name: 'Project 1',
        icon: <FileTxt />
      },
      {
        id: 'project-2',
        name: 'Project 2',
        icon: <Folder />,
        childItems: [
          {
            id: 'document-a',
            name: 'Document A',
            icon: <FileTxt />
          },
          {
            id: 'document-b',
            name: 'Document B',
            icon: <FileTxt />
          }
        ]
      }
    ]
  },
  {
    id: 'reports',
    name: 'Reports',
    icon: <Folder />,
    childItems: [
      {
        id: 'report-1',
        name: 'Reports 1',
        icon: <FileTxt />
      }
    ]
  }
];

function ExampleTree(props) {
  return (
    <TreeView
      aria-label="Example tree with dynamic content"
      height="size-3000"
      maxWidth="size-6000"
      items={items}
      {...props}
    >
      {(item: MyItem) => (
        <TreeViewItem
          childItems={item.childItems}
          textValue={item.name}
        >
          <Text>{item.name}</Text>
          {item.icon}
        </TreeViewItem>
      )}
    </TreeView>
  );
}

type MyItem = {
  id: string;
  name: string;
  icon: JSX.Element;
  childItems?: MyItem[];
};

let items: MyItem[] = [
  {
    id: 'projects',
    name: 'Projects',
    icon: <Folder />,
    childItems: [
      {
        id: 'project-1',
        name:
          'Project 1',
        icon: (
          <FileTxt />
        )
      },
      {
        id: 'project-2',
        name:
          'Project 2',
        icon: <Folder />,
        childItems: [
          {
            id:
              'document-a',
            name:
              'Document A',
            icon: (
              <FileTxt />
            )
          },
          {
            id:
              'document-b',
            name:
              'Document B',
            icon: (
              <FileTxt />
            )
          }
        ]
      }
    ]
  },
  {
    id: 'reports',
    name: 'Reports',
    icon: <Folder />,
    childItems: [
      {
        id: 'report-1',
        name:
          'Reports 1',
        icon: (
          <FileTxt />
        )
      }
    ]
  }
];

function ExampleTree(
  props
) {
  return (
    <TreeView
      aria-label="Example tree with dynamic content"
      height="size-3000"
      maxWidth="size-6000"
      items={items}
      {...props}
    >
      {(
        item: MyItem
      ) => (
        <TreeViewItem
          childItems={item
            .childItems}
          textValue={item
            .name}
        >
          <Text>
            {item.name}
          </Text>
          {item.icon}
        </TreeViewItem>
      )}
    </TreeView>
  );
}

Internationalization#

To internationalize a TreeView, all text content within the TreeView should be localized. This includes the aria-label provided to the TreeView if any. For languages that are read right-to-left (e.g. Hebrew and Arabic), the layout of TreeView is automatically flipped.

Labeling#

Accessibility#

An aria-label must be provided to the TreeView for accessibility. If the TreeView is labeled by a separate element, an aria-labelledby prop must be provided using the id of the labeling element instead.

Expansion#

By default, TreeView items are initially collapsed. Use defaultExpandedKeys to provide a default set of expanded items. Note that the value of the expanded keys must match the id prop of the TreeViewItem.

The example below uses defaultExpandedKeys to select the items with keys "documents" and "photos".

<ExampleTree
  aria-label="Example tree with default expanded items"
  defaultExpandedKeys={['projects', 'reports']}/>

<ExampleTree
  aria-label="Example tree with default expanded items"
  defaultExpandedKeys={['projects', 'reports']}/>

<ExampleTree
  aria-label="Example tree with default expanded items"
  defaultExpandedKeys={[
    'projects',
    'reports'
  ]}/>

Controlled expansion#

To programmatically control item expansion, use the expandedKeys prop paired with the onExpandedChange callback. The key prop from the expanded items will be passed into the callback when the item is pressed, allowing you to update state accordingly.

Here is how you would control expansion for the above example.

function ControlledExpansion() {
  let [expandedKeys, setExpandedKeys] = React.useState<Set<Key>>(
    new Set(['projects', 'reports'])
  );

  return (
    <ExampleTree
      aria-label="Example tree with controlled expanded items"
      expandedKeys={expandedKeys}
      onExpandedChange={setExpandedKeys}    />
  );
}

function ControlledExpansion() {
  let [expandedKeys, setExpandedKeys] = React.useState<
    Set<Key>
  >(new Set(['projects', 'reports']));

  return (
    <ExampleTree
      aria-label="Example tree with controlled expanded items"
      expandedKeys={expandedKeys}
      onExpandedChange={setExpandedKeys}    />
  );
}

function ControlledExpansion() {
  let [
    expandedKeys,
    setExpandedKeys
  ] = React.useState<
    Set<Key>
  >(
    new Set([
      'projects',
      'reports'
    ])
  );

  return (
    <ExampleTree
      aria-label="Example tree with controlled expanded items"
      expandedKeys={expandedKeys}
      onExpandedChange={setExpandedKeys}    />
  );
}

Selection#

By default, TreeView doesn't allow item selection but this can be enabled using the selectionMode prop. Use defaultSelectedKeys to provide a default set of selected items. Note that the value of the selected keys must match the id prop of the TreeViewItem.

The example below enables multiple selection mode, and uses defaultSelectedKeys to select the items with keys "document-a" and "document-b".

<ExampleTree
  aria-label="Example tree with selection"
  defaultExpandedKeys={['projects', 'project-2']}
  selectionMode="multiple"
  defaultSelectedKeys={['document-a', 'document-b']}/>

<ExampleTree
  aria-label="Example tree with selection"
  defaultExpandedKeys={['projects', 'project-2']}
  selectionMode="multiple"
  defaultSelectedKeys={['document-a', 'document-b']}/>

<ExampleTree
  aria-label="Example tree with selection"
  defaultExpandedKeys={[
    'projects',
    'project-2'
  ]}
  selectionMode="multiple"
  defaultSelectedKeys={[
    'document-a',
    'document-b'
  ]}/>

Controlled selection#

To programmatically control item selection, use the selectedKeys prop paired with the onSelectionChange callback. The key prop from the selected items will be passed into the callback when the item is pressed, allowing you to update state accordingly.

Here is how you would control selection for the above example.

import type {Selection} from '@adobe/react-spectrum';

function ControlledSelection() {
  let [selectedKeys, setSelectedKeys] = React.useState<Selection>(
    new Set(['document-a', 'document-b'])
  );

  return (
    <ExampleTree
      aria-label="Example tree with controlled selection"
      defaultExpandedKeys={['projects', 'project-2']}
      selectionMode="multiple"
      selectedKeys={selectedKeys}
      onSelectionChange={setSelectedKeys}    />
  );
}

import type {Selection} from '@adobe/react-spectrum';

function ControlledSelection() {
  let [selectedKeys, setSelectedKeys] = React.useState<
    Selection
  >(new Set(['document-a', 'document-b']));

  return (
    <ExampleTree
      aria-label="Example tree with controlled selection"
      defaultExpandedKeys={['projects', 'project-2']}
      selectionMode="multiple"
      selectedKeys={selectedKeys}
      onSelectionChange={setSelectedKeys}    />
  );
}

import type {Selection} from '@adobe/react-spectrum';

function ControlledSelection() {
  let [
    selectedKeys,
    setSelectedKeys
  ] = React.useState<
    Selection
  >(
    new Set([
      'document-a',
      'document-b'
    ])
  );

  return (
    <ExampleTree
      aria-label="Example tree with controlled selection"
      defaultExpandedKeys={[
        'projects',
        'project-2'
      ]}
      selectionMode="multiple"
      selectedKeys={selectedKeys}
      onSelectionChange={setSelectedKeys}    />
  );
}

Single selection#

To limit users to selecting only a single item at a time, selectionMode can be set to single.

<ExampleTree
  aria-label="Example tree with single selection"
  defaultExpandedKeys={['projects', 'project-2']}
  selectionMode="single"/>

<ExampleTree
  aria-label="Example tree with single selection"
  defaultExpandedKeys={['projects', 'project-2']}
  selectionMode="single"/>

<ExampleTree
  aria-label="Example tree with single selection"
  defaultExpandedKeys={[
    'projects',
    'project-2'
  ]}
  selectionMode="single"/>

Disallow empty selection#

TreeView also supports a disallowEmptySelection prop which forces the user to have at least one item in the TreeView selected at all times. In this mode, if a single item is selected and the user presses it, it will not be deselected.

<ExampleTree
  aria-label="Example tree with disallowed empty selection"
  defaultExpandedKeys={['projects', 'project-2']}
  selectionMode="single"
  defaultSelectedKeys={['document-a']}
  disallowEmptySelection/>

<ExampleTree
  aria-label="Example tree with disallowed empty selection"
  defaultExpandedKeys={['projects', 'project-2']}
  selectionMode="single"
  defaultSelectedKeys={['document-a']}
  disallowEmptySelection/>

<ExampleTree
  aria-label="Example tree with disallowed empty selection"
  defaultExpandedKeys={[
    'projects',
    'project-2'
  ]}
  selectionMode="single"
  defaultSelectedKeys={[
    'document-a'
  ]}
  disallowEmptySelection/>

Disabled items#

You can disable specific items by providing an array of keys to TreeView via the disabledKeys prop. This will prevent items from being selectable as shown in the example below.

<ExampleTree
  aria-label="Example tree with disabled items"
  defaultExpandedKeys={['projects', 'project-2']}
  selectionMode="single"
  disabledKeys={['document-a', 'document-b']}/>

<ExampleTree
  aria-label="Example tree with disabled items"
  defaultExpandedKeys={['projects', 'project-2']}
  selectionMode="single"
  disabledKeys={['document-a', 'document-b']}/>

<ExampleTree
  aria-label="Example tree with disabled items"
  defaultExpandedKeys={[
    'projects',
    'project-2'
  ]}
  selectionMode="single"
  disabledKeys={[
    'document-a',
    'document-b'
  ]}/>

Highlight selection#

By default, TreeView uses the checkbox selection style, which includes a checkbox in each item for selection. When the selectionStyle prop is set to "highlight", the checkboxes are hidden, and the selected items are displayed with a highlighted background instead.

In addition to changing the appearance, the selection behavior also changes depending on the selectionStyle prop. In the default checkbox selection style, clicking, tapping, or pressing the Space or Enter keys toggles selection for the focused item. Using the arrow keys moves focus but does not change selection.

In the highlight selection style, however, clicking a item with the mouse replaces the selection with only that item. Using the arrow keys moves both focus and selection. To select multiple items, modifier keys such as Ctrl, Cmd, and Shift can be used. On touch screen devices, selection always behaves as toggle since modifier keys may not be available.

These selection styles implement the behaviors defined in Aria Practices.

<ExampleTree
  aria-label="Example tree with highlight selection"
  defaultExpandedKeys={['projects', 'project-2']}
  selectionMode="multiple"
  defaultSelectedKeys={['document-a', 'document-b']}
  selectionStyle="highlight"/>

<ExampleTree
  aria-label="Example tree with highlight selection"
  defaultExpandedKeys={['projects', 'project-2']}
  selectionMode="multiple"
  defaultSelectedKeys={['document-a', 'document-b']}
  selectionStyle="highlight"/>

<ExampleTree
  aria-label="Example tree with highlight selection"
  defaultExpandedKeys={[
    'projects',
    'project-2'
  ]}
  selectionMode="multiple"
  defaultSelectedKeys={[
    'document-a',
    'document-b'
  ]}
  selectionStyle="highlight"/>

Actions#

Item actions#

TreeView supports item actions via the onAction prop, which is useful for functionality such as navigation. When nothing is selected, the TreeView performs actions by default when clicking or tapping a item. Items may be selected using the checkbox, or by long pressing on touch devices. When at least one item is selected, the TreeView is in selection mode, and clicking or tapping a item 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 highlight selection style, where single clicking selects the item and actions are performed via double click. Touch and keyboard behaviors are unaffected.

<Flex direction="column" gap="size-300">
  <ExampleTree
    aria-label="Example tree with item actions and checkbox selection"
    defaultExpandedKeys={['projects', 'project-2']}
    selectionMode="multiple"
    onAction={key => alert(`Opening item ${key}...`)}  />
  <ExampleTree
    aria-label="Example tree with item actions and highlight selection"
    defaultExpandedKeys={['projects', 'project-2']}
    selectionMode="multiple"
    selectionStyle="highlight"
    onAction={key => alert(`Opening item ${key}...`)}  />
</Flex>

<Flex direction="column" gap="size-300">
  <ExampleTree
    aria-label="Example tree with item actions and checkbox selection"
    defaultExpandedKeys={['projects', 'project-2']}
    selectionMode="multiple"
    onAction={(key) => alert(`Opening item ${key}...`)}  />
  <ExampleTree
    aria-label="Example tree with item actions and highlight selection"
    defaultExpandedKeys={['projects', 'project-2']}
    selectionMode="multiple"
    selectionStyle="highlight"
    onAction={(key) => alert(`Opening item ${key}...`)}  />
</Flex>

<Flex
  direction="column"
  gap="size-300"
>
  <ExampleTree
    aria-label="Example tree with item actions and checkbox selection"
    defaultExpandedKeys={[
      'projects',
      'project-2'
    ]}
    selectionMode="multiple"
    onAction={(key) =>
      alert(
        `Opening item ${key}...`
      )}  />
  <ExampleTree
    aria-label="Example tree with item actions and highlight selection"
    defaultExpandedKeys={[
      'projects',
      'project-2'
    ]}
    selectionMode="multiple"
    selectionStyle="highlight"
    onAction={(key) =>
      alert(
        `Opening item ${key}...`
      )}  />
</Flex>

Links#

Tree items may also be links to another page or website. This can be achieved by passing the href prop to the <TreeViewItem> component. Links behave the same way as described above for item actions depending on the selectionMode and selectionStyle.

<TreeView
  aria-label="Example tree with links"
  defaultExpandedKeys={new Set(['bookmarks'])}
  height="size-2000"
  maxWidth="size-6000"
>
  <TreeViewItem id="bookmarks" textValue="Bookmarks">
    <Text>Bookmarks</Text>
    <Folder />
    <TreeViewItem
      href="https://adobe.com/"
      target="_blank"
      id="adobe"
      textValue="Adobe"
    >
      <Text>Adobe</Text>
      <GlobeOutline />
    </TreeViewItem>
    <TreeViewItem
      href="https://google.com/"
      target="_blank"
      id="google"
      textValue="Google"
    >
      <Text>Google</Text>
      <GlobeOutline />
    </TreeViewItem>
    <TreeViewItem
      href="https://nytimes.com/"
      target="_blank"
      id="nytimes"
      textValue="New York Times"
    >
      <Text>New York Times</Text>
      <GlobeOutline />
    </TreeViewItem>
  </TreeViewItem>
</TreeView>

<TreeView
  aria-label="Example tree with links"
  defaultExpandedKeys={new Set(['bookmarks'])}
  height="size-2000"
  maxWidth="size-6000"
>
  <TreeViewItem id="bookmarks" textValue="Bookmarks">
    <Text>Bookmarks</Text>
    <Folder />
    <TreeViewItem
      href="https://adobe.com/"
      target="_blank"
      id="adobe"
      textValue="Adobe"
    >
      <Text>Adobe</Text>
      <GlobeOutline />
    </TreeViewItem>
    <TreeViewItem
      href="https://google.com/"
      target="_blank"
      id="google"
      textValue="Google"
    >
      <Text>Google</Text>
      <GlobeOutline />
    </TreeViewItem>
    <TreeViewItem
      href="https://nytimes.com/"
      target="_blank"
      id="nytimes"
      textValue="New York Times"
    >
      <Text>New York Times</Text>
      <GlobeOutline />
    </TreeViewItem>
  </TreeViewItem>
</TreeView>

<TreeView
  aria-label="Example tree with links"
  defaultExpandedKeys={new Set(
    ['bookmarks']
  )}
  height="size-2000"
  maxWidth="size-6000"
>
  <TreeViewItem
    id="bookmarks"
    textValue="Bookmarks"
  >
    <Text>
      Bookmarks
    </Text>
    <Folder />
    <TreeViewItem
      href="https://adobe.com/"
      target="_blank"
      id="adobe"
      textValue="Adobe"
    >
      <Text>
        Adobe
      </Text>
      <GlobeOutline />
    </TreeViewItem>
    <TreeViewItem
      href="https://google.com/"
      target="_blank"
      id="google"
      textValue="Google"
    >
      <Text>
        Google
      </Text>
      <GlobeOutline />
    </TreeViewItem>
    <TreeViewItem
      href="https://nytimes.com/"
      target="_blank"
      id="nytimes"
      textValue="New York Times"
    >
      <Text>
        New York Times
      </Text>
      <GlobeOutline />
    </TreeViewItem>
  </TreeViewItem>
</TreeView>

Client side routing#

The <TreeViewItem> component works with frameworks and client side routers like Next.js and React Router. As with other React Spectrum components that support links, this works via the Provider component at the root of your app. See the client side routing guide to learn how to set this up.

With action groups#

<TreeView
  aria-label="Example tree with action groups"
  height="size-3000"
  maxWidth="size-6000"
  items={items}
>
  {(item: MyItem) => (
    <TreeViewItem childItems={item.childItems} textValue={item.name}>
      <Text>{item.name}</Text>
      {item.icon}
      <ActionGroup
        onAction={(key) => alert(`Item: ${item.id}, Action: ${key}`)}
      >
        <Item key="edit" textValue="Edit">
          <Edit />
          <Text>Edit</Text>
        </Item>
        <Item key="delete" textValue="Delete">
          <Delete />
          <Text>Delete</Text>
        </Item>
      </ActionGroup>
    </TreeViewItem>
  )}
</TreeView>

<TreeView
  aria-label="Example tree with action groups"
  height="size-3000"
  maxWidth="size-6000"
  items={items}
>
  {(item: MyItem) => (
    <TreeViewItem
      childItems={item.childItems}
      textValue={item.name}
    >
      <Text>{item.name}</Text>
      {item.icon}
      <ActionGroup
        onAction={(key) =>
          alert(`Item: ${item.id}, Action: ${key}`)}
      >
        <Item key="edit" textValue="Edit">
          <Edit />
          <Text>Edit</Text>
        </Item>
        <Item key="delete" textValue="Delete">
          <Delete />
          <Text>Delete</Text>
        </Item>
      </ActionGroup>
    </TreeViewItem>
  )}
</TreeView>

<TreeView
  aria-label="Example tree with action groups"
  height="size-3000"
  maxWidth="size-6000"
  items={items}
>
  {(item: MyItem) => (
    <TreeViewItem
      childItems={item
        .childItems}
      textValue={item
        .name}
    >
      <Text>
        {item.name}
      </Text>
      {item.icon}
      <ActionGroup
        onAction={(
          key
        ) =>
          alert(
            `Item: ${item.id}, Action: ${key}`
          )}
      >
        <Item
          key="edit"
          textValue="Edit"
        >
          <Edit />
          <Text>
            Edit
          </Text>
        </Item>
        <Item
          key="delete"
          textValue="Delete"
        >
          <Delete />
          <Text>
            Delete
          </Text>
        </Item>
      </ActionGroup>
    </TreeViewItem>
  )}
</TreeView>

With action menus#

<TreeView
  aria-label="Example tree with action menus"
  height="size-3000"
  maxWidth="size-6000"
  items={items}
>
  {(item: MyItem) => (
    <TreeViewItem childItems={item.childItems} textValue={item.name}>
      <Text>{item.name}</Text>
      {item.icon}
      <ActionMenu
        onAction={(key) => alert(`Item: ${item.id}, Action: ${key}`)}
      >
        <Item key="edit" textValue="Edit">
          <Edit />
          <Text>Edit</Text>
        </Item>
        <Item key="delete" textValue="Delete">
          <Delete />
          <Text>Delete</Text>
        </Item>
      </ActionMenu>
    </TreeViewItem>
  )}
</TreeView>

<TreeView
  aria-label="Example tree with action menus"
  height="size-3000"
  maxWidth="size-6000"
  items={items}
>
  {(item: MyItem) => (
    <TreeViewItem
      childItems={item.childItems}
      textValue={item.name}
    >
      <Text>{item.name}</Text>
      {item.icon}
      <ActionMenu
        onAction={(key) =>
          alert(`Item: ${item.id}, Action: ${key}`)}
      >
        <Item key="edit" textValue="Edit">
          <Edit />
          <Text>Edit</Text>
        </Item>
        <Item key="delete" textValue="Delete">
          <Delete />
          <Text>Delete</Text>
        </Item>
      </ActionMenu>
    </TreeViewItem>
  )}
</TreeView>

<TreeView
  aria-label="Example tree with action menus"
  height="size-3000"
  maxWidth="size-6000"
  items={items}
>
  {(item: MyItem) => (
    <TreeViewItem
      childItems={item
        .childItems}
      textValue={item
        .name}
    >
      <Text>
        {item.name}
      </Text>
      {item.icon}
      <ActionMenu
        onAction={(
          key
        ) =>
          alert(
            `Item: ${item.id}, Action: ${key}`
          )}
      >
        <Item
          key="edit"
          textValue="Edit"
        >
          <Edit />
          <Text>
            Edit
          </Text>
        </Item>
        <Item
          key="delete"
          textValue="Delete"
        >
          <Delete />
          <Text>
            Delete
          </Text>
        </Item>
      </ActionMenu>
    </TreeViewItem>
  )}
</TreeView>

Props#

TreeView props#

TreeViewItem props#

Visual options#

Empty state#

Use the renderEmptyState prop to customize what the TreeView will display if there are no items provided.

import {Content} from '@react-spectrum/view';
import {IllustratedMessage} from '@react-spectrum/illustratedmessage';
import NotFound from '@spectrum-icons/illustrations/NotFound';
import {Heading} from '@react-spectrum/text';

function renderEmptyState() {
  return (
    <IllustratedMessage>
      <NotFound />
      <Heading>No results</Heading>
      <Content>No results found</Content>
    </IllustratedMessage>
  );
}

<TreeView
  aria-label="Example tree for empty state"
  height="size-2400"
  maxWidth="size-6000"
  renderEmptyState={renderEmptyState}
>
  {[]}
</TreeView>

import {Content} from '@react-spectrum/view';
import {IllustratedMessage} from '@react-spectrum/illustratedmessage';
import NotFound from '@spectrum-icons/illustrations/NotFound';
import {Heading} from '@react-spectrum/text';

function renderEmptyState() {
  return (
    <IllustratedMessage>
      <NotFound />
      <Heading>No results</Heading>
      <Content>No results found</Content>
    </IllustratedMessage>
  );
}

<TreeView
  aria-label="Example tree for empty state"
  height="size-2400"
  maxWidth="size-6000"
  renderEmptyState={renderEmptyState}
>
  {[]}
</TreeView>

import {Content} from '@react-spectrum/view';
import {IllustratedMessage} from '@react-spectrum/illustratedmessage';
import NotFound from '@spectrum-icons/illustrations/NotFound';
import {Heading} from '@react-spectrum/text';

function renderEmptyState() {
  return (
    <IllustratedMessage>
      <NotFound />
      <Heading>
        No results
      </Heading>
      <Content>
        No results found
      </Content>
    </IllustratedMessage>
  );
}

<TreeView
  aria-label="Example tree for empty state"
  height="size-2400"
  maxWidth="size-6000"
  renderEmptyState={renderEmptyState}
>
  {[]}
</TreeView>

Testing#

The TreeView features long press interactions on its items depending on the item actions provided and if user is interacting with the list on a touch device. Please see the following sections in the testing docs for more information on how to handle these behaviors in your test suite.

Timers

Desktop vs Mobile

Long press

Please also refer to React Spectrum's test suite if you find that the above isn't sufficient when resolving issues in your own test cases.