Direactree

Rows, menus & toolbox

Show file type icons, Git status, error counts, and sizes on each row, add your own right-click items, and put your own buttons in the toolbox.

Your own data

TreeNode takes a type parameter for a data field. Direactree passes it through untouched, so the render functions below can read it with full types:

type FileData = { git?: "M" | "A" | "U"; errors?: number; size?: string };

const structure: TreeNode<FileData>[] = [
  { id: "button", name: "Button.tsx", type: "file", data: { git: "M", errors: 2 } },
];

<Direactree<FileData> structure={structure} renderBadge={(node) => node.data?.git} />

Row slots

Four optional functions shape each row. Each receives the node and its state: { expanded, selected, depth }.

PropPlacesTypical use
renderIcon(node, state)Before the name, after the folder arrowFile type icons, open and closed folder icons
renderLabel(node, state)Replaces the nameExtra text such as a size. state.highlighted already holds the search mark, and state.term the search term.
renderBadge(node, state)After the name, at the end of the rowGit status, error counts, unsaved dots
getRowClassName(node, state)A class on the rowColor modified files, dim ignored ones
<Direactree<FileData>
  structure={structure}
  renderIcon={(node, { expanded }) => <FileIcon node={node} expanded={expanded} />}
  renderBadge={(node) => (
    <>
      {node.data?.errors ? <span className="error-badge">{node.data.errors}</span> : null}
      {node.data?.git ? <span className={`git-${node.data.git}`}>{node.data.git}</span> : null}
    </>
  )}
  renderLabel={(node, { highlighted }) => (
    <>
      {highlighted}
      <small>{node.data?.size}</small>
    </>
  )}
  getRowClassName={(node) => (node.data?.git === "M" ? "row-modified" : undefined)}
/>
TRY ITIcons, badges, labels, row classes

Your fields live in TreeNode.data. Turn each slot on and off to see what it controls.

  • my-app
  • src
  • components
  • Button.tsx3.1 KB2M
  • Modal.tsx5.8 KBA
  • Tooltip.tsx1.2 KB
  • index.ts0.4 KB
  • styles.css2.2 KBM
  • package.json1.4 KBM
  • README.md2.7 KB
props
<Direactree<FileData>
  structure={structure}
  renderIcon={(node, { expanded }) => <FileIcon node={node} expanded={expanded} />}
  renderBadge={(node) => <FileBadges node={node} />}
  renderLabel={(node, { highlighted }) => <>{highlighted}<small>{node.data?.size}</small></>}
  getRowClassName={(node) => node.data?.git === "M" ? "row-modified" : undefined}
/>

The accessible name of each row stays the node name, so icons and badges can be decorative. Give a badge a title when its meaning is not obvious.

Context menu

contextMenu shows a menu on right-click, Shift+F10, or the menu key. true shows the built-in items: Create Folder and Create File on folders, Rename, and Delete. They follow permissions and handlers, and turn off while a request is pending.

Pass a function to change the list. It receives the node, the built-in items, and the node's path:

<Direactree
  structure={structure}
  contextMenu={(node, defaults, path) => [
    ...defaults,
    "separator",
    { id: "copy", label: "Copy path", icon: <CopyIcon />, onSelect: (target, path) => copy(path) },
    { id: "reveal", label: "Reveal in Finder", disabled: node.type === "file", onSelect: openFolder },
  ]}
/>
type ContextMenuEntry =
  | {
      id: string;
      label: React.ReactNode;
      icon?: React.ReactNode;
      disabled?: boolean;
      danger?: boolean;
      onSelect: (node: TreeNode, path: NodePath) => void;
    }
  | "separator";
TRY ITContext menu

Right-click a row, or focus it and press Shift+F10 or the menu key. Arrow keys move through the items and Escape closes the menu.

  • my-app
  • src
  • components
  • Button.tsx
  • Modal.tsx
  • Tooltip.tsx
  • index.ts
  • styles.css
  • package.json
  • README.md
custom items
Nothing yet. Use the tree.

The menu takes ↑, ↓, Home, End, Enter, and Escape, which returns focus to the row. It closes on scroll and on a click outside. Without contextMenu, the browser menu is left alone.

Toolbox actions

toolboxActions adds buttons after the built-in ones. onClick and a disabled function receive the focused node and every selected id:

<Direactree
  ref={ref}
  structure={structure}
  selectionMode="multiple"
  toolboxActions={[
    { id: "collapse", label: "Collapse all", icon: <CollapseIcon />, onClick: () => ref.current?.collapseAll() },
    {
      id: "delete-selected",
      label: "Delete selected",
      icon: <TrashIcon />,
      disabled: (_node, ids) => ids.length < 2,
      onClick: (_node, ids) => deleteMany(ids),
    },
  ]}
/>
TRY ITToolbox actions

Four extra buttons after the built-in ones. Each receives the focused node and every selected id. Ctrl/Cmd+click to select several files, then delete them at once.

  • my-app
  • src
  • components
  • Button.tsx
  • Modal.tsx
  • Tooltip.tsx
  • index.ts
  • styles.css
  • package.json
  • README.md
toolboxActions
Nothing yet. Use the tree.

label is the button's accessible name and tooltip. The built-in buttons can get your own icons through toolboxIcons, and the whole toolbox can be hidden with showToolbox={false}.