0.0.1 • Published 5 years ago

search-filter-tree v0.0.1

Weekly downloads
4
License
MIT
Repository
github
Last release
5 years ago

SearchTree 搜索树组件

npm.io

何时使用

当子节点内容较多需要搜索并高亮展示时,使用搜索树可快速找到目标节点。

安装

npm install search-filter-tree --save

yarn add search-filter-tree

在代码中使用

import React from "react";
import SearchTree from "search-filter-tree";

const App = () => {
  return (
    <SearchTree
      placeholder="输入节点名称"
      checkable={true}
      dataSource={mock()}
      onCheck={(keys, key, checked) => console.log(keys, key, checked)}
    />
  );
};

function mock() {
  return [
    {
      key: "global",
      title: "global",
      children: []
    },
    {
      key: "dx",
      title: "电信",
      children: [
        {
          key: "dx-huadong",
          title: "电信-华东"
        },
        {
          key: "dx-xian",
          title: "电信-西安"
        },
        {
          key: "dx-huanan",
          title: "电信-华南"
        }
      ]
    }
  ];
}

ReactDOM.render(<App />, mountNode);

API

参数是否必填说明类型默认值
dataSource必填数据源array-
placeholder非必填搜索框提示的文本string"Search"
parentCheckedAble非必填父节点是否可选择boolfalse
parentNodeHide非必填过滤节点时父节点是否隐藏boolfalse
childNodeHide非必填过滤节点时子节点是否隐藏booltrue

数据源dataSource格式

// 每个节点key值必须唯一
[
  {
    key:"1",
    title:"1",
    children:[
      {
        key:"1-1",
        title:"1-1"
      }
    ]
  }
]

注意

  1. react版本尽量在16.8.0之后,否则可能出现未知的问题。
  2. onCheck事件与Tree组件返回的结果不同,返回的参数为:

    参数说明
    keys已选择的全部树节点
    key选择的树节点key
    checked选中或取消选中