npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-native-tree-multi-select

v1.7.0

Published

A super-fast, customizable tree view component for React Native with multi-selection, checkboxes, and search filtering capabilities.

Downloads

766

Readme

react-native-tree-multi-select

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

npm version License Workflow Status cov Android iOS Web GitHub issues TS Known Vulnerabilities Expo Snack npm bundle size

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.

Highlighted Features

  • Fast: Designed with performance in mind for smooth scrolling and quick selections.
  • 🛠️ Highly Customizable: Modify styles, behavior, and use your custom list component to suit your application's needs.
  • 🔍 Filterable: Quickly filter through tree nodes and option to select and un-select only the filtered tree nodes.
  • Well Tested: Comprehensive test coverage to ensure reliability and stability.
  • 📚 Well Documented: Detailed documentation to get you started and an example app to demo all the features.
  • 🌳 Multi-Level Selection: Select individual nodes or entire branches with ease.
  • 📦 Supports Large Datasets: Efficiently handles large trees without much performance degradation.
  • 🔒 TypeScript Support: Full TypeScript support for better developer experience.
  • 💻 Cross-Platform: Works seamlessly across iOS, Android, and web (with React Native Web).

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[],
      _indeterminateIds: string[]
  ) => {
      // NOTE: Handle _checkedIds and _indeterminateIds 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?.();
  const selectNodes = (idsToExpand: string[]) => treeViewRef.current?.selectNodes?.(
    idsToSelect
  );
  const unselectNodes = (idsToCollapse: string[]) => treeViewRef.current?.unselectNodes?.(
    idsToUnselect
  );
  
  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[], indeterminateIds: string[]) => void | No | Callback when a checkbox state changes | | 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 | | selectionPropagation | SelectionPropagation | No | Control Selection Propagation Behavior. Choose whether you want to auto-select children or parents. | | 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 | | collapseAll | () => void | Collapses all nodes | | expandNodes | (ids: string[]) => void | Expands specified nodes | | collapseNodes | (ids: string[]) => void | Collapses specified nodes | | selectNodes | (ids: string[]) => void | Selects specified nodes | | unSelectNodes | (ids: string[]) => void | Unselects 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. |


SelectionPropagation

| Property | Type | Required | Description | | ------------ | --------- | -------- | ------------------------------------------------------------ | | toChildren | boolean | No | Whether to propagate selection to children nodes. Defaults to true. | | toParents | boolean | No | Whether to propagate selection to parent nodes. Defaults to true. |


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

  • [x] Row Item full-customization
  • [x] Prop to control auto children and parents selection. Can now be done using selectionPropagation prop 🎉
  • [ ] Prop to set the maximum checked item limit
  • [ ] Prop to disable certain nodes from getting checked
  • [x] Ref function to programatically expand/collapse a certain node
  • [x] 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.


💡 Some Expo Snack Examples

  1. Radio button like selection in tree view: Snack link
  2. Display count of number of checked nodes: Snack link

Contributing

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

License

MIT

🙏 Support the project

❤️ Thanks to