npm 包 @zhennann/liquor-tree 使用教程

阅读时长 8 分钟读完

前言

在前端开发中,树形结构是一种常见的组织数据的方式。然而,实现一个高效且易用的树形组件并不容易。因此,大多数前端开发者都会选择使用一些成熟的第三方组件库来解决树形组件的需求。在这篇文章中,我们将介绍一个值得推荐的 npm 包,它就是 @zhennann/liquor-tree。

简介

@zhennann/liquor-tree 是一款高度定制化的树形组件,它可以满足开发者各种不同的需求,包括但不限于:

  • 支持异步加载数据
  • 可以自定义节点的样式和字段
  • 支持多选和单选
  • 支持拖拽节点
  • 支持搜索过滤
  • 纯 TypeScript 描述,100% 类型推导

安装

你可以使用 npm 或 yarn 来安装 @zhennann/liquor-tree:

或者

使用

基本用法

使用该组件最简单的例子如下所示:

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

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

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

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

这里使用了一个 React 的函数组件,其中定义了一个 App 组件,它包含了一个 Tree 组件和若干个 TreeNode 子组件。Tree 组件是树形组件的根节点,它有一些常用的 props,如 defaultExpandAllselectedKeysonSelectTreeNode 组件则是树形组件的子节点,它的 props 可以自定义。这里的子节点只是简单地指定了一个标题和一个键值,以方便测试。

异步加载和自定义节点

@zhennann/liquor-tree 也支持异步加载和自定义节点,下面是一个示例,它展示了如何从服务器异步加载数据并将其渲染到树形组件中:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

这里使用了 fetchData 方法模拟从服务器异步加载数据,它返回的是一个 Promise,包含了一个树形数据结构。在 App 组件中,我们定义了 treeData 状态来存储整棵树。使用 useEffectfetchData 方法,在组件挂载的时候先加载数据并保存到 treeData 状态中。同时,我们定义了一个 onLoadData 方法来异步加载子节点的数据,这也是 @zhennann/liquor-tree 组件提供的异步加载特性,它接受一个 key 值,而对应的 promise 处理之后返回其子节点的数据。

除了异步加载之外,我们还可以在 renderTreeNode 方法中自定义节点的样式和字段。这里我们将 node.id 赋值给了 TreeNode 组件的 key 属性,然后使用 node.name 渲染节点的标题。isLeaf 属性可以指示节点是否是叶子节点,这里使用了简单的判断逻辑:如果节点没有子节点,就视为叶子节点。checkableselectable 属性则使节点可以进行选择。最后,我们使用 map 方法来遍历每个子节点。

总结

通过本篇文章,我们详细介绍了 @zhennann/liquor-tree 组件的使用和相关特性。它的灵活性和可定制性是它最值得称赞的特点。同时,它的简单易用也让开发者的工作变得更加高效。希望这篇文章对你有所帮助,也欢迎你在评论区留下你的想法和建议。

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

纠错
反馈