npm 包 @beisen-phoenix/field-department 使用教程

介绍

@beisen-phoenix/field-department 是一款基于 React 开发的前端组件,用于显示 and 处理组织架构中的部门。

该组件提供了以下功能:

  • 展示部门列表
  • 支持搜索部门
  • 支持添加部门
  • 支持修改部门
  • 支持删除部门

@beisen-phoenix/field-department 上线已有一段时间,已被多家企业使用,并得到了广泛好评。

安装

使用 npm 进行安装:

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

快速开始

在项目中使用该组件:

  1. 导入组件
------ - --------------- - ---- ----------------------------------
  1. 创建组件实例
---------------- ---------------------------- --
  1. yourChangeHandler 中获取返回值
-------- ------------------------ -
  ------------------ -- - ------------- - ----- ---- ------- ----- -- ----------- ---- -
-

注意,@beisen-phoenix/field-department 实际上返回了一个对象,其中包含选择的部门和员工信息。如果目前选中的是员工,则 department 字段为 null,反之亦然。

完整 API 文档

DepartmentField

DepartmentField 是该组件的主要元素,用于显示 and 处理组织架构中的部门。

属性

属性名 类型 默认值 描述
dataSource Array<DepartmentFieldDataSource> [] 组件的数据源,不传则不显示搜索部门的功能
onChange function - 点击部门或员工时的回调函数
onSearch function - 传入搜索框后的回调函数
value DepartmentFieldValue null 当前选中的部门和员工信息
width number|string '100%' 组件的宽度
formItemProps object {} 作为表单元素时的属性,例如 getFieldDecorator
DepartmentFieldDataSource

DepartmentFieldDataSource 是组件数据源的类型,是一个包含 id, name, isLeaf, children 等信息的对象,例如:

-
  ----- ----
  ------- ------
  --------- ------
  ----------- -
    -
      ----- ------
      ------- ---- - ---
      --------- ------
      ----------- -
        -
          ----- --------
          ------- ---- - - - ---
          --------- ----
        -
      -
    -- -
      ----- ------
      ------- ---- - ---
      --------- ------
      ----------- -
        -
          ----- --------
          ------- ---- - - - ---
          --------- ----
        -
      -
    -
  -
-
属性名 类型 默认值 描述
id string required 部门|员工的 ID
name string required 部门|员工的名称
isLeaf boolean false 是否为叶节点,叶节点代表员工
children Array<DepartmentFieldDataSource> [] 非叶节点的子节点
DepartmentFieldValue

DepartmentFieldValue 是组件选中的部门和员工信息类型,是一个包含 department, employee 等信息的对象,例如:

-
  ------------- - ----- ---- ------- ----- --
  ----------- - ----- -------- ------- --- -- -
-
属性名 类型 默认值 描述
department object null 选中的部门信息
employee object null 选中的员工信息

DepartmentFieldModal

DepartmentFieldModal 是 DepartmentField 的一个子组件,用于向用户展现修改部门信息的对话框。

属性
属性名 类型 默认值 描述
record DepartmentFieldDataSource {} 要修改的部门信息
dataSource Array<DepartmentFieldDataSource> [] 数据源,如果不传递该参数,则不显示该组件
visible boolean false 是否显示该组件
onCancel function - 取消编辑的回调函数,可以不传递该参数,则不显示取消按钮。
onOk function - 完成编辑的回调函数,必须传递该参数
formProps object {} 传入 antd form 组件的属性
modalProps object {} 传入 antd modal 组件的属性

使用示例

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

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

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

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

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

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

结尾

到此为止,@beisen-phoenix/field-department 的使用教程结束。如果需要更加详细的信息,可以参考组件源代码或文档,希望本文对你的前端学习有所帮助!

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/beisen-phoenix-field-department


