Welcome to @ifake/tree-path 👋

Get tree path by the given condition.

English | 简体中文

🏠 Homepage

Install

npm install @ifake/tree-path -S
# or
yarn add @ifake/tree-path -S

Usage

• Browser

// We expose a global variable that can be used directly in the browser.const{ treePath }=window.IFakeTP

• ES6 Module

import{treePath}from'@ifake/tree-path'

• CommonJs

const{ treePath }=require('@ifake/tree-path')

API

treePath(TreePath)

exportinterfaceTreePath{tree: TreechildrenKey?: stringbreakCondition: BreakCondition}

• tree Receive an array of object data.
• childrenKey Custom property values, default is children
• breakCondition Receives a real-time value from inside the function, defines conditions based on the value and returns a boolean value.

Example

constsourceData=[{id: 1,child: [{id: '1-1'},{id: '1-2',child: [{id: '1-2-1'}]}]},{id: 2}]constresult=treePath({tree: sourceData,childrenKey: 'child',breakCondition: treeNode=>treeNode.id==='1-2-1'})// The value should be:[{id: 1,child: [...]},{id: '1-2',child: [...]},{id: '1-2-1'}]

Run tests

yarn run test

Author

👤 biyuqiwan@163.com

• Website: http://loadingmore.com
• Github: @BiYuqi

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check issues page.

📝 License

Copyright © 2020 biyuqiwan@163.com.

This project is MIT licensed.

---

This README was generated with ❤️ by readme-md-generator