从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组件库


相关文章
|
22天前
|
缓存 JavaScript UED
Vue3中v-model在处理自定义组件双向数据绑定时有哪些注意事项?
在使用`v-model`处理自定义组件双向数据绑定时,要仔细考虑各种因素,确保数据的准确传递和更新,同时提供良好的用户体验和代码可维护性。通过合理的设计和注意事项的遵循,能够更好地发挥`v-model`的优势,实现高效的双向数据绑定效果。
126 64
|
22天前
|
前端开发 JavaScript 测试技术
Vue3中v-model在处理自定义组件双向数据绑定时,如何避免循环引用?
Web 组件化是一种有效的开发方法,可以提高项目的质量、效率和可维护性。在实际项目中,要结合项目的具体情况,合理应用 Web 组件化的理念和技术,实现项目的成功实施和交付。通过不断地探索和实践,将 Web 组件化的优势充分发挥出来,为前端开发领域的发展做出贡献。
28 8
|
22天前
|
存储 JavaScript 数据管理
除了provide/inject,Vue3中还有哪些方式可以避免v-model的循环引用?
需要注意的是,在实际开发中,应根据具体的项目需求和组件结构来选择合适的方式来避免`v-model`的循环引用。同时,要综合考虑代码的可读性、可维护性和性能等因素,以确保系统的稳定和高效运行。
21 1
|
22天前
|
JavaScript
Vue3中使用provide/inject来避免v-model的循环引用
`provide`和`inject`是 Vue 3 中非常有用的特性,在处理一些复杂的组件间通信问题时,可以提供一种灵活的解决方案。通过合理使用它们,可以帮助我们更好地避免`v-model`的循环引用问题,提高代码的质量和可维护性。
32 1
|
22天前
|
JavaScript
在 Vue 3 中,如何使用 v-model 来处理自定义组件的双向数据绑定?
需要注意的是,在实际开发中,根据具体的业务需求和组件设计,可能需要对上述步骤进行适当的调整和优化,以确保双向数据绑定的正确性和稳定性。同时,深入理解 Vue 3 的响应式机制和组件通信原理,将有助于更好地运用 `v-model` 实现自定义组件的双向数据绑定。
|
JavaScript
Vue的非父子组件之间传值
全局事件总线 一种组件间通信的方式,适用于任意组件间通信
|
缓存 JavaScript 前端开发
Vue Props、Slot、v-once、非父子组件间的传值....
Vue Props、Slot、v-once、非父子组件间的传值....
86 0
|
JavaScript
Vue中父子组件传值
先在⽗组件中给⼦组件的⾃定义属性绑定⼀个⽗组件的变量
|
JavaScript
vue 组件传值
vue 组件传值
84 0
|
JavaScript
vue父子组件传值
vue父子组件传值
下一篇
DataWorks