vue自定义组件库发布npm

一,什么是自建组件库?

就是在公司建立自己的类似element-ui组件库,当然第三方都是些通用组件,在公司不限定,业务通用组件也可以算其中的范围。

二,为什么要有自身的组件库?

1.目前公司vue移动端的项目比较多,有一些比较通用的组件重复编写,有组件库避免重复造轮子。
2.一旦组件有什么bug,我们只需要从源头修改,降低维护成本。总而言之,目的降本增效。
3.能提升开发人员封装技能,以前只考虑自己眼前的业务,如果贡献组件库要考虑通用性,以及其它类似场景。

三,包的工程具体怎么做呢?

3.1 基于一个常规的vue的工程,我这边使用vue cli3.0自动生成的工程,使用ts。此处先省略创建过程。
3.2 例如:在vue工程src\components目录下,创建一个查询框组件

vue文件:

<template>
    <div class="textSearch">
        <i class="iconfont  icon-search"></i>
        <input placeholder="请输入搜索关键字" @input="handleInput"/>
    </div>
</template>

<script lang="ts" src="./TextSearch.ts"></script>
<style lang="scss" scoped src="./TextSearch.scss" ></style>

ts文件:

import { Component, Vue, Prop } from 'vue-property-decorator'

@Component({})
export default class TextSearch extends Vue {
    @Prop() private searchInputHandle:any;

    private handleInput (event:any) {
        const value = event.target.value
        this.$emit('searchInputHandle', value)
    }
}

scss文件:

.textSearch {
    display: flex;
    background-color: white;
    position: relative;
    border-bottom: 1px solid #ddd;
    input{
        height: 30px;
        padding: 20px 10px;
        padding-left: 40px;
        margin:20px 30px;
        font-size: 30px;
        border: 0;  
        flex:1;
        background-color: #f8f8f8;
        border-radius: 10px;
    }
    .iconfont{
        position: absolute;
        top: 50%;
        font-size: 32px;
        left:34px;
        margin-top:-16px;
    }
}
3.3 在组件文件夹src\components\TextSearch下,创建一个index.js文件,导出一个插件

index.js文件:

import TextSearch from "./TextSearch.vue"
TextSearch.install = Vue => Vue.component(TextSearch.name, TextSearch);
export default TextSearch;
3.4 在组件文件夹src下,创建一个index.js和一个index.d.ts文件。

index.js :把封装的多个组件统一对外导出一个模块

import ListItem from "./components/ListItem";
import TextSearch from "./components/TextSearch";

export {
    ListItem,
    TextSearch
}

index.d.ts 作用定义一个ts模块,到时候引用时候不报ts模块警告

declare module 'qmh-library';
3.5 修改package.json

重点:private设置为false,mian代表入口文件,types:设置ts模块入口文件,files:上传到npm服务器必备文件

{
  "name": "qmh-library",
  "version": "1.0.6",
  "description": "组件库",
  "private": false,
  "main": "./src/index.js",
  "types": "./src/index.d.ts",
  "files": [
    "src/components/*",
    "src/index.js",
    "src/index.d.ts"
  ],
}
3.6 发布npm包

1.访问https://www.npmjs.com/注册一个账号
2.回到vue工程的终端窗口
登录

npm login

确认登录成功

npm who am i

发布

npm publish

四,发布成功后怎么项目上使用呢?

4.1在vue工程上使用,先安装npm包
npm i qmh-library -S
4.2在入口引入相关组件
import {TextSearch,ListItem} from "qmh-library"
Vue.use(TextSearch)
Vue.use(ListItem)
4.3在业务页面使用相关组件
<template>
  <div class="home">
    <TextSearch></TextSearch>
    <ListItem headText="aaa"></ListItem>
  </div>
</template>
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,123评论 6 490
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,031评论 2 384
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 156,723评论 0 345
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,357评论 1 283
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,412评论 5 384
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,760评论 1 289
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,904评论 3 405
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,672评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,118评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,456评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,599评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,264评论 4 328
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,857评论 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,731评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,956评论 1 264
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,286评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,465评论 2 348