npm 包 @atoto/ui 使用教程

阅读时长 7 分钟读完

前言

在前端开发中,我们经常需要使用一些 UI 组件库,以提高开发效率。同样,我们也需要掌握 npm 包管理工具的使用,以便在项目中引入所需的组件库。本文将详细介绍 npm 包 @atoto/ui 的使用方法,并提供示例代码,方便读者更好地理解和应用。

@atoto/ui 介绍

@atoto/ui 是一个基于 Vue.js 的 UI 组件库,提供了一系列常用的、美观易用的组件,如按钮、表单、图标、下拉框等。该组件库具有以下特点:

  • 高质量:组件代码通过严格的单元测试,保证了代码的健壮性和稳定性。
  • 定制性强:易于根据需求自定义组件样式,从而使组件库更符合项目设计风格。
  • 简单易用:所有组件都经过精心设计,使用简便,容易上手。

安装和使用

我们先使用 npm 安装 @atoto/ui:

在我们需要使用该组件库的 Vue.js 项目中,需要在 main.js 中引入 @atoto/ui:

这里需要注意的是,我们需要同时引入 CSS 样式文件,否则组件样式表现会很奇怪。

引入后,我们就可以在 Vue 的 template 中使用了:

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

组件列表

@atoto/ui 提供了以下常用组件:

Button 按钮

使用:<at-button></at-button>

属性

属性名 类型 默认值 说明
type String primary 按钮类型,可选值:primary、success、danger、warning、info
size String medium 按钮尺寸,可选值:small、medium、large
disabled Boolean false 是否禁用
loading Boolean false 是否显示加载状态

事件

事件名 说明 参数
click 点击按钮时触发 Event

Dropdown 下拉框

使用:<at-dropdown></at-dropdown>

Slot

slot名称 说明
default 触发下拉框的区域

属性

属性名 类型 默认值 说明
placement String bottom 下拉框弹出方向,可选值:top、bottom、left、right
trigger String click 触发下拉框的方式,可选值:click、hover
visible Boolean false 是否显示下拉框
showArrow Boolean true 是否显示箭头

事件

事件名 说明 参数
visible-change visible 改变事件 visible(Boolean)

DropdownItem 下拉框选项

使用:<at-dropdown-item></at-dropdown-item>

FormItem 表单项

使用:<at-form-item></at-form-item>

Slot

slot名称 说明
default 需要放入form块中的表单元素

属性

属性名 类型 默认值 说明
label String 表单项标签
label-width String 120px 表单项标签宽度
required Boolean false 是否必填

Input 输入框

使用:<at-input></at-input>

属性

属性名 类型 默认值 说明
value String 输入框绑定值
type String text 输入框类型,可选值:text、password等
placeholder String 输入框提示语
disabled Boolean false 是否禁用
readonly Boolean false 是否只读

事件

事件名 说明 参数
input 输入框值改变事件 value(String)

Icon 图标

使用:<at-icon></at-icon>

属性

属性名 类型 默认值 说明
name String 图标名称
size Number 16 图标大小

示例代码

下面提供一个简单的示例代码,展示如何使用组件库中的 Button 和 Input 组件:

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

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

总结

通过本文的介绍,相信读者已经了解了如何安装和使用 npm 包 @atoto/ui,以及如何应用其中的各种组件。掌握好该组件库的使用,可大力提升前端开发效率,同时也可以帮助我们更好地理解和使用 Vue.js 组件。

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