npm 包 @beisen/upaas-lookup-v2 使用教程

简介

@beisen/upaas-lookup-v2 是一款帮助前端开发者实现树形下拉框的工具包。它包含了树形数据的渲染和搜索功能,大大减少了前端开发者在树形下拉框实现上的代码量。

安装

在安装 @beisen/upaas-lookup-v2 前,你需要先安装 Node.js 和 npm。接着,在你的项目目录下执行以下命令安装 @beisen/upaas-lookup-v2:

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

快速上手

基础使用方法

在你的 JavaScript 代码中引入 @beisen/upaas-lookup-v2:

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

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

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

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

通过 config 配置项,传入数据和回调函数 onSelected,可以渲染出一棵树,并在选中节点时触发回调函数。

进阶使用方法

@beisen/upaas-lookup-v2 还支持搜索节点的功能,通过在配置项中传入 searchConfig 参数,可以配置搜索功能的行为。例如:

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

在 searchConfig 配置项中,我们可以配置 searchable 参数来控制搜索框是否出现。通过 debounce 参数,我们可以控制在输入时的搜索间隔时间。searchPath 参数可以指定在哪些字段中搜索关键字。onSearch 回调函数将会传入用户输入的查询字符串作为参数。

API

Lookup(config)

构造函数。用于创建一个实例。config 参数是 Lookup 的配置项,支持以下属性:

  • data:渲染的数据。必须是一个数组类型,包含了节点的 id 和 name 。id 为每个节点的唯一标识;name 为节点的名称。
  • onSelected:在选择节点时发生的回调函数。该函数接受一个被选中节点的对象。
  • searchConfig:搜索结构的配置项,支持以下属性:
    • searchable:是否开启搜索框。默认为 false。
    • debounce:查询间隔时间(毫秒)。默认为 1000。
    • searchPath:在哪些字段中进行搜索。如果只在树的节点名称搜索,这里传入 ['name']。默认为 ['name']。
    • onSearch:在搜索框中输入搜索关键字时触发的回调函数。

Lookup.render()

渲染树形下拉框。调用该方法可以将创建的 Lookup 实例插入到 DOM 中。

Lookup.setData(data)

重新设置树形下拉框的数据。参数 data 必须为一个数组类型,包含了节点的 id 和 name。id 为每个节点的唯一标识;name 为节点的名称。

Lookup.setSearchable(searchable)

设置搜索框是否显示。searchable 为布尔类型。true:显示搜索框;false:隐藏搜索框。

Lookup.setSearchPath(searchPath)

设置搜索的字段。searchPath 必须为一个数组类型,在数组中指定树的节点的哪些字段进行搜索。例如,如果只在 name 属性上搜索关键字,可以指定为 ['name']。

Lookup.setOnSelected(onSelected)

设置选择节点时的回调函数。

Lookup.setOnSearch(onSearch)

设置搜索框中输入关键字时的回调函数。

示例代码

以下是一个完整的示例代码,用于演示 @beisen/upaas-lookup-v2 的常用功能:

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

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

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

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

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

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

总结

通过使用 @beisen/upaas-lookup-v2,前端开发者可以大大减少实现树形下拉框时的代码量,并且拥有了树形数据和搜索功能的支持。上文已经介绍了 @beisen/upaas-lookup-v2 的基础使用和进阶使用方法,同时也讲解了该包的 API 和示例代码。希望读者可以在实际项目中使用该包,并发挥该包的优势。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/60056bda81e8991b448e584a


