react-sortable-tree vs react-treebeard
Building Interactive Tree Structures in React
react-sortable-treereact-treebeardSimilar Packages:

Building Interactive Tree Structures in React

react-sortable-tree and react-treebeard are both React libraries designed to render hierarchical data structures, commonly known as trees. react-sortable-tree focuses heavily on drag-and-drop functionality, allowing users to reorder nodes and change parent-child relationships visually. It is often used for file explorers or permission management UIs. react-treebeard prioritizes smooth animations and a clean, collapsible tree view, making it suitable for navigation menus or data grids where visual feedback on expansion is key. Both libraries abstract away the complex recursion logic needed to render nested components, but they approach state management and customization differently.

Npm Package Weekly Downloads Trend

3 Years

Github Stars Ranking

Stat Detail

Package
Downloads
Stars
Size
Issues
Publish
License
react-sortable-tree04,969-3516 years agoMIT
react-treebeard01,686-727 years agoMIT

react-sortable-tree vs react-treebeard: Architecture and Use Cases

Both react-sortable-tree and react-treebeard solve the same fundamental problem: displaying nested data in a React application. However, they target different interaction models. One focuses on moving data around, while the other focuses on viewing data clearly. Let's look at how they handle rendering, state, and interaction.

🗂️ Data Structure and State Management

react-sortable-tree expects a specific array of objects where children are nested inside a children property. It manages the tree state internally but requires you to pass the updated tree back via an onChange callback.

// react-sortable-tree: Data shape
const treeData = [
  {
    title: 'Parent',
    children: [
      { title: 'Child 1' },
      { title: 'Child 2' }
    ]
  }
];

// Usage
<SortableTree
  treeData={treeData}
  onChange={newTree => setTreeData(newTree)}
/>

react-treebeard also uses a nested structure but relies on a data prop. It handles toggle state internally by default, though you can control it. The data structure is similar but often requires specific flags like expanded or active on nodes for styling.

// react-treebeard: Data shape
const data = [
  {
    name: 'Parent',
    children: [
      { name: 'Child 1' },
      { name: 'Child 2' }
    ]
  }
];

// Usage
<Treebeard
  data={data}
  onToggle={(node, toggled) => handleToggle(node, toggled)}
/>

🖱️ Interaction Model: Drag-and-Drop vs. Click-to-Expand

react-sortable-tree is built around drag-and-drop. It uses HTML5 DnD API under the hood. You get reordering and reparenting out of the box. This adds weight to the bundle but saves weeks of development time for complex move logic.

// react-sortable-tree: Enabling drag and drop
<SortableTree
  treeData={treeData}
  onChange={setTreeData}
  canDrag={({ node }) => node.title !== 'Locked'}
  canDrop={({ nextParent }) => nextParent && nextParent.title !== 'Restricted'}
/>

react-treebeard focuses on clicking to expand or collapse nodes. It does not support drag-and-drop natively. The interaction is simpler and feels snappier for read-only or light-interaction trees. Animations are CSS-based and smooth.

// react-treebeard: Handling toggle interaction
const handleToggle = (node, toggled) => {
  if (node.children) {
    node.active = !node.active;
    node.expanded = !node.expanded;
    setData([...data]);
  }
};

<Treebeard data={data} onToggle={handleToggle} />

🎨 Customization and Rendering

react-sortable-tree allows you to customize how each node looks using generateNodeProps. You can inject custom buttons, icons, or inputs into the row. However, deep styling changes can be tricky because the library wraps nodes in several layers of divs.

// react-sortable-tree: Custom node content
<SortableTree
  treeData={treeData}
  generateNodeProps={({ node }) => ({
    buttons: [
      <button onClick={() => deleteNode(node)}>Delete</button>
    ],
    className: node.type === 'special' ? 'special-node' : ''
  })}
/>

react-treebeard uses a theme system. You pass a theme object to change colors, spacing, and animations. For structural changes, you can provide custom components for the node itself, but it requires adhering to their specific component interface.

// react-treebeard: Custom theming
const customTheme = {
  tree: { base: { listStyle: 'none' } },
  node: { base: { fontFamily: 'sans-serif' } }
};

<Treebeard data={data} theme={customTheme} />

⚠️ Maintenance and React Compatibility

This is the most critical factor for architectural decisions today.

react-sortable-tree (original package) has not seen significant updates in several years. It relies on older React patterns (class components, legacy context). This can cause warnings in React 18+ and may break with future major versions. The community maintains a fork at @frontend-collective/react-sortable-tree which fixes many bugs and adds Hooks support.

