perf: 增强ReTypeit组件,支持插槽以及所有typeit配置项 (#922)

* perf: 增强typeit组件

* fix: update

* fix: delete invalid code
This commit is contained in:
一万 2024-02-21 13:31:05 +08:00 committed by GitHub
parent f6eaa8d6d8
commit f762587fa7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 72 additions and 46 deletions

View File

@ -1,44 +1,8 @@
import { h, defineComponent } from "vue";
import TypeIt from "typeit";
import typeIt from "./src/index";
import type { TypeItOptions } from "typeit";
// 打字机效果组件(只是简单的封装下,更多配置项参考 https://www.typeitjs.com/docs/vanilla/usage#options
export default defineComponent({
name: "TypeIt",
props: {
/** 打字速度,以每一步之间的毫秒数为单位,默认`200` */
speed: {
type: Number,
default: 200
},
values: {
type: Array,
defalut: []
},
className: {
type: String,
default: "type-it"
},
cursor: {
type: Boolean,
default: true
}
},
render() {
return h(
"span",
{
class: this.className
},
{
default: () => []
}
);
},
mounted() {
new TypeIt(`.${this.className}`, {
strings: this.values,
speed: this.speed,
cursor: this.cursor
}).go();
}
});
const TypeIt = typeIt;
export { TypeIt, TypeItOptions };
export default TypeIt;

View File

@ -0,0 +1,56 @@
import type { El } from "typeit/dist/types";
import TypeIt, { type TypeItOptions } from "typeit";
import { ref, defineComponent, onMounted, type PropType } from "vue";
// 打字机效果组件(配置项详情请查阅 https://www.typeitjs.com/docs/vanilla/usage#options
export default defineComponent({
name: "TypeIt",
props: {
options: {
type: Object as PropType<TypeItOptions>,
default: () => ({}) as TypeItOptions
}
},
setup(props, { slots, expose }) {
/**
*
* @param message
*/
function throwError(message: string) {
throw new TypeError(message);
}
/**
*
*/
function getBrowserLanguage() {
return navigator.language;
}
const typedItRef = ref<Element | null>(null);
onMounted(() => {
const $typed = typedItRef.value!.querySelector(".type-it") as El;
if (!$typed) {
const errorMsg =
getBrowserLanguage() === "zh-CN"
? "请确保有且只有一个具有class属性为 'type-it' 的元素"
: "Please make sure that there is only one element with a Class attribute with 'type-it'";
throwError(errorMsg);
}
const typeIt = new TypeIt($typed, props.options).go();
expose({
typeIt
});
});
return () => (
<div ref={typedItRef}>
{slots.default?.() ?? <span class="type-it"></span>}
</div>
);
}
});

View File

@ -1,9 +1,13 @@
<script setup lang="ts">
import TypeIt from "@/components/ReTypeit";
import { TypeIt, type TypeItOptions } from "@/components/ReTypeit";
defineOptions({
name: "Typeit"
});
const options: TypeItOptions = {
strings: ["test1", "test2", "test3"]
};
</script>
<template>
@ -13,6 +17,6 @@ defineOptions({
<span class="font-medium"> 打字机组件 </span>
</div>
</template>
<TypeIt :values="['test1', 'test2', 'test3']" />
<TypeIt :options="options" />
</el-card>
</template>

View File

@ -166,7 +166,9 @@ watch(loginDay, value => {
<avatar class="avatar" />
<Motion>
<h2 class="outline-none">
<TypeIt :values="[title]" :cursor="false" :speed="150" />
<TypeIt
:options="{ strings: [title], cursor: false, speed: 100 }"
/>
</h2>
</Motion>