npm 包 react-imp-tree 使用教程

阅读时长 9 分钟读完

简介

React-imp-tree 是一款基于 React 的递归树组件,支持单选、复选、异步加载等功能。该组件具有良好的可扩展性,易于定制样式,提供丰富的 API 接口。

安装

使用 npm 安装 react-imp-tree:

使用

引入组件

在组件中引入 react-imp-tree:

使用组件

使用 ReactImpTree 组件渲染树:

-- -------------------- ---- -------
------ ------ - --------- - ---- --------
------ ------------ ---- -----------------

----- --- ------- --------- -
  -------- -
    ----- -------- - -
      -
        --- ----
        ------ ------
        --------- -
          -
            --- ------
            ------ --------
          --
          -
            --- ------
            ------ --------
          --
        --
      --
      -
        --- ----
        ------ ------
      --
    --

    ------ ------------- ------------------- ---
  -
-

------ ------- ----

Props

Prop Type Default Description
treeData Array<object> undefined 渲染树的数据,每个数据项需包含 id(节点唯一标识)和 label(节点名称)两个属性
multiple Boolean false 是否为多选树。如果设置为 true,则支持同时选中多个节点
defaultCheck Array<string> undefined 默认选中的节点 id
checkOnClick Boolean false 是否在点击节点时触发选中操作。如果设置为 true,则支持通过点击节点来实现选中和取消选中节点的操作
onCheck Function undefined 选中节点后的回调函数,将返回一个包含已选节点 id 的数组
onExpand Function undefined 展开节点后的回调函数,将返回一个包含已展开节点 id 的数组
onCollapse Function undefined 折叠节点后的回调函数,将返回一个包含已折叠节点 id 的数组
onAsyncLoad Function undefined 异步加载节点数据时的回调函数,将返回一个 Promise

定制样式

React-imp-tree 支持通过覆盖样式变量来定制组件自带的样式。通过在组件外部定义样式覆盖变量,可以实现自定义主题和自定义样式。

以下为 react-imp-tree 支持的样式变量:

变量名 描述 默认值
--rit-font-size 节点文字大小 14px
--rit-font-weight 节点文字粗细 normal
--rit-color 节点文字颜色 #333
--rit-background 节点背景颜色 #fff
--rit-hover-color 节点鼠标悬浮文字颜色 #333
--rit-hover-bg 节点鼠标悬浮背景颜色 #f5f5f5
--rit-active-color 节点选中后文字颜色 #333
--rit-active-bg 节点选中后背景颜色 #f0f0f0
--rit-expander-color 节点展开/折叠图标颜色 rgba(0, 0, 0, 0.25)

以下为样式覆盖的示例代码:

示例代码

-- -------------------- ---- -------
------ ------ - --------- - ---- --------
------ ------------ ---- -----------------

----- --- ------- --------- -
  ----- - -
    --------- -
      -
        --- ----
        ------ ------
        --------- -
          -
            --- ------
            ------ --------
          --
          -
            --- ------
            ------ --------
          --
        --
      --
      -
        --- ----
        ------ ------
      --
    --
    ----------- ---
    ------------ ---
  --

  ----------- - ------------ -- -
    --------------- ---------- ---
  --

  ------------ - ------------- -- -
    --------------- ----------- ---
  --

  -------------- - -------------- -- -
    --------------- ------------ ---
  --

  --------------- - -------- -- -
    ------ --- ----------------- -- -
      ------------- -- -
        ----- --------- - -
          -
            --- --------------
            ------ ----------------
          --
          -
            --- --------------
            ------ ----------------
          --
        --

        -------------------
      -- ------
    ---
  --

  -------- -
    ----- - --------- ----------- ----------- - - -----------

    ------ -
      -------------
        -------------------
        --------
        -------------------------
        ------------
        --------------------------
        -------------------------
        ----------------------------
        --------------------------------
        ----------------------------------
        -------- ------------------ ------ --
      --
    --
  -
-

------ ------- ----

总结

React-imp-tree 是一款功能丰富、易于定制的递归树组件,具有较好的可扩展性和灵活性。我们可以在此基础上根据实际需求进行功能和样式的定制,提高前端页面开发的效率和质量。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60056cd381e8991b448e664e

纠错
反馈