react-selection-tree
v0.2.0
Published
Another react tree selector library
Downloads
16
Readme
react-selection-tree
A small and independent library which provide easy-to-use efficient fast scalable multiple nested selectable tree with search functionality.
Interactive Documentation: https://dtuyenle.github.io/react-selection-tree/
Features
- Support infinite scroll only render what in view port.
- Support infinite nested tree
- Support search
- Support multiple select or single select
Installation
Independent library, no overhead dependencies needed.
npm install react-selection-tree
Make sure to include this web font into your project
https://s3.amazonaws.com/github-dtuyenle/react-selection-tree/style.css
Usage
Data structure
The data must be in the format as below:
{
id: 1,
name: 'Location 1',
parentId: null,
children: {
2: {
id: 2,
parentId: 1,
name: 'Location 2',
children: {
4: {
id: 4,
parentId: 2,
name: 'Location 4',
children: null
}
}
},
3: {
id: 3,
parentId: 1,
name: 'Location 3',
children: null
}
}
}
Styling
There is no need to import css. We are using styled-component.
Example
import and paste the code below
import React, { Component } from 'react';
import styled from 'styled-components';
import ReactSelectionTree from 'components/ReactSelectionTree';
const data = {"children":{"4000":{"children":{"4001":{"children":{"4010":{"name":"Scheduling","id":4010,"type":"Reference","parentId":4001},"4011":{"name":"Appointments","id":4011,"type":"Reference","parentId":4001},"4012":{"name":"Parking","id":4012,"type":"Reference","parentId":4001},"4013":{"name":"Location","id":4013,"type":"Reference","parentId":4001},"4014":{"name":"Getting Timely Care","id":4014,"type":"Reference","parentId":4001}},"name":"Access","id":4001,"type":"Reference","parentId":4000},"4002":{"children":{"4021":{"children":{"4022":{"name":"Medical Staff/Nurse","id":4022,"type":"Reference","parentId":4021},"4023":{"name":"Technologist","id":4023,"type":"Reference","parentId":4021}},"name":"Clinical Staff","id":4021,"type":"Reference","parentId":4002},"4024":{"name":"Materials (Brochures, Information, Reports, etc.)","id":4024,"type":"Reference","parentId":4002},"4025":{"name":"Follow Up","id":4025,"type":"Reference","parentId":4002},"4015":{"children":{"4016":{"name":"Helps Patients Understand","id":4016,"type":"Reference","parentId":4015},"4017":{"name":"Listens & Answers Questions","id":4017,"type":"Reference","parentId":4015},"4018":{"name":"Time Spent with Patient","id":4018,"type":"Reference","parentId":4015},"4019":{"name":"Bedside Manner","id":4019,"type":"Reference","parentId":4015},"4020":{"name":"Knowledge & Skill","id":4020,"type":"Reference","parentId":4015}},"name":"Physician","id":4015,"type":"Reference","parentId":4002}},"name":"Communication","id":4002,"type":"Reference","parentId":4000},"4003":{"children":{"4032":{"children":{"4033":{"name":"Scheduling Staff","id":4033,"type":"Reference","parentId":4032},"4034":{"name":"Front-Desk Staff","id":4034,"type":"Reference","parentId":4032}},"name":"Office Staff","id":4032,"type":"Reference","parentId":4003},"4035":{"name":"Billing","id":4035,"type":"Reference","parentId":4003},"4036":{"name":"Registration","id":4036,"type":"Reference","parentId":4003},"4026":{"children":{"4027":{"name":"Noise","id":4027,"type":"Reference","parentId":4026},"4028":{"name":"Lighting","id":4028,"type":"Reference","parentId":4026},"4029":{"name":"Cleanliness","id":4029,"type":"Reference","parentId":4026},"4030":{"name":"Comfort","id":4030,"type":"Reference","parentId":4026},"4031":{"name":"Temperature","id":4031,"type":"Reference","parentId":4026}},"name":"Facilities/Environment","id":4026,"type":"Reference","parentId":4003}},"name":"Office","id":4003,"type":"Reference","parentId":4000},"4004":{"children":{"4037":{"name":"Diagnosis","id":4037,"type":"Reference","parentId":4004},"4038":{"name":"Quality of Procedure","id":4038,"type":"Reference","parentId":4004}},"name":"Outcome","id":4004,"type":"Reference","parentId":4000},"4005":{"children":{"4039":{"name":"Likely to Recommend","id":4039,"type":"Reference","parentId":4005},"4040":{"name":"Likely to Come Back","id":4040,"type":"Reference","parentId":4005}},"name":"Loyalty","id":4005,"type":"Reference","parentId":4000}},"name":"Patient Satisfaction","id":4000,"type":"Reference","parentId":0}},"name":"Category","parentId":null};
const Container = styled.div`
width: 50%;
margin: 2em;
`;
const Row = styled.div`
margin: 2em;
`;
class App extends Component {
constructor(props) {
super(props);
this.state = {
selected: []
};
}
checkIfSelected(item) {
return (item && item.parent && item.parent !== null && !item.parent.checked && item.checked) ||
(typeof item.parent === 'undefined' && item.checked) ||
(item.parent && item.parent === null && item.checked);
}
render() {
return (
<Container>
<Row>
{this.state.selected}
</Row>
<Row>
<ReactSelectionTree
name="Location1"
color="#6090C3"
selectcolor="#FF8800"
data={data}
breadcrumClick={(data) => {}}
check={(data, flatData) => {
const DATA = [];
Object.keys(flatData).forEach(key => {
const item = flatData[key];
if (this.checkIfSelected(item)) {
DATA.push(<p key={key}>{item.name}</p>);
}
});
this.setState({ selected: DATA });
}}
search={(data) => {}}
reset={(data) => {}}
uncheckAll={(data) => {}}
showSearch
showClearAll
infinite
multipleSelect
/>
</Row>
</Container>
);
}
}
export default App;
Options
Please reference https://dtuyenle.github.io/react-selection-tree/ for more details
| Prop | Type | Description | | ------------- |:-------------:| -----:| | name | | | | data | | | | excludeSelect | | | | color | | | | selectcolor | | | | breadcrumClick | | | | check | | | | search | | | | reset | | | | uncheckAll | | | | showSearch | | | | showClearAll | | | | infinite | | | | multipleSelect | | |
Technical Chellenge
Initially I used recursion and this was the biggest mistake since js doesnt support tail optimization. When the data becomes too big with many nested level of data. The browser actually will crash.
Solved by:
- Instead of using recursion, use iteration.
- To reference node faster, instead of doing a binary search the entire tree, we use hash map with key as id of the node
- When update state, instead of creating a new version of the data we use the hashmap to update ( since in js object is referenced not copied )
I know this is against data mutation best practice but for performance we must mutate all the way.