npm 包 @beisen-phoenix/switch 使用教程

阅读时长 3 分钟读完

前言

在前端开发中,我们经常会用到各种第三方的工具包。大部分的工具包都被打包成了 npm 包,方便我们通过 npm 安装和使用。@beisen-phoenix/switch 就是一个优秀的前端组件库,在前端开发中扮演着很重要的角色。

@beisen-phoenix/switch 是一款开源的基于 Vue.js 的开关组件,简单易用,功能强大,广泛适用于各种 Web 开发场景。其主要特点为自适应响应式、兼容性优良、允许自定义主题和图标等特性。本文将全面介绍该组件的使用方法。

安装

使用 npm 安装 @beisen-phoenix/switch

快速入门

通过以下代码,即可在页面中添加一个基本的 @beisen-phoenix/switch 开关组件:

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

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

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

Props

@beisen-phoenix/switch 具备以下 Props:

Prop 类型 默认值 说明
value Boolean false 指定开关的状态
disabled Boolean false 指定开关是否失效
width Number, String '2rem' 指定开关的宽度
height Number, String '1rem' 指定开关的高度
color String '#4dda64' 指定开关打开的颜色
uncolor String '#dcdfe6' 指定开关关闭的颜色
circle Boolean false 指定开关是否圆形

事件

@beisen-phoenix/switch 支持以下事件:

事件名称 说明
change 在开关状态被修改后触发

实例方法

@beisen-phoenix/switch 支持以下实例方法:

方法名 说明
toggle() 切换开关状态

自定义主题

通过指定 Props 中的 coloruncolor,可以自定义 @beisen-phoenix/switch 的主题颜色,例如将打开状态的颜色改为蓝色:

同时,也可以通过自定义 slot 来自定义 @beisen-phoenix/switch 的图标和文字。例如,将打开和关闭状态的文字改为

示例代码

完整代码实现示例可参考:https://github.com/beisen-phoenix/switch#readme。

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