基于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(58) views13117 comments4

发送私信

最新评论

2022-11-01 17:15:33

攒攒


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

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


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

fda


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

;lkjhfg


请先 登录 再评论.
相关文章
  • CentOS6 Apache2.2多站点HTTPS配置

    可以使用letsencrypt(certbot)免费证书服务。支持多系统、多站点和多目录,支持wildcard(通配符域名),90天生效,可用定时任务自动更新。需要注意一点的是apache2.4以下版本需要在默认的ssl配置中添加如下的指令:NameVirtualHost

  • 谷歌ARCore技术特性简介

    谷歌美国时间2017.8.29号刚发布了ARCore预览版,这是一个类似于苹果ARKit的增强现实SDK,在此之前,谷歌虽然已投资AR平台Tango,但由于需要特定的硬件和传感器,...

  • A-Frame WebVR(网页虚拟现实)快速开发入门教程

    WebVR和WebGL应用程序接口使得我们已经可以在浏览器上创建虚拟现实(VR)体验,但从工程化的角度而言,开发社区还需要更多方便强大的开发库来简化编程,Mozilla的

  • Web界面编程状态变化和JS开发框架(React/Angular/Ember)

    UI编程中的一个关键课题就是界面组件化(可复用)以及组件状态管理。稍早一些的windows程序员可能接触过MFC,其界面编程中有一个DDX(DoDataExchange)的机制,...

  • 深入理解CSS3滤镜(filter)功能和实例详解

    CSS3滤镜功能源自SVG滤镜规范,SVG滤镜最早用来给矢量图添加类似PS中像素图的一些特效。
    把这个滤镜功能引入到普通HTML元素中可以带来很有趣的效果(模糊、...

  • 通过实例深入理解HTML5/CSS3/SVG/WebGL的技术本质

    常常听到人们对于HTML5的讨论,看了页面头部这个那个就是HTML5,误认为HTML5只是新增些标签“而已”,学完了

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

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

  • 三维向量的简单运算和实用意义

    在WebGL的实际应用中我们广泛使用向量的几何运算来计算角度、距离,判断点线、点面之间的关系,比如物体之间的碰撞检测。本文简要介绍三维计算机图形学中常用的...

  • Three.js入门教程5 - 10个必须知道的编程技巧

    作者为Google的Paul,关于如何写出好的WebGL代码的文章。和很多开发者一样,我通过实践学习,但同时我也向其他更有经验的开发者们学习。在过去的几个月中,我在c...

  • S3TC(S3 Texture Compression)纹理压缩格式详解

    使用S3TC格式存储的压缩纹理是以4X4的纹理单元块(texel blocks)为基本单位存储的,每纹理单元块(texel blocks)有64bit或者128bit的纹理单元数据(texel data)。这...

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

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

  • 如何使用CSS3实现一个平滑的3D文本标题

    要实现3D文本,基本上有3种方法:1. 使用CSS3的投影滤镜(filter: drop-shadow)2. 使用3d建模和CSS3 3d变换来实现(最真实)3. 使用CSS3 text-shadow属性来实现...

  • 如何使用纯CSS3实现一个3D泡沫

    要实现一个逼真的泡沫,涉及到比较复杂的光学/物理学知识。我们这里先简化下问题,实现一个相对简单而足够实用的泡沫元素。我们可以把基础的泡沫元素应用在很多场景中,比如水景、泡咖啡、啤酒甚至火焰特效中。泡沫首先是一个圆形元素.bubble

  • 更多...