npm 包 weuicore_test001_jskang 使用教程

阅读时长 7 分钟读完

1. 什么是 weuicore_test001_jskang

weuicore_test001_jskang 是一个npm包,它提供了一些基础前端实用工具函数和可视化组件的封装,旨在帮助前端开发者更快速地开发和构建前端应用程序。 它包含了一些常用的函数和组件,比如输入框、按钮、弹窗、表格等等。而且,可以很方便的在Vue、React等前端框架中使用。

2. 如何使用 weuicore_test001_jskang

2.1 安装

在终端中使用如下命令进行安装:

2.2 引入 weuicore_test001_jskang

在需要使用weuicore_test001_jskang组件的地方引入即可:

2.3 使用示例

  • Button组件
-- -------------------- ---- -------
----------
  -----
    ------- -------------- -------------------------------------
    ------- ------------- ------------------------------------
    ------- -------------- -------------------------------------
  ------
-----------

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

------ ------- -
  ----- ----------------
  ----------- -
    ------
  --
  -------- -
    ------------- -
      ---------------- ------- -----
    -
  -
-
---------
  • Input组件
-- -------------------- ---- -------
----------
  -----
    ------ --------------- ------------------- ----- ---- ----- --
  ------
-----------

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

------ ------- -
  ----- ---------------
  ----------- -
    -----
  --
  ---- -- -
    ------ -
      ------ --
    -
  -
-
---------
  • Dialog组件
-- -------------------- ---- -------
----------
  -----
    ------- -------------- ------------------------- ---------------
    ------- ----------------------- ----------- -- - ------- ------------
      ------- -- --- ------- -- --- -----------
      ---- ------------- ----------------------
        ------- -------------- ----------- ---------------------------- - ------------------
        ------- ----------- ---------------------------- - ------------------
      ------
    ---------
  ------
-----------

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

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

3. API 文档

3.1 Button组件

参数 说明 类型 默认值
type 按钮类型,可选值为 primary / info / warning / danger / success / text String default
size 尺寸,可选值为 medium / small / mini String medium
disabled 是否禁用按钮 Boolean false
icon 按钮 icon 类型,参见 element-ui icon 组件 String -

3.2 Input组件

参数 说明 类型 默认值
type 类型,可选值为 text / password / url / email / tel / number String text
value 绑定的值 String / Number -
placeholder 占位文本 String -
disabled 是否禁用输入框 Boolean false
clearable 是否启用清空按钮 Boolean false
readonly 是否只读 Boolean false

3.3 Dialog组件

参数 说明 类型 默认值
title 标题 String -
width 弹框宽度 String -
visible.sync 是否显示 Dialog,支持 .sync 修饰符 Boolean false
customClass Dialog 的自定义类名 String -
top Dialog CSS 中的 top 值 String 15%
modal 是否需要遮罩层 Boolean true
modalAppendToBody 是否将遮罩层插入到 body 元素上 Boolean true
lockScroll 是否在 Dialog 出现时将 body 滚动锁定 Boolean true
closeOnClickModal 是否可以通过点击 modal 关闭 Dialog Boolean true
closeOnPressEscape 是否可以通过按下 ESC 键关闭 Dialog Boolean true
showClose 是否显示右上角关闭按钮 Boolean true
beforeClose 关闭前的回调函数,会暂停 Dialog 的关闭 Function -

4. 总结

通过使用weuicore_test001_jskang,可以快速构建前端 UI,并且支持自定义主题和组件。我们还可以从中学习到如何开发一个npm包,以及如何将自己的组件发布到 npm。相信,weuicore_test001_jskang将为前端开发者的工作带来更多便利和效率。

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

纠错
反馈