React Arborist

See the Demos

The tree view is ubiquitous in software applications. This library provides the React ecosystem with a complete solution to build the equivalent of a VSCode sidebar, Mac Finder, Windows Explorer, or Sketch/Figma layers panel.

Here is a Gmail sidebar clone built with react-arborist.

Features

• Drag and drop sorting
• Open/close folders
• Inline renaming
• Virtualized rendering
• Custom styling
• Keyboard navigation
• Aria attributes
• Tree filtering
• Selection synchronization
• Callbacks (onScroll, onActivate, onSelect)
• Controlled or uncontrolled trees

Installation

yarn add react-arborist

npm install react-arborist

Examples

Assume our data is this:

1const data = [
2  { id: "1", name: "Unread" },
3  { id: "2", name: "Threads" },
4  {
5    id: "3",
6    name: "Chat Rooms",
7    children: [
8      { id: "c1", name: "General" },
9      { id: "c2", name: "Random" },
10      { id: "c3", name: "Open Source Projects" },
11    ],
12  },
13  {
14    id: "4",
15    name: "Direct Messages",
16    children: [
17      { id: "d1", name: "Alice" },
18      { id: "d2", name: "Bob" },
19      { id: "d3", name: "Charlie" },
20    ],
21  },
22];

The Simplest Tree

Use all the defaults. The initialData prop makes the tree an uncontrolled component. Create, move, rename, and delete will be handled internally.

1import { Tree } from 'react-arborist';
2
3function App() {
4  return <Tree initialData={data} />;
5}

Demo

Customize the Appearance

We provide our own dimensions and our own Node component.

1function App() {
2  return (
3    <Tree
4      initialData={data}
5      openByDefault={false}
6      width={600}
7      height={1000}
8      indent={24}
9      rowHeight={36}
10      overscanCount={1}
11      paddingTop={30}
12      paddingBottom={10}
13      padding={25 /* sets both */}
14    >
15      {Node}
16    </Tree>
17  );
18}
19
20function Node({ node, style, dragHandle }) {
21  /* This node instance can do many things. See the API reference. */
22  return (
23    <div style={style} ref={dragHandle}>
24      {node.isLeaf ? "🍁" : "🗀"}
25      {node.data.name}
26    </div>
27  );
28}

Demo

Control the Tree data

Here we use the data prop to make the tree a controlled component. We must handle all the data modifications ourselves using the props below.

1function App() {
2  /* Handle the data modifications outside the tree component */
3  const onCreate = ({ parentId, index, type }) => {};
4  const onRename = ({ id, name }) => {};
5  const onMove = ({ dragIds, parentId, index }) => {};
6  const onDelete = ({ ids }) => {};
7
8  return (
9    <Tree
10      data={data}
11      onCreate={onCreate}
12      onRename={onRename}
13      onMove={onMove}
14      onDelete={onDelete}
15    />
16  );
17}

Tree Filtering

Providing a non-empty searchTerm will only show nodes that match. If a child matches, all its parents also match. Internal nodes are opened when filtering. You can provide your own searchMatch function, or use the default.

1function App() {
2  const term = useSearchTermString()
3  <Tree
4    data={data}
5    searchTerm={term}
6    searchMatch={
7      (node, term) => node.data.name.toLowerCase().includes(term.toLowerCase())
8    }
9  />
10}

Sync the Selection

It's common to open something elsewhere in the app, but have the tree reflect the new selection.

Passing an id to the selection prop will select and scroll to that node whenever that id changes.

1function App() {
2  const chatId = useCurrentChatId();
3
4  /* 
5    Whenever the currentChatRoomId changes, 
6    the tree will automatically select it and scroll to it. 
7  */
8
9  return <Tree initialData={data} selection={chatId} />;
10}

Use the Tree Api Instance

You can access the Tree Api in the parent component by giving a ref to the tree.

1function App() {
2  const treeRef = useRef();
3
4  useEffect(() => {
5    const tree = treeRef.current;
6    tree.selectAll();
7    /* See the Tree API reference for all you can do with it. */
8  }, []);
9
10  return <Tree initialData={data} ref={treeRef} />;
11}

