Giter VIP home page Giter VIP logo

jairajjangle / react-native-tree-multi-select Goto Github PK

View Code? Open in Web Editor NEW
9.0 2.0 2.0 2.22 MB

Super-fast tree view with multi-selection capabilities, using checkboxes and search filtering.

License: MIT License

JavaScript 2.05% Ruby 1.87% Java 5.81% Swift 0.05% C 0.08% Objective-C 1.87% Objective-C++ 0.62% TypeScript 87.65%
react-native react-native-tree-select react-tree-view tree-select tree-view react-checkbox-tree react-native-tree react-native-tree-checkbox react-native-tree-view checkbox-treeview react-native-checkbox react-native-checkbox-list tree-checkbox treeview

react-native-tree-multi-select's Introduction

react-native-tree-multi-select

⚡️Super-fast Tree view with multi-selection capabilities, using checkboxes and search filtering.

npm version License Workflow Status Supported Platform Badge GitHub issues cov TS

Expand/collapse demo Search demo Customization demo

Installation

Using yarn

yarn add react-native-tree-multi-select

using npm:

npm install react-native-tree-multi-select

Dependencies that need to be installed for this library to work:

  1. @shopify/flash-list
  2. react-native-paper
  3. react-native-vector-icons

Make sure to follow the native-related installation instructions for these dependencies.

Usage

import {
  TreeView,
  type TreeNode,
  type TreeViewRef
} from 'react-native-tree-multi-select';

// Refer to the Properties table below or the example app for the TreeNode type
const myData: TreeNode[] = [...];

export function TreeViewUsageExample(){
  const treeViewRef = React.useRef<TreeViewRef | null>(null);
  
  // It's recommended to use debounce for the search function (refer to the example app)
  function triggerSearch(text: string){
    // Pass search text to the tree along with the keys on which search is to be done(optional)
    treeViewRef.current?.setSearchText(text, ["name"]);
  }
  
  // Callback functions for check and expand state changes:
  const handleSelectionChange = (checkedIds: string[]) => {
    // NOTE: Do something with updated checkedIds here
  };
  const handleExpanded = (expandedIds: string[]) => {
    // NOTE: Do something with updated expandedIds here
  };

  // Expand collapse calls using ref
  const expandAllPress = () => treeViewRef.current?.expandAll?.();
  const collapseAllPress = () => treeViewRef.current?.collapseAll?.();
  const expandNodes = (idsToExpand: string[]) => treeViewRef.current?.expandNodes?.(
    idsToExpand
  );
  const collapseNodes = (idsToCollapse: string[]) => treeViewRef.current?.collapseNodes?.(
    idsToCollapse
  );

  // Multi-selection function calls using ref
  const onSelectAllPress = () => treeViewRef.current?.selectAll?.();
  const onUnselectAllPress = () => treeViewRef.current?.unselectAll?.();
  const onSelectAllFilteredPress = () => treeViewRef.current?.selectAllFiltered?.();
  const onUnselectAllFilteredPress = () => treeViewRef.current?.unselectAllFiltered?.();
  
  return(
    // ... Remember to keep a fixed height for the parent. Read Flash List docs to know why
    <TreeView
      ref={treeViewRef}
      data={myData}
      onCheck={handleSelectionChange}
      onExpand={handleExpanded}
    />
  );
}

Properties

Property Type Required Description
data TreeNode Yes An array of TreeNode objects
onCheck (checkedIds: string[]) => void No Callback when a checkbox is checked
onExpand (expandedIds: string[]) => void No Callback when a node is expanded
preselectedIds string[] No An array of ids that should be pre-selected
preExpandedIds string[] No An array of ids that should be pre-expanded
indentationMultiplier number No Indentation (marginStart) per level (defaults to 15)
treeFlashListProps TreeFlatListProps No Props for the flash list
checkBoxViewStyleProps BuiltInCheckBoxViewStyleProps No Props for the checkbox view
CheckboxComponent ComponentType<CheckBoxViewProps> No A custom checkbox component. Defaults to React Native Paper's Checkbox
ExpandCollapseIconComponent ComponentType<ExpandIconProps> No A custom expand/collapse icon component
ExpandCollapseTouchableComponent ComponentType<TouchableOpacityProps> No A custom expand/collapse touchable component
CustomNodeRowComponent React.ComponentType<NodeRowProps> No Custom row item component

