基于elementUI封装自己的UI组件库

不完美00 发表于 2019-12-04 15:55:22

标签: elementUI 自定义UI组件

- +

初始化 project

这里我们使用官方的 vue-cli 初始化一个 Vue 项目

npm install -g @vue/cli
# or
yarn global add @vue/cli
vue create admin-ui



    在src的同级目录创建packages文件夹,用于存放需要打包的组件

packages目录.png

    package目录结构

目录.png

接下来让我们写一个简单的Vue component,基于elementUI的input组件的封装

<template>
  <div v-show="showInput">
    <el-input v-model="currentValue" v-bind="$props" @keydown.enter.native="handleInputEnter" :placeholder="placeholder" :dataType="dataType" ref="input" :inputPattern='inputPattern'>
      
      </template>
    </el-input>
    <div :style="{ visibility: !!editorErrorMessage ? 'visible' : 'hidden' }">{{ editorErrorMessage }}</div>
  </div>
</template>
<script>
import { Input, Button, Select, Option } from 'element-ui'
import pattern from '../../pattern.js'
 
const EMAIL_ERROR = '邮箱验证失败';
 
export default {
  name: "FkInput",
  data() {
    return {
      editorErrorMessage: null,
      showInput: true,
      inputType: '',
      emailPattern: pattern.email
    };
  },
  props: {
    ...Input.props, //继承elementUI原有的props
    ...Button.props,
    ...Select.props,
    ...Option.props,
    value: {
      type: [Number, String],
      default: ''
    },
    placeholder: {
      type: String,
      default: '请输入内容'
    },
    inputPattern: {
      type: [Object, String],
      default: null
    }
  },
  computed: {
    currentValue: {
      get: function() {
        return this.value;
      },
      set: function(newValue) {
        this.$emit("input", newValue); // 通过 input 事件更新 model
      }
    }
  },
  methods: {
    evtChange(newValue, lr) {
      this.$emit('change', newValue, lr); // 事件传值
    },
    handleInputEnter() {
      if (this.inputType !== 'textarea') {
        this.validate()
      }
    },
    validate() {
      const type = this.dataType && this.dataType.toLowerCase();
      var pattern = this.inputPattern ? this.inputPattern.pattern : '',
        message = this.inputPattern ? this.inputPattern.message : '';
      if (type || pattern) {
        switch (type) {//在实际项目中需要对多种输入数据类型进行验证,本例只验证了邮箱
          case 'email':
            pattern = this.emailPattern;
            message = EMAIL_ERROR;
            break;
          default:
            break;
        }
        if (pattern && !pattern.test(this.currentValue || '')) {
          this.editorErrorMessage = message;
          return false;
        }
      }
      
      this.editorErrorMessage = '';
    }
  },
  mounted() {
    this.$nextTick(_ => {
      this.inputType = this.$refs.input.type;
    })
    console.log('mounted');
  },
  updata() {
 
  },
  watch: {
    currentValue: {
      immediate: true,
      handler(val) {
        this.$nextTick(_ => {
          if (this.inputType !== 'textarea' && val !== '') {
            this.validate();
          } else if (val == '') {
            this.editorErrorMessage = ''
          }
        });
      }
    }
  }
}
 
</script>
<style stylus="css">
</style>


组件需加上name属性,在使用组件时,用的就是name的值作为标签值,上面的input组件在使用时<fk-input></fk-input> 

配置 project

下面我们来配置当前项目, 以使其可以发布到 npm 上.

如果组件进行按需引入,我们需要每个组件注册到Vue上,因此单个组件中需要暴露我们的Component:

component1.png

/packages/input/index.js
import FkInput from './src/input.vue'
FkInput.install = function (Vue) {
             Vue.component(FkInput.name, FkInput)
}
export default FkInput

然后我们编辑入口文件 packages/index.js,使其被作为UI库导入时能自动在Vue中注册我们的Component:

import FkInput from './input/index.js'
const components = [
  FkInput
]
const install = function(Vue) {
  components.forEach(component => {
    Vue.component(component.name, component);
  });
}
 
if (typeof window !== 'undefined' && window.Vue) {
  install(window.Vue);
}
 
export default {
        FkInput,
        install
}
export {
  FkInput,
  install
}

elementUI的引入方式有两种:一种是按需引入,比如某个项目中只使用了某几个组件,可以使用下面的方式

import { Button,Input }
from 'element-ui'
Vue.use(Button)
Vue.use(Input)

如果项目中使用了很多elementUI组件,为了避免漏掉引入的组件,可以使用下面的引入方式

import UI from 'element-ui'
Vue.use(UI)

此处也是为了可以使用按需引入的方式进行加载组件,export了两次;

export暴露出来可以在使用时按需引入,export default暴露出来的组件只能在使用时全局引入。

接下来我们添加 build项目的脚本到package.json的scripts中:

package.png

 其中 --name admin-ui 指定的是要发布的library的名称,我们执行上面新家的脚本:

npm run lib


这里我们选择默认发布我们的 *.common.js 文件, 所以我们在 package.json中添加main属性.

main.png

指定该属性后, 当我们引用该组件库时, 会默认加载 main 中指定的文件.

最后, 我们再配置 package.json中的 files属性, 来配置我们想要发布到 npm 上的文件路径.

我们这里将用户引用我们的组件库可能用到的所有文件都放进来:

file.png

最终的配置为

conf.png

npm 发布

首先我们注册一个 npm 账号 (如果已有账号, 可以跳过此步骤)

npm add user// 按照提示输入用户名, 邮箱等即可


然后使用 npm login 登录注册号的状态