Data with Different Property Names

The idAccessor and childrenAccessor props allow you to specify the children and id fields in your data.

1function App() {
2  const data = [
3    {
4      category: "Food",
5      subCategories: [{ category: "Restaurants" }, { category: "Groceries" }],
6    },
7  ];
8  return (
9    <Tree
10      data={data}
11      /* An accessor can provide a string property name */
12      idAccessor="category"
13      /* or a function with the data as the argument */
14      childrenAccessor={(d) => d.subCategories}
15    />
16  );
17}

Custom Rendering

Render every single piece of the tree yourself. See the API reference for the props passed to each renderer.

1function App() {
2  return (
3    <Tree
4      data={data}
5      /* The outer most element in the list */
6      renderRow={MyRow}
7      /* The "ghost" element that follows the mouse as you drag */
8      renderDragPreview={MyDragPreview}
9      /* The line that shows where an element will be dropped */
10      renderCursor={MyCursor}
11    >
12      {/* The inner element that shows the indentation and data */}
13      {MyNode}
14    </Tree>
15  );
16}

Dynamic sizing

You can add a ref to it with this package ZeeCoder/use-resize-observer

That hook will return the height and width of the parent whenever it changes. You then pass these numbers to the Tree.

1const { ref, width, height } = useResizeObserver();
2 
3<div className="parent" ref={ref}>
4  <Tree height={height} width={width} />
5</div>

API Reference

• Components
  • Tree Component Props
  • Row Component Props
  • Node Component Props
  • DragPreview Component Props
  • Cursor Component Props
• Interfaces
  • Node API
  • Tree API

Tree Component Props

These are all the props you can pass to the Tree component.

1interface TreeProps<T> {
2  /* Data Options */
3  data?: readonly T[];
4  initialData?: readonly T[];
5
6  /* Data Handlers */
7  onCreate?: handlers.CreateHandler<T>;
8  onMove?: handlers.MoveHandler<T>;
9  onRename?: handlers.RenameHandler<T>;
10  onDelete?: handlers.DeleteHandler<T>;
11
12  /* Renderers*/
13  children?: ElementType<renderers.NodeRendererProps<T>>;
14  renderRow?: ElementType<renderers.RowRendererProps<T>>;
15  renderDragPreview?: ElementType<renderers.DragPreviewProps>;
16  renderCursor?: ElementType<renderers.CursorProps>;
17  renderContainer?: ElementType<{}>;
18
19  /* Sizes */
20  rowHeight?: number;
21  overscanCount?: number;
22  width?: number | string;
23  height?: number;
24  indent?: number;
25  paddingTop?: number;
26  paddingBottom?: number;
27  padding?: number;
28
29  /* Config */
30  childrenAccessor?: string | ((d: T) => T[] | null);
31  idAccessor?: string | ((d: T) => string);
32  openByDefault?: boolean;
33  selectionFollowsFocus?: boolean;
34  disableMultiSelection?: boolean;
35  disableEdit?: string | boolean | BoolFunc<T>;
36  disableDrag?: string | boolean | BoolFunc<T>;
37  disableDrop?:
38    | string
39    | boolean
40    | ((args: {
41        parentNode: NodeApi<T>;
42        dragNodes: NodeApi<T>[];
43        index: number;
44      }) => boolean);
45
46  /* Event Handlers */
47  onActivate?: (node: NodeApi<T>) => void;
48  onSelect?: (nodes: NodeApi<T>[]) => void;
49  onScroll?: (props: ListOnScrollProps) => void;
50  onToggle?: (id: string) => void;
51  onFocus?: (node: NodeApi<T>) => void;
52
53  /* Selection */
54  selection?: string;
55
56  /* Open State */
57  initialOpenState?: OpenMap;
58
59  /* Search */
60  searchTerm?: string;
61  searchMatch?: (node: NodeApi<T>, searchTerm: string) => boolean;
62
63  /* Extra */
64  className?: string | undefined;
65  rowClassName?: string | undefined;
66
67  dndRootElement?: globalThis.Node | null;
68  onClick?: MouseEventHandler;
69  onContextMenu?: MouseEventHandler;
70  dndManager?: DragDropManager;
71}

