`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') }] }]` |\n| onChange
_(required)_ | func | Called 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`
|\n| getNodeKey
_(recommended)_ | func | Specify 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`](https://github.com/nosferatu500/react-sortable-tree/blob/master/src/utils/default-handlers.js) by default, which returns the index in the tree (omitting hidden nodes).
`({ node: object, treeIndex: number }): string or number`
|\n| generateNodeProps | func | Generate 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`
|\n| onMoveNode | func | Called after node move operation.
`({ treeData: object[], node: object, nextParentNode: object, prevPath: number[] or string[], prevTreeIndex: number, nextPath: number[] or string[], nextTreeIndex: number }): void`
|\n| onVisibilityToggle | func | Called after children nodes collapsed or expanded.
`({ treeData: object[], node: object, expanded: bool, path: number[] or string[] }): void`
|\n| onDragStateChanged | func | Called when a drag is initiated or ended.
`({ isDragging: bool, draggedNode: object }): void`
|\n| maxDepth | number | Maximum depth nodes can be inserted at. Defaults to infinite. |\n| rowDirection | string | Adds row direction support if set to `'rtl'` Defaults to `'ltr'`. |\n| canDrag | func or bool | Return 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`
|\n| canDrop | func | Return 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`
|\n| canNodeHaveChildren | func | Function 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`. |\n| theme | object | Set an all-in-one packaged appearance for the tree. See the [Themes](#themes) section for more information. |\n| searchMethod | func | The method used to search nodes. Defaults to [`defaultSearchMethod`](https://github.com/nosferatu500/react-sortable-tree/blob/master/src/utils/default-handlers.js), 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`
|\n| searchQuery | string or any | Used 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`. |\n| searchFocusOffset | number | Outline the <`searchFocusOffset`>th node and scroll to it. |\n| onlyExpandSearchedNodes | boolean | Only expand the nodes that match searches. Collapses all other nodes. Defaults to `false`. |\n| searchFinishCallback | func | Get the nodes that match the search criteria. Used for counting total matches, etc.
`(matches: { node: object, path: number[] or string[], treeIndex: number }[]): void`
|\n| dndType | string | String value used by [react-dnd](https://react-dnd.github.io/react-dnd/about) (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 |\n| shouldCopyOnOutsideDrop | func or bool | Return 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`
|\n| style | object | Style applied to the container wrapping the tree (style defaults to `{height: '100%'}`) |\n| innerStyle | object | Style applied to the inner, scrollable container (for padding, etc.) |\n| className | string | Class name for the container wrapping the tree |\n| slideRegionSize | number | Size in px of the region near the edges that initiates scrolling on dragover. Defaults to `100`. |\n| scaffoldBlockPxWidth | number | The width of the blocks containing the lines representing the structure of the tree. Defaults to `44`. |\n| nodeContentRenderer | any | Override the default component ([`NodeRendererDefault`](https://github.com/nosferatu500/react-sortable-tree/blob/master/src/node-renderer-default.js)) 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. |\n| placeholderRenderer | any | Override the default placeholder component ([`PlaceholderRendererDefault`](https://github.com/nosferatu500/react-sortable-tree/blob/master/src/placeholder-renderer-default.js)) 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. |\n## Data Helper Functions\n\nNeed a hand turning your flat data into nested tree data?\nWant to perform add/remove operations on the tree data without creating your own recursive function?\nCheck out the helper functions exported from [`tree-data-utils.js`](https://github.com/nosferatu500/react-sortable-tree/blob/master/src/utils/tree-data-utils.js).\n\n- **`getTreeFromFlatData`**: Convert flat data (like that from a database) into nested tree data.\n- **`getFlatDataFromTree`**: Convert tree data back to flat data.\n- **`addNodeUnderParent`**: Add a node under the parent node at the given path.\n- **`removeNode`**: For a given path, get the node at that path, treeIndex, and the treeData with that node removed.\n- **`removeNodeAtPath`**: For a given path, remove the node and return the treeData.\n- **`changeNodeAtPath`**: Modify the node object at the given path.\n- **`map`**: Perform a change on every node in the tree.\n- **`walk`**: Visit every node in the tree in order.\n- **`getDescendantCount`**: Count how many descendants this node has.\n- **`getVisibleNodeCount`**: Count how many visible descendants this node has.\n- **`getVisibleNodeInfoAtIndex`**: Get the
th visible node in the tree data.\n- **`toggleExpandedForAll`**: Expand or close every node in the tree.\n- **`getNodeAtPath`**: Get the node at the input path.\n- **`insertNode`**: Insert the input node at the specified depth and minimumTreeIndex.\n- **`find`**: Find nodes matching a search query in the tree.\n- **`isDescendant`**: Check if a node is a descendant of another node.\n- **`getDepth`**: Get the longest path in the tree.\n\n## Themes\n\nUsing the `theme` prop along with an imported theme module, you can easily override the default appearance with another standard one.\n\n### Featured themes\n\n|  | ![\"Full](\"https://user-images.githubusercontent.com/4413963/33521792-61dc2c50-d81f-11e7-8ab1-359661a11ca4.png\")
| ![\"MINIMAL](\"https://github.com/lifejuggler/react-sortable-tree-theme-minimal/blob/master/example-resource/main.png\")
|\n| :----------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------: |\n| **File Explorer** | **Full Node Drag** | **Minimalistic theme inspired from MATERIAL UI** |\n| @nosferatu500/theme-file-explorer | react-sortable-tree-theme-full-node-drag | react-sortable-tree-theme-minimal |\n| [Github](https://github.com/nosferatu500/theme-file-explorer) \\| [NPM](https://www.npmjs.com/package/@nosferatu500/theme-file-explorer) | [Github](https://github.com/frontend-collective/react-sortable-tree-theme-full-node-drag) \\| [NPM](https://www.npmjs.com/package/react-sortable-tree-theme-full-node-drag) | [Github](https://github.com/lifejuggler/react-sortable-tree-theme-minimal) \\| [NPM](https://www.npmjs.com/package/react-sortable-tree-theme-minimal) |\n\n**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](https://github.com/nosferatu500/theme-file-explorer) as a template to plug in your own stuff.\n\n## Browser Compatibility\n\n| Browser | Works? |\n| :------ | :----- |\n| Chrome | Yes |\n| Firefox | Yes |\n| Safari | Yes |\n| IE 11 | Yes |\n\n## Troubleshooting\n\n### If it throws \"TypeError: fn is not a function\" errors in production\n\nThis issue may be related to an ongoing incompatibility between UglifyJS and Webpack's behavior. See an explanation at [create-react-app#2376](https://github.com/facebookincubator/create-react-app/issues/2376).\n\nThe 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\n\n### If it doesn't work with other components that use react-dnd\n\nreact-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`.\n\n```js\n// before\nimport SortableTree from '@nosferatu500/react-sortable-tree';\n\n// after\nimport { SortableTreeWithoutDndContext as SortableTree } from '@nosferatu500/react-sortable-tree';\n```\n\n## Contributing\n\nPlease read the [Code of Conduct](CODE_OF_CONDUCT.md). I actively welcome pull requests :)\n\nAfter cloning the repository and running `yarn install` inside, you can use the following commands to develop and build the project.\n\n```sh\n# Starts a webpack dev server that hosts a demo page with the component.\n# It uses react-hot-loader so changes are reflected on save.\nyarn start\n\n# Start the storybook, which has several different examples to play with.\n# Also hot-reloaded.\nyarn run storybook\n\n# Runs the library tests\nyarn test\n\n# Lints the code with eslint\nyarn run lint\n\n# Lints and builds the code, placing the result in the dist directory.\n# This build is necessary to reflect changes if you're\n# `npm link`-ed to this repository from another local project.\nyarn run build\n```\n\nPull requests are welcome!\n\n## License\n\nMIT\n","readmeFilename":"README.md"}![](\"https://cloud.githubusercontent.com/assets/4413963/18860410/26f64de8-84b8-11e6-9284-350308eed30a.png\"/)
\n![](\"https://cloud.githubusercontent.com/assets/4413963/19334888/2be8261c-913a-11e6-9508-4b347ae114b4.gif\"/)
\n