猜你喜欢

  • npm 包 underscore.getset 使用教程

    简介 npm(Node Package Manager)是 Node.js 平台上的一个包管理和分发工具。在前端开发中,我们常常借助 npm 包来加载和使用第三方库,以加快开发效率。

    3 年前
  • npm包words-animator使用教程

    在现代的前端开发中,动画效果已成为了必不可少的部分。而words-animator这个npm包的出现,为在前端开发中加入文字动画效果的同志们带来了更加简单、灵活的解决方案。

    3 年前
  • npm 包 class-on-off 使用教程

    在前端开发中,我们经常需要在 HTML 元素上添加、移除 CSS 类。手动操作 DOM 来完成这个操作是很繁琐的,但幸运的是,有一个 npm 包叫做 class-on-off 可以使我们更轻松地添加、...

    3 年前
  • npm包js-stand使用教程

    在前端开发领域中,通过使用各种npm包可以让我们更高效、便捷地完成各种任务。其中,js-stand这个npm包就是为前端开发人员提供一种解决方案,以便更快地开发和部署应用程序。

    3 年前
  • npm 包 template-saas-theme 使用教程

    前言 前端开发是一项需要不断学习和探索新技术的工作,其中 npm 包的应用非常广泛,可以方便地将别人开发好的代码引入到项目中,避免重复造轮子。在本文中,我们将介绍一款常用的 npm 包 templat...

    3 年前
  • npm 包 videojs-immerxon 使用教程

    在前端开发中,视频播放是非常常见的一种需求。为了方便快速地实现视频播放功能,我们可以使用许多现有的 npm 包来降低开发难度。其中,videojs-immerxon 是一个功能强大的 npm 包,它可...

    3 年前
  • npm 包 grow-element-fn 使用教程

    在前端开发过程中,使用现有的 npm 库是非常常见的。 npm 是目前最大的软件注册表,也是 JavaScript 生态系统中的核心组成部分。其中一个非常有用的 npm 包是 grow-element...

    3 年前
  • npm 包 file-find 使用教程

    在前端开发中,文件的查找和操作是必不可少的。npm 包 file-find 就是一个非常好用的文件查找工具,让我们更轻松地完成文件的操作。 安装 使用 npm 安装 file-find: --- --...

    3 年前
  • npm 包 with-node-env 使用教程

    介绍 with-node-env 是一个 npm 包,可以让我们在编写 Node.js 应用时更加方便地使用不同的环境变量。 在 Node.js 中,我们可以使用 process.env 来访问环境变...

    3 年前
  • npm 包 casino 使用教程

    引言 在前端开发中,我们经常使用一些 npm 包来完成某些任务,提高开发效率。今天我要介绍的是一个 npm 包 casino,它是一个用于生成随机数字和字母的 JavaScript 库。

    3 年前
  • npm 包 generator-codexmedia 使用教程

    简介 在前端开发中,我们经常需要使用一些工具来加速开发效率,如构建工具、脚手架等。而 generator-codexmedia 就是一个可以帮助我们快速生成前端项目的 npm 包。

    3 年前
  • npm 包 generator-lemon-ts 使用教程

    在前端开发中,我们常常需要创建一些重复的代码文件。为了避免重复劳动,我们可以使用 Yeoman 工具来自动创建项目结构。其中一个非常好用的 Yeoman 生成器是 generator-lemon-ts...

    3 年前
  • npm 包 generator-react-component-boilerplate 使用教程

    什么是 generator-react-component-boilerplate? generator-react-component-boilerplate 是一个 npm 包,它可以生成一个基础...

    3 年前
  • npm 包 @longweiquan/plywood-postgres-requester 使用教程

    简介 @longweiquan/plywood-postgres-requester 是一个用于连接 PostgreSQL 数据库的 Node.js 模块。它基于 plywood-postgres-r...

    3 年前
  • npm 包 react-native-keycloak 使用教程

    简介 Keycloak 是一款开源的身份认证和访问授权管理平台,react-native-keycloak 则是一款基于 Keycloak 的 React Native 插件。

    3 年前
  • npm 包 json-parser-so-spec 使用教程

    在前端开发中,经常需要解析 JSON 数据。而针对 JSON 格式的数据解析,我们可以使用一些常见的工具和库,比如原生 JSON 对象、第三方库 JSON.parse() 或者 jQuery.pars...

    3 年前
  • npm 包 itee-boilerplate 使用教程

    简介 npm 是 Node.js 平台上的一个全球最大的包管理器,对于前端开发者来说,使用 npm 包可以方便快捷地获取需要的第三方库,进而提高开发效率。itee-boilerplate 是一个为了支...

    3 年前
  • npm 包 react-router-preload-core 使用教程

    什么是 react-router-preload-core? react-router-preload-core 是一个 React 路由预加载的核心库,可以帮助开发者预先加载页面组件和相关资源,提高...

    3 年前
  • npm 包 react-router-preload-tree 使用教程

    介绍 react-router-preload-tree 是一个能够帮助 React 开发者快速、高效地预加载路由页面资源的 npm 包。 当我们进行 React 项目开发时,经常会遇到一些需要做路由...

    3 年前
  • npm 包 svgo-inline-loader 使用教程

    什么是 svgo-inline-loader svgo-inline-loader 是一个 webpack loader,用于将 SVG 图标文件转换为可嵌入 HTML 中的内联 SVG。

    3 年前

相关推荐

    暂无文章