// Warning: Original package may show legacy warnings
import SortableTree from 'react-sortable-tree'; 

// Recommended for new work if sticking to this lib
import SortableTree from '@frontend-collective/react-sortable-tree';

react-treebeard is also an older library. It works in React 18 but development has slowed. It does not fully embrace modern React patterns like Hooks for its internal logic. If you need a tree that integrates deeply with modern state managers (Zustand, Redux Toolkit), you might find the internal state management of react-treebeard gets in the way.

// react-treebeard: Works but lacks modern Hook APIs
// You often wrap it to control state externally
const ControlledTree = () => {
  const [data, setData] = useState(initialData);
  return <Treebeard data={data} onToggle={...} />;
};

📊 Summary: Key Differences

Featurereact-sortable-treereact-treebeard
Primary Goal🖱️ Drag-and-drop reordering👁️ Animated viewing & navigation
Data ProptreeData (array)data (array)
State ControlonChange callbackonToggle callback
StylingInline props & CSS classesTheme object system
Maintenance⚠️ Legacy (Use fork for new projects)⚠️ Legacy (Stable but slow updates)
Bundle WeightHeavier (DnD logic included)Lighter (View logic only)

💡 The Big Picture

react-sortable-tree is the heavy lifter. If your users need to organize files, manage permissions, or build sitemaps by dragging items, this is the tool. Just be sure to use the maintained fork to avoid technical debt.

react-treebeard is the viewer. If you need a sidebar navigation, a JSON explorer, or a simple category selector, this library provides a polished look with minimal setup. It is less intrusive but also less flexible for complex interactions.

Final Thought: Both libraries are veterans of the React ecosystem. For brand new projects in 2024 and beyond, consider if you truly need a dedicated tree library. Modern tools like @dnd-kit combined with a custom recursive component might offer better long-term control and smaller bundle sizes. However, if you need a solution today that works reliably, these two remain functional choices with clear trade-offs.

How to Choose: react-sortable-tree vs react-treebeard

  • react-sortable-tree:

    Choose react-sortable-tree if your primary requirement is robust drag-and-drop reordering of tree nodes without building the logic from scratch. It is best suited for admin panels where users need to reorganize hierarchies frequently. However, be aware that the original package is largely unmaintained; for new projects, consider the community fork @frontend-collective/react-sortable-tree or modern alternatives like react-arborist to ensure long-term compatibility with React versions.

  • react-treebeard:

    Choose react-treebeard if you need a lightweight, animated tree view where drag-and-drop is not a requirement. It works well for read-heavy interfaces like documentation navigation or settings menus. Like react-sortable-tree, this package sees infrequent updates, so evaluate if its feature set meets your needs without requiring active maintenance support. If you need heavy customization or React Hooks support, you may need to wrap it carefully or look for newer solutions.

README for react-sortable-tree

React Sortable Tree

NPM version NPM license NPM total downloads NPM monthly downloads Build Status Coverage Status PRs Welcome

A React component for Drag-and-drop sortable representation of hierarchical data. Checkout the Storybook for a demonstration of some basic and advanced features.

Table of Contents

Getting started

Install react-sortable-tree using npm.

# NPM
npm install react-sortable-tree --save

# YARN
yarn add react-sortable-tree

ES6 and CommonJS builds are available with each distribution. For example:

// This only needs to be done once; probably during your application's bootstrapping process.
import 'react-sortable-tree/style.css';

// You can import the default tree with dnd context
import SortableTree from 'react-sortable-tree';

// Or you can import the tree without the dnd context as a named export. eg
import { SortableTreeWithoutDndContext as SortableTree } from 'react-sortable-tree';

// Importing from cjs (default)
import SortableTree from 'react-sortable-tree/dist/index.cjs.js';
import SortableTree from 'react-sortable-tree';

// Importing from esm
import SortableTree from 'react-sortable-tree/dist/index.esm.js';

Usage

import React, { Component } from 'react';
import SortableTree from 'react-sortable-tree';
import 'react-sortable-tree/style.css'; // This only needs to be imported once in your app

export default class Tree extends Component {
  constructor(props) {
    super(props);

    this.state = {
      treeData: [
        { title: 'Chicken', children: [{ title: 'Egg' }] },
        { title: 'Fish', children: [{ title: 'fingerline' }] },
      ],
    };
  }

  render() {
    return (
      <div style={{ height: 400 }}>
        <SortableTree
          treeData={this.state.treeData}
          onChange={treeData => this.setState({ treeData })}
        />
      </div>
    );
  }
}

Props

