NPM 包 JSer-Vue 使用教程

阅读时长 14 分钟读完

JSer-Vue 是一款基于 Vue.js 的轻量级前端组件库,提供了一些实用的组件和工具函数,可用于快速构建前端项目。本篇文章将介绍 JSer-Vue 的基本用法和一些应用示例。

安装

使用 npm 安装 JSer-Vue,执行以下命令:

使用

在需要使用 JSer-Vue 的项目入口文件中,引入 JSer-Vue:

这里先简单说明一下上述代码的含义:

  1. 导入 JSer-Vue 包,通过 import 将其引入到项目中。
  2. 导入 CSS 文件,这里使用的是 JSer-Vue 的默认样式。
  3. 使用 Vue.use() 全局安装 JSer-Vue 插件,这样在整个 Vue 实例中都可以使用 JSer-Vue 提供的组件和函数。

组件

Button

Button(按钮)是一个常用的 UI 组件,JSer-Vue 中提供了 Button 组件。使用方式如下:

Button 组件提供了以下属性:

属性名 类型 描述
type String 按钮类型,默认为 default
size String 按钮大小,默认为 medium
disabled Boolean 是否禁用按钮
loading Boolean 是否显示加载状态
round Boolean 是否使用圆角样式(矩形或圆角矩形)
icon String 按钮图标,使用 Font Awesome 字体图标

Loading

Loading(加载中)是一个实用的组件,可用于在页面中显示加载状态。使用方式如下:

Loading 组件提供了以下属性:

属性名 类型 描述
color String 加载图标颜色
size String 加载图标大小
text String 加载中显示的文本

Modal

Modal(对话框)是一个常用的 UI 组件,JSer-Vue 中提供了 Modal 组件。使用方式如下:

Modal 组件提供了以下属性:

属性名 类型 描述
visible Boolean 是否显示 Modal,默认为 false
title String Modal 标题
width String Modal 宽度,默认为 50%
close-on-click-mask Boolean 点击蒙层是否可关闭 Modal,默认为 true
close-on-press-escape Boolean 按键 Esc 是否可关闭 Modal,默认为 true

Notification

Notification(通知)是一个实用的组件,可用于在页面中显示通知信息。使用方式如下:

Notification 组件提供了以下方法:

方法名 描述
this.$notify() 显示通知信息
this.$notify.error() 显示错误信息
this.$notify.success() 显示成功信息
this.$notify.warning() 显示警告信息

Form

Form(表单)是一个常用的 UI 组件,JSer-Vue 中提供了 Form 组件和相关的表单控件组件。使用方式如下:

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

Form 组件提供了以下属性:

属性名 类型 描述
model Object 表单数据对象
rules Object 表单验证规则对象
label-position String 字段名称位置
label-width String 字段名称宽度
inline Boolean 是否为行内表单模式
validate-on-blur Boolean 是否在失去焦点时触发验证

Form 组件中常用的控件组件有:

组件名 描述
jser-input 文本输入框
jser-select 下拉选项框
jser-radio-group 单选框组,多个单选框共用一个 v-model,值为选中的值
jser-checkbox-group 多选框组,多个多选框共用一个 v-model,值为选中的值
jser-switch 开关
jser-slider 滑块
jser-time-picker 时间选择器
jser-date-picker 日期选择器
jser-rate 评分组件
jser-form-item 表单项组件,包含 label 和控件组件
jser-tip 提示框
jser-form-item-error-tip 错误提示组件,用于在校验失败时提示用户错误信息
jser-form-item-help-tip 帮助提示组件,用于在表单项旁边显示帮助信息,如输入格式等。
jser-form-item-description 描述组件,用于在控件组件下方显示描述信息

工具函数

除了提供一些常用的组件,JSer-Vue 还提供了一些实用的工具函数。

validate

validate 是一个表单验证函数,可用于验证表单数据。使用方式如下:

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

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

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

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

validate 函数接受两个参数,分别为表单数据对象和表单验证规则对象。如果验证通过,返回 null;否则返回一个错误信息对象,其中每个属性都对应一个控件组件的 prop 属性值,属性值为错误信息。

debounce

debounce 是一个防抖函数,可用于防止在短时间内重复触发函数。使用方式如下:

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

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

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

debounce 函数接受两个参数,分别为需要防抖的函数和防抖时间(单位为毫秒),返回一个新的函数,该函数在被连续调用时,只会执行最后一次调用并在防抖时间后执行。

示例

下面是一些应用示例,帮助你更好地了解 JSer-Vue 的使用方法。

表单验证

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

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

Loading 使用

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

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

Modal 使用

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

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

总结

在本篇文章中,我们介绍了 JSer-Vue 的基本用法和一些应用示例,学习了其提供的一些实用组件和工具函数。JSer-Vue 不仅提供了实用的组件和函数,还提供了默认样式和组件皮肤等方便的定制选项,可以大大加快前端项目开发的速度。

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

纠错
反馈