react-dropdown-tree-select
    TypeScript icon, indicating that this package has built-in type declarations

    2.5.1 • Public • Published

    react-dropdown-tree-select


    NPM version gzip npm download

    build status Test coverage Commitizen friendly semantic-release All Contributors npm type definitions

    React Dropdown Tree Select

    A lightweight and fast control to render a select component that can display hierarchical tree data. In addition, the control shows the selection in pills and allows user to search the options for quick filtering and selection. Also supports displaying partially selected nodes.

    Table of Contents

    Screenshot

    animated demo screenshot

    Demo

    Vanilla, no framework

    Online demo: https://dowjones.github.io/react-dropdown-tree-select/#/story/with-vanilla-styles

    With Bootstrap

    Online demo: https://dowjones.github.io/react-dropdown-tree-select/#/story/with-bootstrap-styles

    With Material Design

    Online demo: https://dowjones.github.io/react-dropdown-tree-select/#/story/with-material-design-styles

    As Single Select

    Online demo: https://dowjones.github.io/react-dropdown-tree-select/#/story/simple-select

    Install

    As NPM package

    npm i react-dropdown-tree-select
     
    // or if using yarn
    yarn add react-dropdown-tree-select

    Using a CDN

    You can import the standalone UMD build from a CDN such as:

    <script src="https://unpkg.com/react-dropdown-tree-select/dist/react-dropdown-tree-select.js"></script>
    <link href="https://unpkg.com/react-dropdown-tree-select/dist/styles.css" rel="stylesheet" />

    Note: Above example will always fetch the latest version. To fetch a specific version, use https://unpkg.com/react-dropdown-tree-select@<version>/dist/... Visit unpkg.com to see other options.

    Peer Dependencies

    In order to avoid version conflicts in your project, you must specify and install react, react-dom as peer dependencies. Note that NPM doesn't install peer dependencies automatically. Instead it will show you a warning message with instructions on how to install them.

    If you're using the UMD builds, you'd also need to install the peer dependencies in your application:

    <script src="https://unpkg.com/react/dist/react.js"></script>
    <script src="https://unpkg.com/react-dom/dist/react-dom.js"></script>

    Usage

    import React from 'react'
    import ReactDOM from 'react-dom'
     
    import DropdownTreeSelect from 'react-dropdown-tree-select'
    import 'react-dropdown-tree-select/dist/styles.css'
     
    const data = {
      label: 'search me',
      value: 'searchme',
      children: [
        {
          label: 'search me too',
          value: 'searchmetoo',
          children: [
            {
              label: 'No one can get me',
              value: 'anonymous',
            },
          ],
        },
      ],
    }
     
    const onChange = (currentNode, selectedNodes) => {
      console.log('onChange::', currentNode, selectedNodes)
    }
    const onAction = (node, action) => {
      console.log('onAction::', action, node)
    }
    const onNodeToggle = currentNode => {
      console.log('onNodeToggle::', currentNode)
    }
     
    ReactDOM.render(
      <DropdownTreeSelect data={data} onChange={onChange} onAction={onAction} onNodeToggle={onNodeToggle} />,
      document.body
    ) // in real world, you'd want to render to an element, instead of body.

    Props

    className

    Type: string

    Additional classname for container. The container renders with a default classname of react-dropdown-tree-select.

    clearSearchOnChange

    Type: bool

    Clear the input search if a node has been selected/unselected.

    onChange

    Type: function

    Fires when a node change event occurs. Currently the following actions trigger a node change:

    • Checkbox click which checks/unchecks the item
    • Closing of pill (which unchecks the corresponding checkbox item)

    Calls the handler with the current node object and all selected nodes (if any). Example:

    function onChange(currentNode, selectedNodes) {
      // currentNode: { label, value, children, expanded, checked, className, ...extraProps }
      // selectedNodes: [{ label, value, children, expanded, checked, className, ...extraProps }]
    }
     
    return <DropdownTreeSelect data={data} onChange={onChange} />

    onNodeToggle

    Type: function

    Fires when a node is expanded or collapsed.

    Calls the handler with the current node object. Example:

    function onNodeToggle(currentNode) {
      // currentNode: { label, value, children, expanded, checked, className, ...extraProps }
    }
     
    return <DropdownTreeSelect data={data} onNodeToggle={onNodeToggle} />

    onAction

    Type: function

    Fires when a action is triggered. Example:

    function onAction(node, action) {
      console.log('onAction::', action, node)
    }
     
    return <DropdownTreeSelect data={data} onAction={onAction} />

    onFocus

    Type: function

    Fires when input box receives focus or the dropdown arrow is clicked. This is helpful for setting dirty or touched flags with forms.

    onBlur

    Type: function

    Fires when input box loses focus or the dropdown arrow is clicked again (and the dropdown collapses). This is helpful for setting dirty or touched flags with forms.

    data

    Type: Object or Array

    Data for rendering the tree select items. The object requires the following structure:

    {
      label,          // required: Checkbox label
      value,          // required: Checkbox value
      children,       // optional: Array of child objects
      checked,        // optional: Initial state of checkbox. if true, checkbox is selected and corresponding pill is rendered.
      disabled,       // optional: Selectable state of checkbox. if true, the checkbox is disabled and the node is not selectable.
      expanded,       // optional: If true, the node is expanded (children of children nodes are not expanded by default unless children nodes also have expanded: true).
      className,      // optional: Additional css class for the node. This is helpful to style the nodes your way
      tagClassName,   // optional: Css class for the corresponding tag. Use this to add custom style the pill corresponding to the node.
      actions,        // optional: An array of extra action on the node (such as displaying an info icon or any custom icons/elements)
      dataset,        // optional: Allows data-* attributes to be set on the node and tag elements
      isDefaultValue, // optional: Indicate if a node is a default value. When true, the dropdown will automatically select the node(s) when there is no other selected node. Can be used on more than one node.
      tagLabel,       // optional: tag label in case you need it to differ from the checkbox label
      ...             // optional: Any extra properties that you'd like to receive during `onChange` event
    }

    The action object requires the following structure:

    {
      className, // required: CSS class for the node. e.g. `fa fa-info`
      title,     // optional: HTML tooltip text
      text,      // optional: Any text to be displayed. This is helpful to pass ligatures if you're using ligature fonts
      ...        // optional: Any extra properties that you'd like to receive during `onChange` event
    }

    An array renders a tree with multiple root level items whereas an object renders a tree with a single root element (e.g. a Select All root node).

    texts

    Texts to override various labels, place holders & messages used in the component. You can also use this to provide translated messages.

    The texts object requires the following structure:

    {
      placeholder,              // optional: The text to display as placeholder on the search box. Defaults to `Choose...`
      inlineSearchPlaceholder,  // optional: The text to display as placeholder on the inline search box. Only applicable with the `inlineSearchInput` setting. Defaults to `Search...`
      noMatches,                // optional: The text to display when the search does not find results in the content list. Defaults to `No matches found`
      label,                    // optional: Adds `aria-labelledby` to search input when input starts with `#`, adds `aria-label` to search input when label has value (not containing '#')
      labelRemove,              // optional: The text to display for `aria-label` on tag delete buttons which is combined with `aria-labelledby` pointing to the node label. Defaults to `Remove`
    }

    keepTreeOnSearch

    Type: bool

    Displays search results as a tree instead of flattened results

    keepChildrenOnSearch

    Type: bool

    Displays children of found nodes to allow searching for a parent node on then selecting any child node of the found node. Defaults to false

    NOTE this works only in combination with keepTreeOnSearch

    keepOpenOnSelect

    Type: bool (default: 'false')

    Keeps single selects open after selection. Defaults to false

    NOTE this works only in combination with simpleSelect or radioSelect

    mode

    Type: string (default: multiSelect)

    Defines how the dropdown is rendered / behaves

    multiSelect

    A multi selectable dropdown which supports tree data with parent-child relationships. This is the default mode.

    hierarchical

    A multi selectable dropdown which supports tree data without parent-child relationships. In this mode, selecting a node has no ripple effects on its descendants or ancestors. Subsequently, showPartiallySelected becomes a moot flag and has no effect as well.

    ⚠️ Note that hierarchical=true negates/overrides showPartiallySelected.

    simpleSelect

    Turns the dropdown into a simple, single select dropdown. If you pass tree data, only immediate children are picked, grandchildren nodes are ignored.

    ⚠️ If multiple nodes in data are selected - by setting either checked or isDefaultValue, only the first visited node stays selected.

    radioSelect

    Turns the dropdown into radio select dropdown.

    Like simpleSelect, you can only select one value; but keeps the tree/children structure.

    ⚠️ If multiple nodes in data are selected - by setting either checked or isDefaultValue, only the first visited node stays selected.

    showPartiallySelected

    Type: bool (default: false)

    If set to true, shows checkboxes in a partial state when one, but not all of their children are selected. Allows styling of partially selected nodes as well, by using :indeterminate pseudo class. Simply add desired styles to .node.partial .checkbox-item:indeterminate { ... } in your CSS.

    showDropdown

    Type: string

    Let's you choose the rendered state of the dropdown.

    initial

    showDropdown: initial shows the dropdown when rendered. This can be used to render the component with the dropdown open as its initial state.

    always

    showDropdown: always shows the dropdown when rendered, and keeps it visible at all times. Toggling dropdown is disabled.

    form states (disabled|readOnly)

    Type: bool (default: false)

    disabled=true disables the dropdown completely. This is useful during form submit events. readOnly=true makes the dropdown read only, which means that the user can still interact with it but cannot change any of its values. This can be useful for display only forms.

    id

    Type: string

    Specific id for container. The container renders with a default id of rdtsN where N is the count of the current component rendered.

    Use to ensure a own unique id when a simple counter is not sufficient, e.g in a partial server render (SSR)

    searchPredicate

    Type: function

    Optional search predicate to override the default case insensitive contains match on node labels. Example:

    function searchPredicate(node, searchTerm) {
      return node.customData && node.customData.toLower().indexOf(searchTerm) >= 0
    }
     
    return <DropdownTreeSelect data={data} searchPredicate={searchPredicate} />

    inlineSearchInput

    Type: bool (default: false)

    inlineSearchInput=true makes the search input renders inside the dropdown-content. This can be useful when your UX looks something like this comment.

    Styling and Customization

    Default styles

    The component brings minimal styles for bare-bones functional rendering. It is kept purposefully minimal so that user can style/customize it completely to suit their needs.

    Using WebPack

    If you're using a bundler like WebPack, make sure you configure WebPack to import the default styles. To do so, simply add this rule to your WebPack config:

    // allow WebPack to import/bundle styles from node_modules for this component
    module: {
      rules: [
        {
          test: /\.css$/,
          use: ExtractTextPlugin.extract({
            fallback: 'style-loader',
            use: [
              {
                loader: 'css-loader',
              },
            ],
          }),
          include: /node_modules[/\\]react-dropdown-tree-select/,
        },
      ]
    }

    Using a CDN

    You can import and place a style link directly by referencing it from a CDN.

    <link href="https://unpkg.com/react-dropdown-tree-select/dist/styles.css" rel="stylesheet" />

    Note: Above example will always fetch the latest version. To fetch a specific version, use https://unpkg.com/react-dropdown-tree-select@<version>/dist/styles.css. Visit unpkg.com to see other options.

    Using with other bundlers

    You can reference the files from node_modules/react-dropdown-tree-select/dist/styles.css to include in your own bundle via gulp or any other bundlers you have.

    Customizing styles

    Once you import default styles, it is easy to add/override the provided styles to match popular frameworks. Checkout /docs folder for some examples.

    Keyboard navigation

    Adds navigation with arrow keys, page down/up / home/end and toggle of selection with enter. Arrow/page up/down also toggles open of dropdown if closed.

    To close open dropdown escape or tab can be used and backspace can be used for deletion of tags on empty search input.

    Performance

    Search optimizations

    • The tree creates a flat list of nodes from hierarchical tree data to perform searches that are linear in time irrespective of the tree depth or size.
    • It also memoizes each search term, so subsequent searches are instantaneous (almost).
    • Last but not the least, the search employs progressive filtering technique where subsequent searches are performed on the previous search set. E.g., say the tree has 4000 nodes altogether and the user wants to filter nodes that contain the text: "2002". As the user enters each key press the search goes like this:
    key press  : 2-----20-----200-----2002
                |     |      |       |
    search set: 967   834    49      7
    

    The search for "20" happens against the previously matched set of 967 as opposed to all 4000 nodes; "200" happens against 834 nodes and so on.

    Search debouncing

    The tree debounces key presses to avoid costly search calculations. The default duration is 100ms.

    Virtualized rendering

    The dropdown renders only visible content and skips any nodes that are going to hidden from the user. E.g., if a parent node is not expanded, there is no point in rendering children since they will not be visible anyway.

    Planned feature: Use react-virtualized to take this to the next level. The search tree now uses infinite scroll, limiting search results to 100 items initially (more load seamlessly as you scroll) - this results in super fast rendering even with large number of nodes (see #80).

    Reducing costly DOM manipulations

    The tree tries to minimize the DOM manipulations as much as possible. E.g., during searching, the non-matching nodes are simply hidden and css adjusted on remaining to create the perception of a new filtered list. Node toggling also achieves the expand/collapse effect by manipulating css classes instead of creating new tree with filtered out nodes.

    FAQ

    How do I change the placeholder text?

    The default placeholder is Choose.... If you want to change this to something else, you can use placeholder property to set it.

    <DropdownTreeSelect texts={{ placeholder: 'Search' }} />

    How do I tweak styles?

    Easy style customization is one of the design goals of this component. Every visual aspect of this dropdown can be tweaked without going through extensive hacks. E.g., to change how disabled nodes appear:

    .node .fa-ban {
      color: #ccc;
    }

    The css classes needed to override can be found by inspecting the component via developer tools (Chrome/Safari/IE/Edge/Firefox). You can also inspect the source code or look in examples.

    I do not want the default styles, do I need to fork the project?

    Absolutely not! Simply do not import the styles (WebPack) or include it in your html (link tags). Roughly, this is the HTML/CSS skeleton rendered by the component:

    div.react-dropdown-tree-select
      div.dropdown
        a.dropdown-trigger
          span
        ul.tag-list
          li.tag-item
            input
        div.dropdown-content
          ul.root
            li.node.tree
              i.toggle.collapsed
              label
                input.checkbox-item
                  span.node-label

    Write your own styles from scratch or copy existing styles and tweak them. Then include your own custom styles in your project.

    💡 Pro tip: Leverage node's className, tagClassName or action's className prop to emit your own class name. Then override/add css propeties in your class. Remember that last person wins in CSS (unless specificity or !important is involved). Often times, this may suffice and may be easier then writing all the styles from the ground up.

    If you believe this aspect can be improved further, feel free to raise an issue.

    My question is not listed here

    Find more questions and their answers in the issue tracker. If it still doesn't answer your questions, please raise an issue.

    Development

    Clone the git repo and install dependencies.

    npm i
    
    // or
    
    yarn install
    

    You can then run following scripts for local development

    npm run demo  // local demo, watches and rebuilds on changes
    
    npm test  // test your changes
    
    npm lint  // fixes anything that can be fixed and reports remaining errors
    
    npm run test:cov  // test coverage
    

    Note: If your browser doesn't hot reload or reflect changes during npm run demo, then delete docs/bundle.js and try again. Before submitting final PR, run npm run build:docs to build the bundle.js file again.

    License

    License

    Released 2017 by Hrusikesh Panda @ Dow Jones

    Contributors

    Thanks goes to these wonderful people (emoji key):

    toofff
    toofff

    🐛 💻 📖 🤔
    Grégory Copin
    Grégory Copin

    🐛 💻
    PRIYANSHU AGRAWAL
    PRIYANSHU AGRAWAL

    🐛 💻 🤔
    James Greenaway
    James Greenaway

    🐛 💻 🤔
    itrombitas
    itrombitas

    💻
    Dave Henton
    Dave Henton

    🚇
    Swetha Kolli
    Swetha Kolli

    💻
    BaarishRain
    BaarishRain

    🐛
    Kovacs Alexandru Robert
    Kovacs Alexandru Robert

    🤔
    Alexis Mondragon
    Alexis Mondragon

    🤔
    Charlie91
    Charlie91

    🐛
    Dhirendrasinh
    Dhirendrasinh

    🐛
    JKapostins
    JKapostins

    🐛
    josvegit
    josvegit

    🐛
    Luis Locon
    Luis Locon

    🐛
    Mikdat DOĞRU
    Mikdat DOĞRU

    🐛
    Will Izard
    Will Izard

    🤔
    Nikola Peric
    Nikola Peric

    🐛
    Ramón Alejandro Reyes Fajardo
    Ramón Alejandro Reyes Fajardo

    🐛
    Sarada Cherukupalli
    Sarada Cherukupalli

    🤔
    Dilip Gavara
    Dilip Gavara

    💻
    Lutz Lengemann
    Lutz Lengemann

    💻
    Akshay Dipta
    Akshay Dipta

    🐛
    Ian Langworth ☠
    Ian Langworth ☠

    🤔
    Stoyan Berov
    Stoyan Berov

    🐛
    ellinge
    ellinge

    💻 🤔 🚧
    Sandy M
    Sandy M

    💻 🐛
    Gustav Tonér
    Gustav Tonér

    💻
    Kestutis Kasiulynas
    Kestutis Kasiulynas

    🐛 💻
    Jesus Cabrera Gonzalez
    Jesus Cabrera Gonzalez

    💻
    MJRuskin
    MJRuskin

    💻
    akarshjairaj
    akarshjairaj

    💻
    Artem Berdyshev
    Artem Berdyshev

    💻 🐛
    Matheus Wichman
    Matheus Wichman

    💻
    aarce-uncharted
    aarce-uncharted

    💻
    Mohamad Othman
    Mohamad Othman

    💻 🤔
    kathleenlu
    kathleenlu

    💻 🐛

    This project follows the all-contributors specification. Contributions of any kind welcome!

    Install

    npm i react-dropdown-tree-select

    DownloadsWeekly Downloads

    9,391

    Version

    2.5.1

    License

    MIT

    Unpacked Size

    1.44 MB

    Total Files

    10

    Last publish

    Collaborators

    • mrchief