从0搭建vue3组件库:Shake抖动组件

简介: 从0搭建vue3组件库:Shake抖动组件

image.png

先看下效果

image.png

其实就是个抖动效果组件,实现起来也非常简单。之所以做这样一个组件是为了后面写Form表单的时候会用到它做一个规则校验,比如下面一个简单的登录页面,当点击登录会提示用户哪个信息没输入,当然这只是一个简陋的demo

image.png

接下来就开始我们的Shake组件实现


CSS样式



当你需要抖动的时候就给它添加个抖动的类名,不需要就移除这个类名即可。抖动效果就用CSS3中的transform的平移属性加动画实现

@keyframes shake {
    10%,
    90% {
        transform: translate3d(-1px, 0, 0);
    }
    20%,
    80% {
        transform: translate3d(2px, 0, 0);
    }
    30%,
    70% {
        transform: translate3d(-4px, 0, 0);
    }
    40%,
    60% {
        transform: translate3d(4px, 0, 0);
    }
    50%,
    50% {
        transform: translate3d(-4px, 0, 0);
    }
}
.k-shake.k-shakeactive {
    animation: shake 1s linear;
}

组件逻辑



根据上面效果,很显然是需要用到插槽slot的,做到用户传什么我们就抖什么,做到万物皆可抖。


这里使用vue3中的v-model指令会更方便,如下,当我们使用Shake组件时,triggertrue即开始抖动

<Shake v-model="trigger">
            抖动
        </Shake>

组件具体实现代码,同样的这次还是使用setup语法糖形式实现

<template>
    <div class="k-shake" :class="{['k-shakeactive']:props.modelValue}">
        <slot />
    </div>
</template>
<script lang="ts">
import { defineComponent } from 'vue'
import './style/index.less'
export default defineComponent({
    name: 'k-shake'
});
</script>
<script lang='ts' setup>
import { watch } from 'vue'
//v-model传来的值即为modelValue
type ShakeProps = {
    modelValue?: boolean
}
//发送update:modelValue来配合v-model语法糖
type Emits = {
    (e: 'update:modelValue', value: boolean): void
}
//获取props属性并且设置默认值
const props = withDefaults(defineProps<ShakeProps>(), {
    modelValue: false
})
const emits = defineEmits<Emits>()
//监听modelValue,为true的话,1s后置为false
watch(() => props.modelValue, (newVal) => {
    if (newVal) {
        setTimeout(() => {
            emits("update:modelValue", false)
        }, 1000);
    }
}, { immediate: true })
</script>

说明

这里接收参数props以及事件emits使用了以泛型的形式定义,不了解的可以看下这个传送门。watch加了立即监听为了防止用户上来就赋值为true导致下次不触发。


单元测试



新建shake.test.ts

import { describe, expect, it } from "vitest";
import { mount } from '@vue/test-utils'
import shake from '../shake.vue'
// The component to test
describe('test shake', () => {
    it("should render slot", () => {
        const wrapper = mount(shake, {
            slots: {
                default: 'Hello world'
            }
        })
        // Assert the rendered text of the component
        expect(wrapper.text()).toContain('Hello world')
    })
    it("should have class", () => {
        const wrapper = mount(shake, {
            props: {
                modelValue: true
            }
        })
        expect(wrapper.classes()).toContain('k-shakeactive')
    })
})

这个单元测试的意思其实就是

  1. slot传入Hello world,期望页面就会出现Hello world
  2. props传入modelValuetrue,那么组件就包含样式k-shakeactive

最后执行pnpm run coverage命令就会放下shake测试代码通过了

image.png


导出打包发布



这里和以往组件实现基本一样了,这里直接贴代码

  • shake/index.ts
import shake from './shake.vue'
import { withInstall } from '@kitty-ui/utils'
const Shake = withInstall(shake)
export default Shake
  • src/index.ts
export { default as Button } from './button'
export { default as Icon } from './icon'
export { default as Link } from './link'
export { default as Upload } from './upload'
export { default as Shake } from './shake'

最后执行

pnpm run build:kitty
pnpm run pnpm run build:kitty

即可完成发布


专栏



组件库的所有实现细节都在这个专栏里,包括环境搭建自动打包发布文档搭建vitest单元测试等等。欢迎大家点击关注Vite+TypeScript从零搭建Vue3组件库专栏一起讨论学习

如果这篇文章对你有所帮助动动指头点个赞👍吧~


开源地址



kitty-ui: Vite+Ts搭建的Vue3组件库


相关文章
|
2月前
|
JavaScript
Vue中如何实现兄弟组件之间的通信
在Vue中,兄弟组件可通过父组件中转、事件总线、Vuex/Pinia或provide/inject实现通信。小型项目推荐父组件中转或事件总线,大型项目建议使用Pinia等状态管理工具,确保数据流清晰可控,避免内存泄漏。
278 2
|
27天前
|
JavaScript 前端开发 安全
Vue 3
Vue 3以组合式API、Proxy响应式系统和全面TypeScript支持,重构前端开发范式。性能优化与生态协同并进,兼顾易用性与工程化,引领Web开发迈向高效、可维护的新纪元。(238字)
458 139
|
21天前
|
缓存 JavaScript 算法
Vue 3性能优化
Vue 3 通过 Proxy 和编译优化提升性能,但仍需遵循最佳实践。合理使用 v-if、key、computed,避免深度监听,利用懒加载与虚拟列表,结合打包优化,方可充分发挥其性能优势。(239字)
173 1
|
5月前
|
人工智能 JavaScript 算法
Vue 中 key 属性的深入解析:改变 key 导致组件销毁与重建
Vue 中 key 属性的深入解析:改变 key 导致组件销毁与重建
702 0
|
2月前
|
开发工具 iOS开发 MacOS
基于Vite7.1+Vue3+Pinia3+ArcoDesign网页版webos后台模板
最新版研发vite7+vue3.5+pinia3+arco-design仿macos/windows风格网页版OS系统Vite-Vue3-WebOS。
327 11
|
1月前
|
JavaScript 安全
vue3使用ts传参教程
Vue 3结合TypeScript实现组件传参,提升类型安全与开发效率。涵盖Props、Emits、v-model双向绑定及useAttrs透传属性,建议明确声明类型,保障代码质量。
214 0
|
3月前
|
缓存 前端开发 大数据
虚拟列表在Vue3中的具体应用场景有哪些?
虚拟列表在 Vue3 中通过仅渲染可视区域内容,显著提升大数据列表性能,适用于 ERP 表格、聊天界面、社交媒体、阅读器、日历及树形结构等场景,结合 `vue-virtual-scroller` 等工具可实现高效滚动与交互体验。
395 1
|
3月前
|
缓存 JavaScript UED
除了循环引用,Vue3还有哪些常见的性能优化技巧?
除了循环引用,Vue3还有哪些常见的性能优化技巧?
216 0
|
4月前
|
JavaScript
vue3循环引用自已实现
当渲染大量数据列表时,使用虚拟列表只渲染可视区域的内容,显著减少 DOM 节点数量。
127 0
|
23天前
|
缓存 JavaScript
vue中的keep-alive问题(2)
vue中的keep-alive问题(2)
247 137