ℹ️ If CustomNodeRowComponent is provided then below props are not applied:

  1. indentationMultiplier
  2. checkBoxViewStyleProps
  3. CheckboxComponent
  4. ExpandCollapseIconComponent
  5. ExpandCollapseTouchableComponent.

⚠️ If the tree view doesn't scroll if rendered in a complex nested scroll view/s then try setting the renderScrollComponent value in treeFlashListProps to ScrollView from react-native-gesture-handler.


TreeNode

Property Type Required Description
id string Yes Unique identifier for the node
name string Yes The display name of the node
children TreeNode[] No An array of child TreeNode objects
[key: string] any No Any additional properties for the node
(May be useful to perform search on)

TreeViewRef

Property Type Description
selectAll () => void Selects all nodes
unselectAll () => void Unselects all nodes
selectAllFiltered () => void Selects all filtered nodes
unselectAllFiltered () => void Unselects all filtered nodes
expandAll () => void Expands all nodes
expandNodes () => void Expands specified nodes
collapseAll () => void Collapses all nodes
collapseNodes () => void Collapses specified nodes
setSearchText (searchText: string, searchKeys?: string[]) => void Set the search text and optionally the search keys. Default search key is "name"

Recommended to call this inside a debounced function if you find any performance issue otherwise.

TreeFlatListProps

All properties of FlashListProps(from @shopify/flash-list) except for data and renderItem


BuiltInCheckBoxViewStyleProps

Property Type Required Description
outermostParentViewStyle StyleProp<ViewStyle> No Optional style modifier for the outermost parent view.
checkboxParentViewStyle StyleProp<ViewStyle> No Optional style modifier for the checkbox parent view.
textTouchableStyle StyleProp<ViewStyle> No Optional style modifier for the text touchable style.
checkboxProps CheckboxProps No Optional props for the checkbox component.
textProps TextProps
(React Native)
No Optional props for the text component.

CheckboxProps

All properties of RNPaperCheckboxAndroidProps(from react-native-paper) except for onPress and status


CheckBoxViewProps

Property Type Required Description
value CheckboxValueType Yes The current value of the checkbox
onValueChange (value: boolean) => void Yes Function to be called when the checkbox is pressed
text string Yes The display text besides the checkbox

CheckboxValueType

Type: boolean OR "indeterminate"


ExpandIconProps

Property Type Required Description
isExpanded boolean Yes Indicates if the icon is expanded

NodeRowProps

Property Type Required Description
node TreeNode Yes The node to be rendered
level number Yes The depth of the node in the tree
checkedValue CheckboxValueType Yes The current value of the checkbox
isExpanded boolean Yes Whether the node is expanded or not
onCheck () => void Yes Function to be called when the checkbox is pressed
onExpand () => void Yes Function to be called when the expand button is pressed

🙌 Planned features

  • Row Item full-customization
  • Prop to set the maximum checked item limit
  • Prop to disable certain nodes from getting checked
  • Ref function to programatically expand/collapse a certain node
  • Ref function to programatically un/check a certain node
  • Ref function to auto-scroll to a certain node's position

If you do not see what you want in the planned feature list, raise a feature request.


Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT

Support the project

LiberPay_Donation_Button           Paypal_Donation_Button           Paypal_Donation_Button

❤️ Thanks to


react-native-tree-multi-select's People

Contributors

actions-user avatar dependabot[bot] avatar jairajjangle avatar semantic-release-bot avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

paskdn minhthuhai

react-native-tree-multi-select's Issues

How to get value onCheck

const handleSelectionChange = _checkedIds => {
    // const slug = _checkedIds;
    console.log('slug:', _checkedIds);
  };

how to get data _checkedIds, i can't using setState for set value _checkedId, i need list value using to call api

[FEAT-REQ]: count of checked items in a parent node

Hey!
Thanks for this incredible library!

Is there an approach for getting the count of checked subNodes under a node?

For example

└── Cars (2 out of 3)/
    ├── [x] Hyundai
    ├── [x] Benz
    └── [ ] Tesla

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.