npm 包 @nylira/vue-key-values 使用教程

阅读时长 6 分钟读完

简介

@nylira/vue-key-values 是一个 Vue.js 的组件库,用于创建键-值对输入框和动态创建和删除窗体。它是基于 Bootstrap 样式的,并与 Vue.js 的表单组件配合使用。

使用方法

安装

通过 npm 安装:

或使用 yarn:

使用

  1. 在 Vue 组件中引入:
  1. 在组件中注册:
-- -------------------- ---- -------
------ ------- -
  ----------- -
    ------------- ----------
  --
  ------ -
    ------ -
      ---------- ---
    --
  --
--
  1. 在模板中使用:

Props

@nylira/vue-key-values 组件有以下 props:

名称 类型 默认值 描述
hideDeleteIcon Boolean false 是否隐藏删除图标
hideAddIcon Boolean false 是否隐藏添加图标
labelField String 'label' 键对应的标签字段名称
valueField String 'value' 值对应的标签字段名称
keysPlaceholder String 'Key' 键输入框的 placeholder
valuesPlaceholder String 'Value' 值输入框的 placeholder
minimumRows Number 1 最小行数
maximumRows Number 0 最大行数,0 代表无上限
maxRowMessage String 'You have reached the maximum number of rows.' 超过最大行数限制时的提示信息

Events

@nylira/vue-key-values 组件触发以下 events:

名称 返回值 描述
onChange Array 值修改时触发的事件,返回keyValues
onAddRow Object 添加一行时触发的事件,返回新行的 key 和 value
onDeleteRow Object 删除一行时触发的事件,返回被删除行的 key 和 value
onReachMaxRowCount Number 超过最大行数限制时触发的事件,返回最大行数

示例代码

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

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

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

以上代码创建了一个 key-values 组件,显示了一个包含三对键-值对的初始状态。它还配置了允许的最大行数为5,并添加了一个 onReachMaxRowCount 事件监听器以处理示例中的超过最大值限制的错误信息。

总结

@nylira/vue-key-values 组件是一个实用的 Vue.js 库,允许你轻松创建表单中的键-值对输入框。使用它可以提高表单的可用性和可读性。学习该组件可以帮助开发人员更好地了解 Vue.js 和 Bootstrap 样式,并为他们的页面创建更美丽的表单。希望本文能对初学者提供有用的指导意义。

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

纠错
反馈