Row Component Props

The <RowRenderer> is responsible for attaching the drop ref, the row style (top, height) and the aria-attributes. The default should work fine for most use cases, but it can be replaced by your own component if you need. See the renderRow prop in the <Tree> component.

1type RowRendererProps<T> = {
2  node: NodeApi<T>;
3  innerRef: (el: HTMLDivElement | null) => void;
4  attrs: HTMLAttributes<any>;
5  children: ReactElement;
6};

Node Component Props

The <NodeRenderer> is responsible for attaching the drag ref, the node style (padding for indentation), the visual look of the node, the edit input of the node, and anything else you can dream up.

There is a default renderer, but it's only there as a placeholder to get started. You'll want to create your own component for this. It is passed as the <Tree> components only child.

1export type NodeRendererProps<T> = {
2  style: CSSProperties;
3  node: NodeApi<T>;
4  tree: TreeApi<T>;
5  dragHandle?: (el: HTMLDivElement | null) => void;
6  preview?: boolean;
7};

DragPreview Component Props

The <DragPreview> is responsible for showing a "ghost" version of the node being dragged. The default is a semi-transparent version of the NodeRenderer and should work fine for most people. To customize it, pass your new component to the renderDragPreview prop.

1type DragPreviewProps = {
2  offset: XYCoord | null;
3  mouse: XYCoord | null;
4  id: string | null;
5  dragIds: string[];
6  isDragging: boolean;
7};

Cursor Component Props

The <Cursor> is responsible for showing a line that indicates where the node will move to when it's dropped. The default is a blue line with circle on the left side. You may want to customize this. Pass your own component to the renderCursor prop.

1export type CursorProps = {
2  top: number;
3  left: number;
4  indent: number;
5};

Node API Reference

State Properties

All these properties on the node instance return booleans related to the state of the node.

node.isRoot

Returns true if this is the root node. The root node is added internally by react-arborist and not shown in the UI.

node.isLeaf

Returns true if the children property is not an array.

node.isInternal

Returns true if the children property is an array.

node.isOpen

Returns true if node is internal and in an open state.

node.isEditing

Returns true if this node is currently being edited. Use this property in the NodeRenderer to render the rename form.

node.isSelected

Returns true if node is selected.

node.isSelectedStart

Returns true if node is the first of a contiguous group of selected nodes. Useful for styling.

node.isSelectedEnd

Returns true if node is the last of a contiguous group of selected nodes. Useful for styling.

node.isOnlySelection

Returns true if node is the only node selected in the tree.

node.isFocused

Returns true if node is focused.

node.isDragging

Returns true if node is being dragged.

node.willReceiveDrop

Returns true if node is internal and the user is hovering a dragged node over it.

node.state

Returns an object with all the above properties as keys and boolean values. Useful for adding class names to an element with a library like clsx or classnames.

1type NodeState = {
2  isEditing: boolean;
3  isDragging: boolean;
4  isSelected: boolean;
5  isSelectedStart: boolean;
6  isSelectedEnd: boolean;
7  isFocused: boolean;
8  isOpen: boolean;
9  isClosed: boolean;
10  isLeaf: boolean;
11  isInternal: boolean;
12  willReceiveDrop: boolean;
13};

Accessors

node.childIndex

Returns the node's index in relation to its siblings.

node.next

Returns the next visible node. The node directly under this node in the tree component. Returns null if none exist.

node.prev

Returns the previous visible node. The node directly above this node in the tree component. Returns null if none exist.

node.nextSibling

Returns the next sibling in the data of this node. Returns null if none exist.

Selection Methods

node.select()

Select only this node.

node.deselect()

Deselect this node. Other nodes may still be selected.

node.selectMulti()

Select this node while maintaining all other selections.

node.selectContiguous()

Deselect all nodes from the anchor node to the last selected node, the select all nodes from the anchor node to this node. The anchor changes to the focused node after calling select() or selectMulti().

