vue3+TS实现简易组件库

vue3+TS搭建一个自己的组件库。

前置

首先下载vue-cli，搭建我们的环境，vue-create-luckyUi，选择vue3和TypeScript 。在src目录下创建package作为组件目录。再安装bootstrap，用bootstrap里面的样式来完成我们的组件。

组件编写

dropdown

首先查看boorstrap文档，是这样用的

Dropdown button
ActionAnother actionSomething else here
 

首先那个button按钮就是我们dropdown按钮的内容，将这部分作为属性传入，而dropdown-menu的内容是作为dropdown-item的，明显这里不能固定写三个，这里就用插槽占位，再封装一个dropdown-item组件。

首先dropdown组件内容如下：

dropdown-item的内容就是：

还要实现一个点击dropdown，dropdown-item会随之收起来的功能，这个比较简单，在dropdown上绑定一个点击事件来控制变量isOpen为true或者false，在加上v-if即可实现功能。接下来还要实现一个点击页面的其他地方也能实现dropdown-item收缩，这里有两个思路：

• 首先在document上添加一个click事件，一旦触发就设置isOpen为false，给dropdown也添加一个点击事件，加上一个事件修饰符stop来阻止事件冒泡，这样除了点击dropdown意外的任何地方，document都会触发点击事件。
• 第二个思路就是让事件冒泡到document，通过判断事件对象包不包括我们的目标对象，如果不包括说明点击的是页面的其他地方，就设置isOpen为false。这里用了到了组合式api，新建文件package/hooks/useClickOutside.ts，

import { ref, onMounted, onUnmounted, Ref } from 'vue'

const useClickOutside = (elementRef: Ref) => {const isClickOutside = ref(false)const handler = (e: MouseEvent) => {if (elementRef.value) {if (elementRef.value.contains(e.target as HTMLElement)) {isClickOutside.value = false} else {isClickOutside.value = true}}}onMounted(() => {document.addEventListener('click', handler)})onUnmounted(() => {document.removeEventListener('click', handler)})return isClickOutside
}

export default useClickOutside 

然后直接导入即可使用定义的useClickOutside函数。这里监听isClickOutside的状态来更改isOpen的状态。

import useClickOutside from "../hooks/useClickOutside";
...
const isClickOutside = useClickOutside(dropdownRef);

watch(isClickOutside, () => {if (isOpen.value && isClickOutside.value) {isOpen.value = false;}
}); 

form

首先看下文档用法

Email addressWe'll never share your email with anyone else.
Password
Check me out
Submit
 

首先编写ValidateForm组件：

接着编写ValidateInput.vue组件：

这里核心的地方有两点：

• 自定义组件实现v-model，vue2中自定义组件实现v-mdel必须要绑定一个value属性和input事件，在input事件中将输入的值传递给value。在vue3中就需要绑定一个modelValue和update:modelValue事件
• 还有就是父子组件之间的传值问题，因为有插槽，没办法使用常规的属性传值，这里使用的事件传值采用了一个第三方库mitt。在父组件中通过emitter.on('form-item-created', callback)来注册事件，在子组件中通过emitter.emit('form-item-created', validateInput)触发事件。

验证

新建文件package/index.ts

import 'bootstrap/dist/css/bootstrap.min.css'

//导入组件
import Dropdown from "./Dropdown/Dropdown.vue";
import DropdownItem from "./Dropdown/DropdownItem.vue";

const components = [Dropdown,DropdownItem
]

const install = (Vue: any) => {components.forEach((_: any) => {Vue.component(_.name, _);});
};

export default {install
}; 

将写的组件依次导入，然后定义一个install函数，该函数有一个Vue实例的参数，在函数中依次遍历我们的导入组件数组，然后将组件挂载到vue实例上，导出install函数。

在根目录下的main.ts上使用我们的新组件：

import { createApp } from 'vue'
import App from './App.vue'

import luckyUi from './package/index';

const app = createApp(App)

app.use(luckyUi);

app.mount('#app') 

在app.vue中进行测试：

最后使用vue自带的脚手架进行打包，详细可看文档。

在package中配置打包命令：

"lib": "vue-cli-service build --target lib --name lucky-ui ./src/package/index.ts" 

运行npm run lib即可在dist目录下查看。

最后

最近找到一个VUE的文档，它将VUE的各个知识点进行了总结，整理成了《Vue 开发必须知道的36个技巧》。内容比较详实，对各个知识点的讲解也十分到位。

有需要的小伙伴，可以点击下方卡片领取，无偿分享