Vue3基於countUp.js怎麼實現數字滾動的插件
- WBOY轉載
- 2023-05-10 22:19:041962瀏覽
countUp 簡介
CountUp.js 是一種無依賴項的輕量級 JavaScript 類，可用於快速建立以更有趣的方式顯示數位資料的動畫。 CountUp 可以在兩個方向上進行計數，具體取決於傳遞的開始和結束值。
雖然現在市面上基於countUp.js 二次封裝的Vue元件不在少數， 但我個人是不太喜歡使用這些第三方封裝的，因為第三方元件的更新頻率很難保證，也許作者只是一時興起封裝上傳了， 並未打算繼續維護，如果使用了等於後續根本沒有維護性了， 所以這種二次封裝我推薦自行實現， 我們可以透過本次封裝熟悉一下vue3 , ts 的語法
countUp 元件封裝
首先進行安裝
npm i countup.js
安裝好之後新建檔案CountUp.vue ， template部分很簡單， 只需要一個span標籤， 同時給span一個ref='countupRef' 就完成了，首先引入countup.js ， 按住Ctrl滑鼠左鍵點擊Countup.js可以看到d.ts文件，countUp.d.ts 如下
export interface CountUpOptions {
startVal?: number;
decimalPlaces?: number;
duration?: number;
useGrouping?: boolean;
useIndianSeparators?: boolean;
useEasing?: boolean;
smartEasingThreshold?: number;
smartEasingAmount?: number;
separator?: string;
decimal?: string;
easingFn?: (t: number, b: number, c: number, d: number) => number;
formattingFn?: (n: number) => string;
prefix?: string;
suffix?: string;
numerals?: string[];
enableScrollSpy?: boolean;
scrollSpyDelay?: number;
scrollSpyOnce?: boolean;
onCompleteCallback?: () => any;
plugin?: CountUpPlugin;
}
export declare interface CountUpPlugin {
render(elem: HTMLElement, formatted: string): void;
}
export declare class CountUp {
private endVal;
options?: CountUpOptions;
version: string;
private defaults;
private rAF;
private startTime;
private remaining;
private finalEndVal;
private useEasing;
private countDown;
el: HTMLElement | HTMLInputElement;
formattingFn: (num: number) => string;
easingFn?: (t: number, b: number, c: number, d: number) => number;
error: string;
startVal: number;
duration: number;
paused: boolean;
frameVal: number;
once: boolean;
constructor(target: string | HTMLElement | HTMLInputElement, endVal: number, options?: CountUpOptions);
handleScroll(self: CountUp): void;
/**
* Smart easing works by breaking the animation into 2 parts, the second part being the
* smartEasingAmount and first part being the total amount minus the smartEasingAmount. It works
* by disabling easing for the first part and enabling it on the second part. It is used if
* usingEasing is true and the total animation amount exceeds the smartEasingThreshold.
*/
private determineDirectionAndSmartEasing;
start(callback?: (args?: any) => any): void;
pauseResume(): void;
reset(): void;
update(newEndVal: string | number): void;
count: (timestamp: number) => void;
printValue(val: number): void;
ensureNumber(n: any): boolean;
validateValue(value: string | number): number;
private resetDuration;
formatNumber: (num: number) => string;
easeOutExpo: (t: number, b: number, c: number, d: number) => number;
}這裡export 了一個CountUp 類別還有一個CountUpOptions 的interface， CountUp 類別的constructor 接收三個參數， 分別是dom節點， endVal， 以及options， 我們將這三個參數當成是props 傳入同時給定預設值， , 首先取得span的ref作為countUp初始化的容器, 定義一個變數numAnim 接收new CountUp(countupRef.value, props.end, props.options) 的回傳值， , 在onMounted中初始化countUp.js,接著我們就可以去頁面引入CountUp.vue 看看效果，因為有預設值，所以我們不需要傳入任何參數， 直接看就好了， 此時CountUp.vue元件程式碼如下，
<script setup lang="ts">
import { CountUp } from 'countup.js'
import type { CountUpOptions } from 'countup.js'
import { onMounted, ref } from 'vue'
let numAnim = ref(null) as any
const countupRef = ref()
const props = defineProps({
end: {
type: Number,
default: 2023
},
options: {
type: Object,
default() {
let options: CountUpOptions = {
startVal: 0, // 开始的数字 一般设置0开始
decimalPlaces: 2, // number类型 小数位，整数自动添.00
duration: 2, // number类型 动画延迟秒数，默认值是2
useGrouping: true, // boolean类型 是否开启逗号，默认true(1,000)false(1000)
useEasing: true, // booleanl类型 动画缓动效果(ease),默认true
smartEasingThreshold: 500, // numberl类型 大于这个数值的值开启平滑缓动
smartEasingAmount: 300, // numberl类型
separator: ',',// string 类型 分割用的符号
decimal: '.', // string 类型 小数分割符合
prefix: '￥', // sttring 类型 数字开头添加固定字符
suffix: '元', // sttring类型 数字末尾添加固定字符
numerals: [] // Array类型 替换从0到9对应的字，也就是自定数字字符了,数组存储
}
return options
}
}
})
onMounted(() => {
initCount()
})
const initCount = () => {
numAnim = new CountUp(countupRef.value, props.end, props.options)
numAnim.start()
}
</script>
<template>
<span ref="countupRef"></span>
</template>這時我們發現，在onMounted 執行之後， 如果我們的endVal值發生了改動， 由於CountUp.vue的onMounted已經完成，並不會同步修改， 如果我們的值是非同步取得的，會造成渲染不出我們想要的結果，那麼我們就需要在元件中把這個initCount 方法給暴露給父元件使用，在vue3中，我們只需要使用defineExpose 暴露即可， 同時我們也進一步完善一下我們的props， 校驗限制一下傳入的optinos值， 盡量避免使用上的錯誤， 同時修改預設值，避免造成一些問題，最終的程式碼如下
<script setup lang="ts">
import { CountUp } from 'countup.js'
import type { CountUpOptions } from 'countup.js'
import { onMounted, ref } from 'vue'
let numAnim = ref(null) as any
const countupRef = ref()
const props = defineProps({
end: {
type: Number,
default: 0
},
options: {
type: Object,
validator(option: Object) {
let keys = ['startVal', 'decimalPlaces', 'duration', 'useGrouping', 'useEasing', 'smartEasingThreshold', 'smartEasingAmount', 'separator', 'decimal', 'prefix', 'suffix', 'numerals']
for (const key in option) {
if (!keys.includes(key)) {
console.error(" CountUp 传入的 options 值不符合 CountUpOptions")
return false
}
}
return true
},
default() {
let options: CountUpOptions = {
startVal: 0, // 开始的数字 一般设置0开始
decimalPlaces: 2, // number类型 小数位，整数自动添.00
duration: 2, // number类型 动画延迟秒数，默认值是2
useGrouping: true, // boolean类型 是否开启逗号，默认true(1,000)false(1000)
useEasing: true, // booleanl类型 动画缓动效果(ease),默认true
smartEasingThreshold: 500, // numberl类型 大于这个数值的值开启平滑缓动
smartEasingAmount: 300, // numberl类型
separator: ',',// string 类型 分割用的符号
decimal: '.', // string 类型 小数分割符合
prefix: '', // sttring 类型 数字开头添加固定字符
suffix: '', // sttring类型 数字末尾添加固定字符
numerals: [] // Array类型 替换从0到9对应的字，也就是自定数字字符了,数组存储
}
return options
}
}
})
onMounted(() => {
initCount()
})
const initCount = () => {
numAnim = new CountUp(countupRef.value, props.end, props.options)
numAnim.start()
}
defineExpose({
initCount
})
</script>
<template>
<span ref="countupRef"></span>
</template>
<style scoped lang='scss'></style>以上是Vue3基於countUp.js怎麼實現數字滾動的插件的詳細內容。更多資訊請關注PHP中文網其他相關文章！
陳述：
本文轉載於：yisu.com。如有侵權，請聯絡admin@php.cn刪除