Activation Methods

node.activate()

Runs the Tree props' onActivate callback passing in this node.

node.focus()

Focus this node.

Open/Close Methods

node.open()

Opens the node if it is an internal node.

node.close()

Closes the node if it is an internal node.

node.toggle()

Toggles the open/closed state of the node if it is an internal node.

node.openParents()

Opens all the parents of this node.

node.edit()

Moves this node into the editing state. Calling node.isEditing will return true.

node.submit(newName)

Submits newName string to the onRename handler. Moves this node out of the editing state.

node.reset()

Moves this node out of the editing state without submitting a new name.

Event Handlers

node.handleClick(event)

Useful for using the standard selection methods when a node is clicked. If the meta key is down, call multiSelect(). If the shift key is down, call selectContiguous(). Otherwise, call select() and activate().

Tree API Reference

The tree api reference is stable across re-renders. It always has the most recent state and props.

Node Accessors

tree.get(id) : NodeApi | null

Get node by id from the visibleNodes array.

tree.at(index) : NodeApi | null

Get node by index from the visibleNodes array.

tree.visibleNodes : NodeApi[]

Returns an array of the visible nodes.

tree.firstNode : NodeApi | null

The first node in the visibleNodes array.

tree.lastNode : NodeApi | null

The last node in the visibleNodes array.

tree.focusedNode : NodeApi | null

The currently focused node.

tree.mostRecentNode : NodeApi | null

The most recently selected node.

tree.nextNode : NodeApi | null

The node directly after the focusedNode in the visibleNodes array.

tree.prevNode : NodeApi | null

The node directly before the focusedNode in the visibleNodes array.

Focus Methods

tree.hasFocus : boolean

Returns true if the the tree has focus somewhere within it.

tree.focus(id)

Focus on the node with id.

tree.isFocused(id) : boolean

Check if the node with id is focused.

tree.pageUp()

Move focus up one page.

tree.pageDown()

Move focus down one page.

Selection Methods

tree.selectedIds : Set<string>

Returns a set of ids that are selected.

tree.selectedNodes : NodeApi[]

Returns an array of nodes that are selected.

tree.hasNoSelection : boolean

Returns true if nothing is selected in the tree.

tree.hasSingleSelection : boolean

Returns true if there is only one selection.

tree.hasMultipleSelections : boolean

Returns true if there is more than one selection.

tree.isSelected(id) : boolean

Returns true if the node with id is selected.

tree.select(id)

Select only the node with id.

tree.deselect(id)

Deselect the node with id.

tree.selectMulti(id)

Add to the selection the node with id.

tree.selectContiguous(id)

Deselected nodes between the anchor and the last selected node, then select the nodes between the anchor and the node with id.

tree.deselectAll()

Deselect all nodes.

tree.selectAll()

Select all nodes.

Visibility

tree.open(id)

Open the node with id.

tree.close(id)

Close the node with id.

tree.toggle(id)

Toggle the open state of the node with id.

tree.openParents(id)

Open all parents of the node with id.

tree.openSiblings(id)

Open all siblings of the node with id.

tree.openAll()

Open all internal nodes.

tree.closeAll()

Close all internal nodes.

tree.isOpen(id) : boolean

Returns true if the node with id is open.

Drag and Drop

tree.isDragging(id) : boolean

Returns true if the node with id is being dragged.

tree.willReceiveDrop(id) : boolean

Returns true if the node with id is internal and is under the dragged node.

Scrolling

tree.scrollTo(id, [align])

Scroll to the node with id. If this node is not visible, this method will open all its parents. The align argument can be "auto" | "smart" | "center" | "end" | "start".

Properties

tree.isEditing : boolean

Returns true if the tree is editing a node.

tree.isFiltered : boolean

Returns true if the searchTerm prop is not an empty string when trimmed.

tree.props : TreeProps

Returns all the props that were passed to the <Tree> component.

tree.root : NodeApi

Returns the root NodeApi instance. Its children are the Node representations of the data prop array.

Author

James Kerr at Brim Data for the Zui desktop app.