ls-el-ui v0.1.0
基本介绍
做什么?
Vue 进阶-从 0 到 1 搭建 UI 组件库
哪些内容?
封装常见的功能性组件(Button、Modal、Form 相关) 把组件封装成 UI 组件库并且发布到 NPM 上
涉及知识点
vue 基础语法 组件基本语法 组件通讯(sync,provide,inject) 插槽的使用 props 校验 过渡与动画处理 计算属性与监听属性 v-model 语法糖 vue 插件机制 npm 发布
掌握组件封装的语法和技巧 学会造轮子,了解 element-ui 组件库的实现原理 搭建和积累自己的组件库。
学习前提
- 有一定的 vue 基础,懂 vue 的基本语法
- 熟悉 ES6 的一些常见语法
- 对 vue 感兴趣。
效果演示
初始化 vue 项目
vue create demo
安装组件库
yarn add ls-ui
全局导入
import LsUI from 'ls-ui' import 'ls-ui/lib/lsui.css'
Vue.use(LsUI)
使用组件
常见组件封装
项目初始化
使用 vue-cli 脚手架快速搭建一个 vue 项目
// 选择scss babel 和 eslint
vue create itcast-ui
启动项目
cd itcast-ui
yarn serve
button 组件
前置知识
组件通讯
组件插槽
props校验
参数支持
参数名 参数描述 参数类型 默认值
type 按钮类型(primary / success / warning / danger / info) string default
plain 是否是朴素按钮 boolean false
round 是否是圆角按钮 boolean false
circle 是否是圆形按钮 boolean false
disabled 是否禁用按钮 boolean false
icon 图标类名 string 无
事件支持
事件名 事件描述 click 点击事件
基本结构
<template>
<button class="ls-button">
<span><slot></slot></span>
</button>
</template>
样式
.ls-button {
display: inline-block;
line-height: 1;
white-space: nowrap;
cursor: pointer;
background: #fff;
border: 1px solid #dcdfe6;
color: #606266;
-webkit-appearance: none;
text-align: center;
box-sizing: border-box;
outline: none;
margin: 0;
transition: 0.1s;
font-weight: 500;
// 禁止元素的文字被选中
-moz-user-select: none;
-webkit-user-select: none;
-ms-user-select: none;
padding: 12px 20px;
font-size: 14px;
border-radius: 4px;
&:hover,
&:focus {
color: #409eff;
border-color: #c6e2ff;
background-color: #ecf5ff;
}
}
type 属性
结构
<button class="ls-button" :class="[`ls-button--${type}`]">
js
props: {
type: {
type: String,
default: 'default'
}
},
样式
.ls-button--primary {
color: #fff;
background-color: #409eff;
border-color: #409eff;
&:hover,
&:focus {
background: #66b1ff;
border-color: #66b1ff;
color: #fff;
}
}
.ls-button--success {
color: #fff;
background-color: #67c23a;
border-color: #67c23a;
&:hover,
&:focus {
background: #85ce61;
border-color: #85ce61;
color: #fff;
}
}
.ls-button--info {
color: #fff;
background-color: #909399;
border-color: #909399;
&:hover,
&:focus {
background: #a6a9ad;
border-color: #a6a9ad;
color: #fff;
}
}
.ls-button--warning {
color: #fff;
background-color: #e6a23c;
border-color: #e6a23c;
&:hover,
&:focus {
background: #ebb563;
border-color: #ebb563;
color: #fff;
}
}
.ls-button--danger {
color: #fff;
background-color: #f56c6c;
border-color: #f56c6c;
&:hover,
&:focus {
background: #f78989;
border-color: #f78989;
color: #fff;
}
}
plain 属性
// 朴素的按钮
.ls-button.is-plain {
&:hover,
&:focus {
background: #fff;
border-color: #409eff;
color: #409eff;
}
}
.ls-button--primary.is-plain {
color: #409eff;
background: #ecf5ff;
border-color: #b3d8ff;
&:hover,
&:focus {
background: #409eff;
border-color: #409eff;
color: #fff;
}
}
.ls-button--success.is-plain {
color: #67c23a;
background: #f0f9eb;
border-color: #c2e7b0;
&:hover,
&:focus {
background: #67c23a;
border-color: #67c23a;
color: #fff;
}
}
.ls-button--info.is-plain {
color: #909399;
background: #f4f4f5;
border-color: #d3d4d6;
&:hover,
&:focus {
background: #909399;
border-color: #909399;
color: #fff;
}
}
.ls-button--warning.is-plain {
color: #e6a23c;
background: #fdf6ec;
border-color: #f5dab1;
&:hover,
&:focus {
background: #e6a23c;
border-color: #e6a23c;
color: #fff;
}
}
.ls-button--danger.is-plain {
color: #f56c6c;
background: #fef0f0;
border-color: #fbc4c4;
&:hover,
&:focus {
background: #f56c6c;
border-color: #f56c6c;
color: #fff;
}
}
round 属性
.ls-button.is-round {
border-radius: 20px;
padding: 12px 23px;
}
circle 属性
// 原形按钮
.ls-button.is-circle {
border-radius: 50%;
padding: 12px;
}
icon 的支持
在 main.js 中引入字体图标文件
import './assets/fonts/font.scss'
结构
<i :class="icon" v-if="icon"></i>
<slot></slot>
js
icon: {
type: String,
default: ''
}
样式
// 按钮后的文本
.ls-button [class*=ls-icon-]+span {
margin-left: 5px;
}
禁用按钮
props
disabled: Boolean
结构
<button class="ls-button" :class="[`ls-button--${type}`, { 'is-plain': plain, 'is-round': round, 'is-circle': circle, 'is-disabled': disabled }]" :disabled="disabled" @click="handleClick" >
样式
// 禁用 .ls-button.is-disabled, .ls-button.is-disabled:focus, .ls-button.is-disabled:hover { color: #c0c4cc; cursor: not-allowed; background-image: none; background-color: #fff; border-color: #ebeef5; } .ls-button.is-disabled, .ls-button.is-disabled:focus, .ls-button.is-disabled:hover { color: #c0c4cc; cursor: not-allowed; background-image: none; background-color: #fff; border-color: #ebeef5; } .ls-button--primary.is-disabled, .ls-button--primary.is-disabled:active, .ls-button--primary.is-disabled:focus, .ls-button--primary.is-disabled:hover { color: #fff; background-color: #a0cfff; border-color: #a0cfff; } .ls-button--success.is-disabled, .ls-button--success.is-disabled:active, .ls-button--success.is-disabled:focus, .ls-button--success.is-disabled:hover { color: #fff; background-color: #b3e19d; border-color: #b3e19d; } .ls-button--info.is-disabled, .ls-button--info.is-disabled:active, .ls-button--info.is-disabled:focus, .ls-button--info.is-disabled:hover { color: #fff; background-color: #c8c9cc; border-color: #c8c9cc; } .ls-button--warning.is-disabled, .ls-button--warning.is-disabled:active, .ls-button--warning.is-disabled:focus, .ls-button--warning.is-disabled:hover { color: #fff; background-color: #f3d19e; border-color: #f3d19e; } .ls-button--danger.is-disabled, .ls-button--danger.is-disabled:active, .ls-button--danger.is-disabled:focus, .ls-button--danger.is-disabled:hover { color: #fff; background-color: #fab6b6; border-color: #fab6b6; }
click 事件支持
结构
@click="handleClick"
js
methods: {
handleClick (e) {
this.$emit('click', e)
}
}
dialog 组件
前置知识
vue过渡与动画
sync修饰符
具名插槽与v-slot指令
参数支持
参数名 参数描述 参数类型 默认值
title 对话框标题 string 提示
width 宽度 string 50%
top 与顶部的距离 string 15vh
visible 是否显示 dialog(支持 sync 修饰符) boolean false
事件支持
事件名 事件描述
opened 模态框显示的事件
closed 模态框关闭的事件
插槽说明
插槽名称 插槽描述
default dialog 的内容
title dialog 的标题
footer dialog 的底部操作区
基本结构
结构
<template>
<div class="ls-dialog__wrapper">
<div class="ls-dialog">
<div class="ls-dialog__header">
<span class="ls-dialog__title">提示</span>
<button class="ls-dialog__headerbtn">
<i class="ls-icon-close"></i>
</button>
</div>
<div class="ls-dialog__body">
<span>这是一段信息</span>
</div>
<div class="ls-dialog__footer">
<ls-button>取消</ls-button>
<ls-button type="primary">确定</ls-button>
</div>
</div>
</div>
</template>
样式
.ls-dialog__wrapper {
position: fixed;
top: 0;
right: 0;
bottom: 0;
left: 0;
overflow: auto;
margin: 0;
z-index: 2001;
background-color: rgba(0,0,0, .5);
.ls-dialog {
position: relative;
margin: 15vh auto 50px;
background: #fff;
border-radius: 2px;
box-shadow: 0 1px 3px rgba(0,0,0,.3);
box-sizing: border-box;
width: 30%;
&__header {
padding: 20px 20px 10px;
.ls-dialog__title {
line-height: 24px;
font-size: 18px;
color: #303133;
}
.ls-dialog__headerbtn {
position: absolute;
top: 20px;
right: 20px;
padding: 0;
background: transparent;
border: none;
outline: none;
cursor: pointer;
font-size: 16px;
.el-icon-close {
color: #909399;
}
}
}
&__body {
padding: 30px 20px;
color: #606266;
font-size: 14px;
word-break: break-all;
}
&__footer {
padding: 10px 20px 20px;
text-align: right;
box-sizing: border-box;
.ls-button:first-child {
margin-right: 20px;
}
}
}
}
title 属性
title 属性既支持传入 title 属性,也只是传入 title 插槽
结构
<slot name="title">
<span class="ls-dialog__title">{{title}}</span>
</slot>
js
props: {
title: {
type: String,
default: '提示'
}
}
width 属性与 top 属性
结构
<div class="ls-dialog" :style="style">
js
props: {
title: {
type: String,
default: '提示'
},
width: {
type: String,
default: '50%'
},
top: {
tpye: String,
default: '15vh'
}
},
computed: {
style () {
return {
width: this.width,
marginTop: this.top
}
}
}
内容插槽
<div class="ls-dialog__body">
<!-- 默认插槽 -->
<slot></slot>
</div>
底部插槽
<div class="ls-dialog__footer" v-if="$slots.footer">
<slot name="footer"></slot>
</div>
控制显示与隐藏
结构
<div class="ls-dialog__wrapper" v-show="visible">
点击遮罩层关闭
<div class="ls-dialog__wrapper" v-show="visible" @click.self="handleClose">
点击关闭按钮关闭
<button class="ls-dialog__headerbtn" @click="handleClose">
关闭处理
handleClose () {
this.$emit('update:visible', false)
}
动画处理
结构
<transition name="dialog-fade" @after-enter="afterEnter" @after-leave="afterLeave"></transition>
样式
.dialog-fade-enter-active {
animation: dialog-fade-in .4s;
}
.dialog-fade-leave-active {
animation: dialog-fade-out .4s;
}
@keyframes dialog-fade-in {
0% {
transform: translate3d(0, -20px, 0);
opacity: 0;
}
100% {
transform: translate3d(0, 0, 0);
opacity: 1;
}
}
@keyframes dialog-fade-out {
0% {
transform: translate3d(0, 0, 0);
opacity: 1;
}
100% {
transform: translate3d(0, -20px, 0);
opacity: 0;
}
}
js
afterEnter () {
this.$emit('opened')
},
afterLeave () {
this.$emit('closed')
}
input 组件
参数支持
参数名称 参数描述 参数类型 默认值
placeholder 占位符 string 无
type 文本框类型(text/password) string text
disabled 禁用 boolean false
clearable 是否显示清空按钮 boolean false
show-password 是否显示密码切换按钮 boolean false
name name 属性 string 无
事件支持
事件名称 事件描述
blur 失去焦点事件
change 内容改变事件
focus 获取的焦点事件
基本结构
节本结构
<template>
<div class="ls-input">
<input type="text" class="ls-input__inner">
</div>
</template>
样式
.ls-input {
width: 100%;
position: relative;
font-size: 14px;
display: inline-block;
.ls-input__inner {
-webkit-appearance: none;
background-color: #fff;
background-image: none;
border-radius: 4px;
border: 1px solid #dcdfe6;
box-sizing: border-box;
color: #606266;
display: inline-block;
font-size: inherit;
height: 40px;
line-height: 40px;
outline: none;
padding: 0 15px;
transition: border-color .2s cubic-bezier(.645,.045,.355,1);
width: 100%;
&:focus {
outline: none;
border-color: #409eff;
}
}
}
props 处理 placeholde, type,name
placeholer
props: {
placeholder: {
type: String,
default: ''
}
}
type 属性-密码框
<input class="ls-input__inner" :placeholder="placeholder" :type="type" :disabled="disabled" >
type: {
type: String,
default: 'text'
},
禁用按钮-disabled
结构
<div class="ls-input">
<input
class="ls-input__inner"
:class="{'is-disabled': disabled}"
:placeholder="placeholder"
:type="type"
:disabled="disabled"
>
</div>
js
disabled: {
type: Boolean,
default: false
}
样式
&.is-disabled {
background-color: #f5f7fa;
border-color: #e4e7ed;
color: #c0c4cc;
cursor: not-allowed;
}
v-model 语法糖
v-model 语法糖
给普通表单元素元素使用 v-model
给组件使用 v-model 指令,实质上相当于给组件传递了 value 属性以及监听了 input 事件 等价与
html 结构
js
props: {
value: [String, Number]
},
methods: {
handleInput (e) {
this.$emit('input', e.target.value)
}
}
clearable 与 show-password 处理
如果给 input 组件传入 clearable 属性,会显示一个清空的按钮,如果传入 show-password,则会显示一个用于切换密码显示的处理
基本结构
props 接收
clearable: { type: Boolean, default: false }, showPassword: { type: Boolean, default: false }
控制按钮显示和隐藏
样式
.ls-input--suffix {
.ls-input__inner {
padding-right: 30px;
}
.ls-input__suffix {
position: absolute;
height: 100%;
right: 10px;
top: 0;
line-height: 40px;
text-align: center;
color: #c0c4cc;
transition: all .3s;
z-index: 900;
i {
color: #c0c4cc;
font-size: 14px;
cursor: pointer;
transition: color .2s cubic-bezier(.645,.045,.355,1);
}
}
}
控制 ls-input--suffix 的类名
使用计算属性优化
computed: { showSuffix () { return this.clearable || this.showPassword } }
注册事件-清空内容和切换密码显示
clear () { // console.log('123') this.$emit('input', '') }
控制密码显示
data () { return { // 是否显示密码 passwordVisible: false } },
<input class="ls-input__inner" :class="{'is-disabled': disabled}" :placeholder="placeholder" :type="showPassword ? (passwordVisible ? 'text': 'password') : type" :name="name" :disabled="disabled" :value="value" @input="handleInput" ref="input"
handlePasswordVisible () { // 切换 type 类型 this.passwordVisible = !this.passwordVisible }
其他常见事件的支持
handleFocus (e) {
this.$emit('focus', e)
},
handleBlur (e) {
this.$emit('blur', e)
},
handleChange (e) {
this.$emit('change', e.target.value)
}
switch 组件
参数支持
参数名称 参数描述 参数类型 默认值
v-model 双向绑定 布尔类型 false
name name 属性 string text
activeColor 自定义的激活的颜色 string
inactiveColor 自定义的不激活的颜色 string
事件支持
事件名称 事件描述
change change 时触发的事件
基本结构
页面
样式
.ls-switch { display: inline-flex; align-items: center; position: relative; font-size: 14px; line-height: 20px; height: 20px; vertical-align: middle; .ls-switchcore { margin: 0; display: inline-block; position: relative; width: 40px; height: 20px; border: 1px solid #dcdfe6; outline: none; border-radius: 10px; box-sizing: border-box; background: #dcdfe6; cursor: pointer; transition: border-color .3s,background-color .3s; vertical-align: middle; .ls-switchbutton { position: absolute; top: 1px; left: 1px; border-radius: 100%; transition: all .3s; width: 16px; height: 16px; background-color: #fff; } } }
v-mode 双向绑定
接收 value 值
props: { value: { type: Boolean, default: false } },
注册点击事件
事件处理程序
methods: { handleClick () { this.\$emit('input', !this.value) } }
选中样式
.ls-switch.is-checked { .ls-switchcore { border-color: #409eff; background-color: #409eff; .ls-switchbutton { transform: translateX(20px); } } }
控制选中样式
自定义颜色
在使用 switch 时,希望能够自定义开关的颜色
<ls-switch
v-model="value"
active-color="#13ce66"
inactive-color="#ff4949">
</ls-switch>
props 接收
activeColor: { type: String, default: '' }, inactiveColor: { type: String, default: '' }
封装设置颜色的方法
setColor () { if (this.activeColor || this.inactiveColor) { let color = this.value ? this.activeColor : this.inactiveColor this.$refs.core.style.borderColor = color this.$refs.core.style.backgroundColor = color } }
页面一进入调用
mounted () { // 设置颜色 this.setColor() },
改变状态后调用
async handleClick () { this.$emit('input', !this.value) // 改变input框的值 await this.$nextTick() this.setColor() },
name 属性支持
用户在使用 switch 组件的时候,实质上是当成表单元素来使用的。因此可能会用到组件的 name 属性。因此需要在 switch 组件中添加一个 checkbox,并且当值改变的时候,也需要设置 checkbox 的 value 值
结构
<input class="ls-switch__input" type="checkbox"
样式
.ls-switch__input { position: absolute; width: 0; height: 0; opacity: 0; margin: 0; }
name 属性的支持
name: { type: String, default: '' }
控制 checkbox 的值与 value 同步
mounted () { this.$refs.input.checked = this.value }, methods: { async handleChange () { this.$emit('input', !this.value) // 修改checkbox的值 await this.$nextTick() this.$refs.input.checked = this.value } }
radio 组件
前置知识点
radio的基本使用
参数支持
参数名称 参数描述 参数类型 默认值
v-model 双向绑定 布尔类型 false
label 单选框的 value 值 string,num,boolean ''
name name 属性 string
基本结构
html 结构
样式
.ls-radio { color: #606266; font-weight: 500; line-height: 1; position: relative; cursor: pointer; display: inline-block; white-space: nowrap; outline: none; font-size: 14px; margin-right: 30px; -moz-user-select: none; -webkit-user-select: none; -ms-user-select: none; .ls-radioinput { white-space: nowrap; cursor: pointer; outline: none; display: inline-block; line-height: 1; position: relative; vertical-align: middle; .ls-radioinner { border: 1px solid #dcdfe6; border-radius: 100%; width: 14px; height: 14px; background-color: #fff; position: relative; cursor: pointer; display: inline-block; box-sizing: border-box; &:after { width: 4px; height: 4px; border-radius: 100%; background-color: #fff; content: ""; position: absolute; left: 50%; top: 50%; transform: translate(-50%,-50%) scale(0); transition: transform .15s ease-in; } } .ls-radiooriginal { opacity: 0; outline: none; position: absolute; z-index: -1; top: 0; left: 0px; right: 0; bottom: 0; margin: 0; } } .ls-radiolabel { font-size: 14px; padding-left: 10px; } }
选中的样式
.ls-radio.is-checked {
.ls-radio__input {
.ls-radio__inner {
border-color: #409eff;
background: #409eff;
&:after {
transform: translate(-50%,-50%) scale(1);
}
}
}
.ls-radio__label {
color: #409eff;
}
}
label 与插槽的处理
props 接收
props: { label: { type: String, default: '' }, name: { type: String, default: '' } }
处理插槽
v-model 处理
接收 props 数据
name: { type: String, default: '' }, value: { type: String, Boolean, Number, default: '' }
结构
<input class="ls-radio__original" type="radio" :name="name" value="label" v-model="model"
提供计算属性
computed: { model: { get () { return this.value }, set (value) { this.\$emit('input', value) } } },
控制选中样式
radio-group 组件
使用 radio 组件的缺点,需要给每个组件都绑定 v-mode,可以使用 radio-group 包裹
前置知识
provide与inject
基本结构
结构
<template>
<div class="radio-group">
<slot></slot>
</div>
</template>
数据
export default {
name: 'LsRadioGroup',
provide () {
return {
RadioGroup: this
}
},
props: {
value: null
}
}
修改 radio 组件
接收 inject
inject: { RadioGroup: { default: '' } },
计算属性判断是否包裹在 group 中
// 判断包裹在 group 中 isGroup () { return !!this.RadioGroup }
修改代码
model: { get () { return this.isGroup ? this.RadioGroup.value : this.value }, set (value) { this.isGroup ? this.RadioGroup.$emit('input', value) : this.$emit('input', value) } }
checkbox 组件
基本结构
<template>
<label class="ls-checkbox">
<span class="ls-checkbox__input">
<span class="ls-checkbox__inner"></span>
<input type="checkbox" class="ls-checkbox__original">
</span>
<span class="ls-checkbox__label">
<slot></slot>
<template v-if="!$slots.default">{{label}}</template>
</span>
</label>
</template>
样式
.ls-checkbox {
color: #606266;
font-weight: 500;
font-size: 14px;
position: relative;
cursor: pointer;
display: inline-block;
white-space: nowrap;
user-select: none;
margin-right: 30px;
.ls-checkbox__input {
white-space: nowrap;
cursor: pointer;
outline: none;
display: inline-block;
line-height: 1;
position: relative;
vertical-align: middle;
.ls-checkbox__inner {
display: inline-block;
position: relative;
border: 1px solid #dcdfe6;
border-radius: 2px;
box-sizing: border-box;
width: 14px;
height: 14px;
background-color: #fff;
z-index: 1;
transition: border-color .25s cubic-bezier(.71,-.46,.29,1.46),background-color .25s cubic-bezier(.71,-.46,.29,1.46);
&:after {
box-sizing: content-box;
content: "";
border: 1px solid #fff;
border-left: 0;
border-top: 0;
height: 7px;
left: 4px;
position: absolute;
top: 1px;
transform: rotate(45deg) scaleY(0);
width: 3px;
transition: transform .15s ease-in .05s;
transform-origin: center;
}
}
.ls-checkbox__original {
opacity: 0;
outline: none;
position: absolute;
left: 10px;
margin: 0;
width: 0;
height: 0;
z-index: -1;
}
}
.ls-checkbox__label {
display: inline-block;
padding-left: 10px;
line-height: 19px;
font-size: 14px;
}
}
选中的样式
.ls-checkbox.is-checked {
.ls-checkbox__input {
.ls-checkbox__inner {
background-color: #409eff;
border-color: #409eff;
&:after {
transform: rotate(45deg) scaleY(1);
}
}
}
.ls-checkbox__label {
color: #409eff;
}
}
接收 props 数据
value: {
type: Boolean,
default: false
},
name: {
type: String,
default: ''
},
label: {
type: String,
default: ''
}
控制 checked 样式
控制 label
提供 model 计算属性
model: { get () { return this.value }, set (value) { this.\$emit('input', value) } }
判断是否选中
checkbox-group 组件
使用 checkbox-group 组件包裹 checkbox
结构
<template>
<div class="ls-checkbox-group">
<slot></slot>
</div>
</template>
提供 provide
props: { value: { type: Array, default: function () { return [] } } }, provide () { return { CheckboxGroup: this } }
修改 checkbox
接收 inject
inject: { CheckboxGroup: { default: '' } },
修改
model: { get () { return this.isGroup ? this.CheckboxGroup.value : this.value }, set (value) { if (this.isGroup) { // 修改value属性 console.log(value, this.label) this.CheckboxGroup.$emit('input', value) } else { this.$emit('input', value) } } },
isGroup () { return !!this.CheckboxGroup }, isChecked () { // 判断是否选中 // console.log(this.model) if (this.isGroup) { return this.model.includes(this.label) } else { return this.model } }
form 组件
基本结构
<template>
<div class="ls-form">
<slot></slot>
</div>
</template>
<script>
export default {
name: 'LsForm',
provide () {
return {
Form: this
}
},
props: {
model: {
type: Object,
required: true
},
labelWidth: {
type: String,
default: '80px'
}
}
}
</script>
<style>
</style>
form-item 组件
基本结构
<template>
<div class="ls-form-item">
<label class="ls-form-item__label" :style="labelStyle">{{label}}</label>
<div class="ls-form-item__content">
<slot></slot>
</div>
</div>
</template>
<script>
export default {
name: 'LsFormItem',
props: {
label: {
type: String,
default: ''
}
},
inject: ['Form'],
computed: {
labelStyle () {
return {
width: this.Form.labelWidth
}
}
}
}
</script>
<style lang="scss">
.ls-form-item {
margin-bottom: 25px;
.ls-form-item__label {
text-align: right;
vertical-align: middle;
float: left;
font-size: 14px;
color: #606266;
line-height: 40px;
padding: 0 12px 0 0;
box-sizing: border-box;
}
.ls-form-item__content {
line-height: 40px;
position: relative;
font-size: 14px;
overflow: hidden;
}
}
</style>
封装成 UI 组件库
目录调整
根目录创建两个文件夹 packages 和 examples
packages: 用于存放所有的组件 examples: 用于进行测试,把 src 改成 examples
- 把 components 中所有的组件放入到 packages 中
- 把 fonts 放到 packages 中
- 删除原来的 src 目录
vue.config.js 配置
新增 vue.config.js 配置
const path = require('path')
module.exports = {
pages: {
index: {
entry: 'examples/main.js',
template: 'public/index.html',
filename: 'index.html'
}
},
// 扩展 webpack 配置,使 packages 加入编译
chainWebpack: config => {
config.module
.rule('js')
.include.add(path.resolve(__dirname, 'packages')).end()
.use('babel')
.loader('babel-loader')
.tap(options => {
// 修改它的选项...
return options
})
}
}
统一导出 packages 中所有的组件
// 统一导出 // 导入颜色选择器组件 import Button from './button' import Dialog from './dialog' import Input from './input' import Checkbox from './checkbox' import Radio from './radio' import RadioGroup from './radio-group' import Switch from './switch' import CheckboxGroup from './checkbox-group' import Form from './form' import FormItem from './form-item' import './fonts/font.scss'
// 存储组件列表 const components = Button, Dialog, Input, Checkbox, Radio, RadioGroup, Switch, CheckboxGroup, Form, FormItem
// 定义 install 方法,接收 Vue 作为参数。如果使用 use 注册插件,则所有的组件都将被注册 const install = function (Vue) { // 遍历注册全局组件 components.forEach(component => { Vue.component(component.name, component) }) }
// 判断是否是直接引入文件,如果是,就不用调用 Vue.use() if (typeof window !== 'undefined' && window.Vue) { install(window.Vue) }
// 导出的对象必须具有 install,才能被 Vue.use() 方法安装 export default { install }
测试
在 examples 中的 main.js 中进行导入测试
import Vue from 'vue'
import App from './App.vue'
import LsUI from '../packages'
Vue.use(LsUI)
Vue.config.productionTip = false
new Vue({
render: h => h(App)
}).$mount('#app')
发布到 npm 与 github
发布到 github
发布到 npm
https://cli.vuejs.org/zh/guide/build-targets.html#%E5%BA%93
在 scripts 中新增一条 打包命令
"lib": "vue-cli-service build --target lib packages/index.js"
- 发布到 npm
修改 package.json 文件
"private": false,
"main": "dist/itcast-ui.umd.min.js",
"author": {
"name": "胡聪聪"
},
增加 `.npmignore 文件
# 忽略目录
examples/
packages/
public/
# 忽略指定文件
vue.config.js
babel.config.js
*.map
npm 发布
npm login npm publish
4 years ago