Open In App

React Suite TreePicker Component

Improve
Improve
Like Article
Like
Save
Share
Report

React Suite is a popular front-end library with a set of React components that are designed for the middle platform and back-end products. TreePicker component allows the user to provide a tree single selector. Users can select a value from the Dropdown in the form of a tree hierarchy. We can use the following approach in ReactJS to use the React Suite TreePicker Component.

TreePicker Props:

  • appearance: It is used for the component appearance.
  • block: It is used to block an entire row.
  • childrenKey: It is used to denote the Tree data structure Children property name.
  • classPrefix: It is used to denote the prefix of the component CSS class.
  • cleanable: It is used to indicate whether the option can be emptied or not.
  • container: It is used to set the rendering container.
  • data: It is used to denote the selectable data.
  • defaultExpandAll: It is used to expand all nodes by default.
  • defaultExpandItemValues: It is used to set the value of the default expanded node.
  • defaultOpen: It is used to open by default.
  • defaultValue: It is used to denote the default value.
  • disabled: It is used to indicate whether the component is disabled or not.
  • disabledItemValues: It is used to disable optional.
  • expandItemValues: It is used to set the value of the expanded node (controlled).
  • height: It is used to denote the menu height.
  • labelKey: It is used to set the options to display the ‘key’ in ‘data’.
  • menuClassName: It is used to denote a CSS class to apply to the Menu DOM node.
  • menuStyle: It is used to denote a style to apply to the Menu DOM node.
  • onChange: It is a callback function that is triggered when value changes.
  • onClean: It is a callback function that is triggered when value clean.
  • onClose: It is a callback function that is triggered on a close event.
  • onEnter: It is a callback function that is triggered before the overlay transitions in.
  • onEntered: It is a callback function that is triggered after the overlay finishes transitioning in.
  • onEntering: It is a callback function that is triggered as the overlay begins to transition in.
  • onExit: It is a callback function that is triggered right before the overlay transitions out.
  • onExited: It is a callback function that is triggered after the overlay finishes transitioning out.
  • onExiting: It is a callback function that is triggered as the overlay begins to transition out.
  • onExpand: It is a callback function that is triggered when the tree node is displayed.
  • onOpen: It is a callback function that is triggered on open of the component.
  • onSearch: It is a callback function for the search.
  • onSelect: It is a callback function that is triggered on the selection of an option.
  • open: It is a callback function that is triggered on the open event (Controlled).
  • placeholder: It is used to denote the placeholder.
  • placement: It is used for the placement of component.
  • renderExtraFooter: It is used for the custom render extra footer.
  • renderTreeIcon: It is used to denote the custom render icon.
  • renderTreeNode: It is used to denote the custom render tree node.
  • renderValue: It is used for the custom Render selected options.
  • searchBy: It is used for the custom search rules.
  • searchable: It is used to indicate whether you can search for options or not.
  • size: It is used to denote the picker size.
  • toggleComponentClass: It can be used for the custom element for this component.
  • value: It is used to denote the value (Controlled).
  • valueKey: It is used to set the option value ‘key’ in ‘data’.
  • virtualized: It is used to indicate whether using Virtualized List or not.

Creating React Application And Installing Module:

  • Step 1: Create a React application using the following command:

    npx create-react-app foldername
  •  

  • Step 2: After creating your project folder i.e. foldername, move to it using the following command:

    cd foldername
  • Step 3: After creating the ReactJS application, Install the required module using the following command:

    npm install rsuite

Project Structure: It will look like the following.

Project Structure

Example: Now write down the following code in the App.js file. Here, App is our default component where we have written our code.

App.js




import React from 'react'
import 'rsuite/dist/styles/rsuite-default.css';
import { TreePicker } from 'rsuite';
  
export default function App() {
  
  // Sample Options
  const options = [
    {
      "label": "Madhya Pradesh",
      "value": 1,
      "children": [
        {
          "label": "Mhow",
          "value": 2
        },
        {
          "label": "Indore",
          "value": 3,
          "children": [
            {
              "label": "Vijay Nagar",
              "value": 4
            },
            {
              "label": "Rajiv Gandhi Square",
              "value": 5
            },
            {
              "label": "MR 10",
              "value": 6
            },
          ]
        },
      ]
    }
  ]
  
  return (
    <div style={{
      display: 'block', width: 600, paddingLeft: 30
    }}>
      <h4>React Suite TreePicker Component</h4>
      <TreePicker
        style={{ width: 300 }}
        defaultExpandAll
        placeholder="Select your Nearest Office"
        data={options}
      />
    </div>
  );
}


Step to Run Application: Run the application using the following command from the root directory of the project:

npm start

Output: Now open your browser and go to http://localhost:3000/, you will see the following output:

Reference: https://rsuitejs.com/components/tree-picker/



Last Updated : 11 Apr, 2022
Like Article
Save Article
Previous
Next
Share your thoughts in the comments
Similar Reads