猜你喜欢

  • GraphQL:用 Connection 优化节点查询

    前言 GraphQL 是一种由 Facebook 开发的数据查询和操作语言,它提供了一种更高效、更灵活的方式来获取和操作数据。GraphQL 的一个重要特性就是可以精确地指定需要查询的数据,避免了传统...

    2 个月前
  • Server-sent Events 的浏览器支持情况及解决方法

    什么是 Server-sent Events? Server-sent Events(简称 SSE)是一种基于 HTTP 的服务器推送技术,它可以让服务器向客户端发送事件流,客户端通过监听这个事件流来...

    2 个月前
  • ECMAScript 2020(ES11)中的新特性:BigInt 转换

    在 ECMAScript 2020(ES11)中,新增了一种数据类型:BigInt。它是一种可以表示任意大整数的数据类型,可以用来解决 JavaScript 中整数运算的精度问题。

    2 个月前
  • CSS Reset 在 IE6、IE7 等老浏览器中的应用

    什么是 CSS Reset CSS Reset 是一种通过重置浏览器默认样式的方式,消除不同浏览器之间的差异,从而实现更加一致的样式效果的技术手段。在前端开发中,使用 CSS Reset 可以让我们更...

    2 个月前
  • ES6 中的类继承和原型链之间的关系解析

    在 ES6 中,引入了 class 关键字,使得 JavaScript 也具备了面向对象编程的能力。在类继承和原型链之间,有着密切的关系。本文将详细解析 ES6 中的类继承和原型链之间的关系,并提供一...

    2 个月前
  • 如何使用 Redux 处理 React 应用中的表单数据

    前言 在开发 React 应用时,表单数据的处理是非常常见的需求。然而,由于 React 的单向数据流和组件化特性,传统的表单处理方式可能会变得非常繁琐。而 Redux 作为一种状态管理工具,可以帮助...

    2 个月前
  • Redis 处理高并发的策略

    前言 随着互联网的发展,高并发已经成为了一个不可避免的问题。而 Redis 作为一款高性能的 NoSQL 数据库,也成为了处理高并发的重要工具之一。本文将会介绍 Redis 处理高并发的策略,并且会提...

    2 个月前
  • 响应式设计中的图片适配问题解决方案

    在响应式设计中,图片适配是一个比较棘手的问题。如果不加以处理,可能会导致图片在不同设备上显示不佳,影响用户体验。本文将介绍响应式设计中的图片适配问题,并提供解决方案。

    2 个月前
  • 解析 TypeScript 中 encapsulation(封装)的实现方式

    解析 TypeScript 中 encapsulation(封装)的实现方式 在 TypeScript 中,封装(encapsulation)是一种重要的面向对象编程的特性。

    2 个月前
  • PM2 崩溃处理:如何避免由于 PM2 进程奔溃导致应用崩溃?

    在前端开发中,我们经常使用 PM2 进行进程管理和部署。但是,当 PM2 进程崩溃时,应用也会跟着崩溃。如何避免这种情况的发生?本文将介绍 PM2 崩溃处理的方法和技巧,帮助您更好地管理和部署应用。

    2 个月前
  • 在 Node.js 中运行 HTTPS 服务器的方法

    Node.js 是一个非常流行的 JavaScript 运行时环境,它可以让我们通过 JavaScript 编写服务器端应用程序。在开发 Web 应用程序时,安全性是非常重要的。

    2 个月前
  • 详解 ECMAScript 2018 中的三个新操作符及其用法

    ECMAScript 2018 (简称 ES2018) 是 JavaScript 语言的最新标准,其中包含了许多新特性和语法糖。本文将详细介绍其中的三个新操作符及其用法,分别是:扩展运算符、剩余运算符...

    2 个月前
  • 解决 Enzyme 测试 React Native 组件时动画无法渲染的问题

    在开发 React Native 应用时,我们经常需要使用 Enzyme 来测试组件。然而,当我们测试涉及到动画的组件时,我们可能会遇到一些问题:动画无法渲染,导致测试失败。

    2 个月前
  • 使用 React Router 打造复杂而强大的 SPA 应用

    随着 Web 技术的不断发展,单页应用(Single Page Application,SPA)已经成为了现代 Web 应用的主流。SPA 通过异步加载数据和动态更新页面,提供了更快速、更流畅的用户体...

    2 个月前
  • AngularJS 中如何使用 ng-repeat 中的 filter 来过滤数据

    在 AngularJS 中,ng-repeat 指令是用于循环遍历数组或对象并生成 HTML 元素的常用指令。而 ng-repeat 指令中的 filter 属性则是用于过滤数据的功能。

    2 个月前
  • 如何在 Chai 中验证 Promise.all

    如何在 Chai 中验证 Promise.all 在前端开发中,Promise.all 是一个非常常用的功能,它可以让我们在多个异步操作完成后再执行一些操作,这个功能在实际开发中非常实用。

    2 个月前
  • Mongoose 实现数据批量更新的方式详解

    前言 在前端开发中,经常会涉及到对数据库中的数据进行批量更新的操作。而 Mongoose 是一款 Node.js 平台下的 MongoDB 对象模型工具,它提供了一种方便的方式来操作 MongoDB ...

    2 个月前
  • 在使用 lit-element 的时候,如何解决麻烦的 Shadow DOM 的变量传递问题

    前言 在使用 Web Components 的时候,我们通常会使用 Shadow DOM 来实现封装和样式隔离。然而,Shadow DOM 的封闭性也带来了一些挑战,其中之一就是变量传递问题。

    2 个月前
  • Tailwind CSS 如何实现动态换肤?

    随着互联网的发展,越来越多的网站和应用开始支持动态换肤功能。动态换肤不仅可以提升用户体验,还可以让用户在不同的环境下选择适合自己的主题,增加用户黏性和满意度。本文将介绍如何使用 Tailwind CS...

    2 个月前
  • 如何在 Less 中使用字符串操作函数?

    在前端开发中,样式表是不可或缺的一部分。而 Less 是一种动态样式语言,它是 CSS 的一种扩展。在 Less 中,我们可以使用字符串操作函数来处理字符串,这些函数可以帮助我们更加方便地操作字符串,...

    2 个月前