Nature's Particle Manager

    react-sortable-tree-tristandb

    0.1.16 • Public • Published

    React Sortable Tree

    NPM

    tree200

    Demo

    demo

    Features

    • Works right out of the box, but is highly customizable

    Example

    import React, { Component } from 'react';
    import SortableTree from 'react-sortable-tree';
     
    export default class Tree extends Component {
        constructor(props) {
            super(props);
     
            this.state = {
                treeData: [{ title: 'Chicken', children: [ { title: 'Egg' } ] }],
            };
        }
     
        render() {
            return (
                <div style={{ height: 400 }}>
                    <SortableTree
                        treeData={this.state.treeData}
                        onChange={treeData => this.setState({ treeData })}
                    />
                </div>
            );
        }
    }
     

    Options

    Property Type Default Required Description
    treeData object[] yes 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 func yes 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
    style object {} Style applied to the container wrapping the tree (style defaults to {height: '100%'})
    className string Class name for the container wrapping the tree
    innerStyle object {} Style applied to the inner, scrollable container (for padding, etc.)
    maxDepth number Maximum depth nodes can be inserted at. Defaults to infinite.
    searchMethod func The method used to search nodes. Defaults to a function that 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
    searchQuery string or any null 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.
    searchFocusOffset number Outline the <searchFocusOffset>th node and scroll to it.
    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
    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
    getNodeKey func defaultGetNodeKey Determine the unique key used to identify each node and generate the path array passed in callbacks. By default, returns the index in the tree (omitting hidden nodes).
    ({ node: object, treeIndex: number }): string or number
    onMoveNode func Called after node move operation.
    ({ treeData: object[], node: object, treeIndex: number, path: number[] or string[] }): void
    onVisibilityToggle func Called after children nodes collapsed or expanded.
    ({ treeData: object[], node: object, expanded: bool }): void
    reactVirtualizedListProps object Custom properties to hand to the react-virtualized list
    rowHeight number or func 62 Used by react-virtualized. Either a fixed row height (number) or a function that returns the height of a row given its index: ({ index: number }): number
    slideRegionSize number 100 Size in px of the region near the edges that initiates scrolling on dragover.
    scaffoldBlockPxWidth number 44 The width of the blocks containing the lines representing the structure of the tree.
    isVirtualized bool true Set to false to disable virtualization. NOTE: Auto-scrolling while dragging, and scrolling to the searchFocusOffset will be disabled.
    nodeContentRenderer any NodeRendererDefault Override the default component for rendering nodes (but keep the scaffolding generator) This is an advanced option for complete customization of the appearance. It is best to copy the component in node-renderer-default.js to use as a base, and customize as needed.

    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.

    Notable among the available functions:

    • 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
    • removeNodeAtPath: Remove the node at the given path
    • map: Perform a change on every node in the tree
    • walk: Visit every node in the tree in order

    Documentation for each method is only available in the code at this time. If your hobbies happen to include writing documentation, by all means submit a pull request. It would really help out.

    Browser Compatibility

    Browser Works?
    Chrome Yes
    Firefox Yes
    Safari Yes
    IE >= 10 Yes
    IE 9 Broken due to flexbox issues. Plan to fix.

    Troubleshooting

    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

    After cloning the repository and running npm 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. 
    npm start
     
    # Lints the code with eslint and my custom rules. 
    npm 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. 
    npm run build

    Pull requests are welcome!

    License

    MIT

    Install

    npm i react-sortable-tree-tristandb

    DownloadsWeekly Downloads

    5

    Version

    0.1.16

    License

    MIT

    Last publish

    Collaborators

    • tristandb