PropType
Description
treeData
(required)
object[]Tree data with the following keys:
title is the primary label for the node.
subtitle is a secondary label for the node.
expanded shows children of the node if true, or hides them if false. Defaults to false.
children is an array of child nodes belonging to the node.
Example: [{title: 'main', subtitle: 'sub'}, { title: 'value2', expanded: true, children: [{ title: 'value3') }] }]
onChange
(required)
funcCalled whenever tree data changed. Just like with React input elements, you have to update your own component's data to see the changes reflected.
( treeData: object[] ): void
getNodeKey
(recommended)
funcSpecify the unique key used to identify each node and generate the path array passed in callbacks. With a setting of getNodeKey={({ node }) => node.id}, for example, in callbacks this will let you easily determine that the node with an id of 35 is (or has just become) a child of the node with an id of 12, which is a child of ... and so on. It uses defaultGetNodeKey by default, which returns the index in the tree (omitting hidden nodes).
({ node: object, treeIndex: number }): string or number
generateNodePropsfuncGenerate an object with additional props to be passed to the node renderer. Use this for adding buttons via the buttons key, or additional style / className settings.
({ node: object, path: number[] or string[], treeIndex: number, lowerSiblingCounts: number[], isSearchMatch: bool, isSearchFocus: bool }): object
onMoveNodefuncCalled after node move operation.
({ treeData: object[], node: object, nextParentNode: object, prevPath: number[] or string[], prevTreeIndex: number, nextPath: number[] or string[], nextTreeIndex: number }): void
onVisibilityTogglefuncCalled after children nodes collapsed or expanded.
({ treeData: object[], node: object, expanded: bool, path: number[] or string[] }): void
onDragStateChangedfuncCalled when a drag is initiated or ended.
({ isDragging: bool, draggedNode: object }): void
maxDepthnumberMaximum depth nodes can be inserted at. Defaults to infinite.
rowDirectionstringAdds row direction support if set to 'rtl' Defaults to 'ltr'.
canDragfunc or boolReturn false from callback to prevent node from dragging, by hiding the drag handle. Set prop to false to disable dragging on all nodes. Defaults to true.
({ node: object, path: number[] or string[], treeIndex: number, lowerSiblingCounts: number[], isSearchMatch: bool, isSearchFocus: bool }): bool
canDropfuncReturn false to prevent node from dropping in the given location.
({ node: object, prevPath: number[] or string[], prevParent: object, prevTreeIndex: number, nextPath: number[] or string[], nextParent: object, nextTreeIndex: number }): bool
canNodeHaveChildrenfuncFunction to determine whether a node can have children, useful for preventing hover preview when you have a canDrop condition. Default is set to a function that returns true. Functions should be of type (node): bool.
themeobjectSet an all-in-one packaged appearance for the tree. See the Themes section for more information.
searchMethodfuncThe method used to search nodes. Defaults to defaultSearchMethod, which uses the searchQuery string to search for nodes with matching title or subtitle values. NOTE: Changing searchMethod will not update the search, but changing the searchQuery will.
({ node: object, path: number[] or string[], treeIndex: number, searchQuery: any }): bool
searchQuerystring or anyUsed by the searchMethod to highlight and scroll to matched nodes. Should be a string for the default searchMethod, but can be anything when using a custom search. Defaults to null.
searchFocusOffsetnumberOutline the <searchFocusOffset>th node and scroll to it.
onlyExpandSearchedNodesbooleanOnly expand the nodes that match searches. Collapses all other nodes. Defaults to false.
searchFinishCallbackfuncGet the nodes that match the search criteria. Used for counting total matches, etc.
(matches: { node: object, path: number[] or string[], treeIndex: number }[]): void
dndTypestringString value used by react-dnd (see overview at the link) for dropTargets and dragSources types. If not set explicitly, a default value is applied by react-sortable-tree for you for its internal use. NOTE: Must be explicitly set and the same value used in order for correct functioning of external nodes
shouldCopyOnOutsideDropfunc or boolReturn true, or a callback returning true, and dropping nodes to react-dnd drop targets outside of the tree will not remove them from the tree. Defaults to false.
({ node: object, prevPath: number[] or string[], prevTreeIndex: number, }): bool
reactVirtualizedListPropsobjectCustom properties to hand to the internal react-virtualized List
styleobjectStyle applied to the container wrapping the tree (style defaults to {height: '100%'})
innerStyleobjectStyle applied to the inner, scrollable container (for padding, etc.)
classNamestringClass name for the container wrapping the tree
rowHeightnumber or funcUsed by react-sortable-tree. Defaults to 62. Either a fixed row height (number) or a function that returns the height of a row given its index: ({ treeIndex: number, node: object, path: number[] or string[] }): number
slideRegionSizenumberSize in px of the region near the edges that initiates scrolling on dragover. Defaults to 100.
scaffoldBlockPxWidthnumberThe width of the blocks containing the lines representing the structure of the tree. Defaults to 44.
isVirtualizedboolSet to false to disable virtualization. Defaults to true. NOTE: Auto-scrolling while dragging, and scrolling to the searchFocusOffset will be disabled.
nodeContentRendereranyOverride the default component (NodeRendererDefault) for rendering nodes (but keep the scaffolding generator). This is a last resort for customization - most custom styling should be able to be solved with generateNodeProps, a theme or CSS rules. If you must use it, is best to copy the component in node-renderer-default.js to use as a base, and customize as needed.
placeholderRendereranyOverride the default placeholder component (PlaceholderRendererDefault) which is displayed when the tree is empty. This is an advanced option, and in most cases should probably be solved with a theme or custom CSS instead.