登录后可以使用 npm whoami 查看登录状态

在发布之前, 我们修改一下项目的名称(注意不要和已有项目名称冲突), 推荐使用 @username/projectName 的命名方式.

接下来我们就可以发布我们的 UI 组件库了, 在发布之前我们再编译一次, 让build出的文件为我们最新的修改:

npm run lib


我们使用下面的命令发布我们的项目:

npm publish --access public


需要注意的是 package.json中指定的version属性: 每次要更新我们的组件库都需要更新一下version,配置中的private属性需要设置为false

测试使用

这样我们就完成了自己的 UI 组件库的发布. 接下来我们可以在任何需要使用到该组件库的项目中使用:

Import UI '@ssthouse/admin-ui'
Vue.use(UI)


接下来我们就可以在 Vue的template中使用组件库中的 Component了:

<template>
  <fk-input v-model="input" :inputPattern="inputPattern" clearable></fk-input>
</template>
<script>
export default {
  name: '',
  data() {
    return {
      input: '',
      placeholder: '',
      inputPattern:{
        pattern: /[\w!#$%&'*+/=?^_`{|}~-]+(?:\.[\w!#$%&'*+/=?^_`{|}~-]+)*@(?:[\w](?:[\w-]*[\w])?\.)+[\w](?:[\w-]*[\w])?/,
        message: '此信息是验证失败提示'
      }
    }
  }
}
}
 
</script>


最后

经过上面这些步骤后, 我们就拥有了一个属于自己的组件库了. 我们可以随时更新, 发布自己新版的组件库.

而依赖了该组件库的项目只需要使用简单的 npm 命令即可更新 : )


possitive(7) views7274 comments3

发送私信

最新评论

又 又 2021-07-19 16:12:44

非常棒,很详细,感谢作者


王露 2020-12-23 14:54:45

fda


王露 2020-12-23 14:54:40

;lkjhfg


请先 登录 再评论.
相关文章
  • 微信公众号在线生成二维码带参数怎么搞?

    带参数二维码是微信公众号渠道二维码的一种实现
    微信的带参数二维码有两种,一种是临时二维码,一种是永久二维码,但是永久二维码的生成是有个数限制的,微...

  • 2019年NodeJS框架Koa和Express选型比较

    Koa和Express都是NodeJS的主流应用开发框架。
    Express是一个完整的nodejs应用框架。Koa是由Express团队开发的,但是它有不同的关注点。Koa致力于核心中间件...

  • WebGL场景中多相机拍摄的原理和意义

    一般而言,3D场景的渲染只需要一个相机,不过借助多相机可以获取一些单相机无法达到的特效。比如突显特定对象并模糊背景。
    3D相机渲染的基本原理是依靠颜色...

  • ARCore基本概念和工作原理简介

    谷歌的WebAROnARCore项目基于Android手机提供的ARCore增强现实引擎,要了解WebAROnARCore,需要先了解ARCore的工作原理。基本上ARCore做了两件事,首先跟踪手机...

  • Monaco Editor 编辑器拷贝粘贴功能调用和获取选中文本

    有时候需要在monaco editor外部调用编辑器的内置功能比如希望在页面主工具栏实现一些快捷操作。button

  • html5跨平台实战-第一周-水平测验-新闻列表页面

    这是一个DIV+CSS布局页面的一个实例,主要介绍POSITION定位、导航UL LI的制作、利用浮动原理对页面分栏、分列的页面布局。新闻页面的效果图

  • 创建非矩形网页页面元素的常用技术和实例代码

    非矩形设计正在变成一种时尚,比如波浪形、菱形、三角形等:而随着技术发展,这种设计在技术实现上也变得更容易。本文以最简单的三角形为例,演示使用5种方法来...

  • CSS3属性选择器特性使用详解

    CSS3除了引入动画、滤镜(用于特效)以及新的布局技术外,在选择器(selector)方面也有增强。属性选择器根据元素的属性(attributes)来匹配。这可以是一个单独...

  • JavaScript事件模型图解

    在JavaScript中用户交互的核心部分就是事件处理。本文为对事件模型和处理机制的总体性描述。Event是什么?
    event是用户操作网页时发生的交互动作,比如clic...

  • 使用HTML5 FileReader和Canvas压缩用户上传的图片

    手机用户拍的照片通常会有2M以上,这对服务器带宽产生较大压力。因此在某些应用下(对图片要求不那么高)我们可以在客户端来压缩图片,然后再提交给服务器。总体...

  • 深度贴图(depth map)概念简介和生成流程

    Depth map 深度图是一张2D图片,每个像素都记录了从视点(viewpoint)到遮挡物表面(遮挡物就是阴影生成物体)的距离,这些像素对应的顶点对于观察者而言是“可...

  • WebGL入门教程5 - 详解纹理滤镜(Texture Filter)

    WebGL中使用纹理贴图来实现细腻的物体表面观感,其中一个重要的参数是纹理滤镜(Texture Filter)。
    这个参数用来处理当对象出现缩放时,纹理如何处理中间...

  • WebGL入门教程1 - 3D绘图基础知识

    现代浏览器努力使得Web用户体验更为丰富,而WebGL正处于这样的技术生态系统的中心位置。其应用范围覆盖在线游戏、大数据可视化、计算机辅助设计、虚拟现实以及数...

  • 在PHP网页程序中执行Sass/Compass命令

    我们需要在wow云开发平台支持sass/compass等预编译样式语言,为此我们首先尝试了scssphp扩展,但是在支持最新语法上,经常会出现异常。所以我们采用了代理的方式...

  • 更多...