Data Helper Functions

Need a hand turning your flat data into nested tree data? Want to perform add/remove operations on the tree data without creating your own recursive function? Check out the helper functions exported from tree-data-utils.js.

  • getTreeFromFlatData: Convert flat data (like that from a database) into nested tree data.
  • getFlatDataFromTree: Convert tree data back to flat data.
  • addNodeUnderParent: Add a node under the parent node at the given path.
  • removeNode: For a given path, get the node at that path, treeIndex, and the treeData with that node removed.
  • removeNodeAtPath: For a given path, remove the node and return the treeData.
  • changeNodeAtPath: Modify the node object at the given path.
  • map: Perform a change on every node in the tree.
  • walk: Visit every node in the tree in order.
  • getDescendantCount: Count how many descendants this node has.
  • getVisibleNodeCount: Count how many visible descendants this node has.
  • getVisibleNodeInfoAtIndex: Get the th visible node in the tree data.
  • toggleExpandedForAll: Expand or close every node in the tree.
  • getNodeAtPath: Get the node at the input path.
  • insertNode: Insert the input node at the specified depth and minimumTreeIndex.
  • find: Find nodes matching a search query in the tree.
  • isDescendant: Check if a node is a descendant of another node.
  • getDepth: Get the longest path in the tree.

Themes

Using the theme prop along with an imported theme module, you can easily override the default appearance with another standard one.

Featured themes

File Explorer ThemeFull Node Drag ThemeMINIMAL THEME
File ExplorerFull Node DragMinimalistic theme inspired from MATERIAL UI
react-sortable-tree-theme-file-explorerreact-sortable-tree-theme-full-node-dragreact-sortable-tree-theme-minimal
Github | NPMGithub | NPMGithub | NPM

Help Wanted - As the themes feature has just been enabled, there are very few (only two at the time of this writing) theme modules available. If you've customized the appearance of your tree to be especially cool or easy to use, I would be happy to feature it in this readme with a link to the Github repo and NPM page if you convert it to a theme. You can use my file explorer theme repo as a template to plug in your own stuff.

Browser Compatibility

BrowserWorks?
ChromeYes
FirefoxYes
SafariYes
IE 11Yes

Troubleshooting

If it throws "TypeError: fn is not a function" errors in production

This issue may be related to an ongoing incompatibility between UglifyJS and Webpack's behavior. See an explanation at create-react-app#2376.

The simplest way to mitigate this issue is by adding comparisons: false to your Uglify config as seen here: https://github.com/facebookincubator/create-react-app/pull/2379/files

If it doesn't work with other components that use react-dnd

react-dnd only allows for one DragDropContext at a time (see: https://github.com/gaearon/react-dnd/issues/186). To get around this, you can import the context-less tree component via SortableTreeWithoutDndContext.

// before
import SortableTree from 'react-sortable-tree';

// after
import { SortableTreeWithoutDndContext as SortableTree } from 'react-sortable-tree';

Contributing

Please read the Code of Conduct. I actively welcome pull requests :)

After cloning the repository and running yarn install inside, you can use the following commands to develop and build the project.

# Starts a webpack dev server that hosts a demo page with the component.
# It uses react-hot-loader so changes are reflected on save.
yarn start

# Start the storybook, which has several different examples to play with.
# Also hot-reloaded.
yarn run storybook

# Runs the library tests
yarn test

# Lints the code with eslint
yarn run lint

# Lints and builds the code, placing the result in the dist directory.
# This build is necessary to reflect changes if you're
#  `npm link`-ed to this repository from another local project.
yarn run build

Pull requests are welcome!

License

MIT