Vue3基于countUp.js實現(xiàn)數(shù)字滾動的插件
countUp 簡介
CountUp.js 是一種無依賴項的輕量級 JavaScript 類，可用于快速創(chuàng)建以更有趣的方式顯示數(shù)字?jǐn)?shù)據(jù)的動畫。CountUp 可以在兩個方向上進行計數(shù)，具體取決于傳遞的開始和結(jié)束值。
雖然現(xiàn)在市面上基于 countUp.js 二次封裝的Vue組件不在少數(shù)， 但我個人是不太喜歡使用這些第三方封裝的，因為第三方組件的更新頻率很難保證，也許作者只是一時興起封裝上傳了， 并未打算繼續(xù)維護，如果使用了 等于后續(xù)根本沒有維護性了， 所以這種二次封裝我推薦自行實現(xiàn)， 我們可以通過本次封裝熟悉一下 vue3, ts 的語法
countUp 組件封裝
首先進行安裝
npm i countup.js
安裝好之后新建文件 CountUp.vue ， template部分很簡單， 只需要一個span標(biāo)簽， 同時給span一個 ref='countupRef' 就完成了，首先引入 countup.js， 按住Ctrl鼠標(biāo)左鍵點擊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 接收三個參數(shù)， 分別是 dom節(jié)點， endVal， 以及 options， 我們將這三個參數(shù)當(dāng)成是 props 傳入同時給定默認(rèn)值， , 首先獲取span的ref作為 countUp初始化的容器 , 定義一個變量 numAnim 接收 new CountUp(countupRef.value, props.end, props.options) 的返回值， , 在 onMounted中初始化countUp.js,接著我們就可以去頁面引入 CountUp.vue 看看效果，因為有默認(rèn)值，所以我們不需要傳入任何參數(shù)， 直接看就好了， 此時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, // 開始的數(shù)字 一般設(shè)置0開始
decimalPlaces: 2, // number類型 小數(shù)位，整數(shù)自動添.00
duration: 2, // number類型 動畫延遲秒數(shù)，默認(rèn)值是2
useGrouping: true, // boolean類型 是否開啟逗號，默認(rèn)true(1,000)false(1000)
useEasing: true, // booleanl類型 動畫緩動效果(ease),默認(rèn)true
smartEasingThreshold: 500, // numberl類型 大于這個數(shù)值的值開啟平滑緩動
smartEasingAmount: 300, // numberl類型
separator: ',',// string 類型 分割用的符號
decimal: '.', // string 類型 小數(shù)分割符合
prefix: '￥', // sttring 類型 數(shù)字開頭添加固定字符
suffix: '元', // sttring類型 數(shù)字末尾添加固定字符
numerals: [] // Array類型 替換從0到9對應(yīng)的字，也就是自定數(shù)字字符了,數(shù)組存儲
}
return options
}
}
})
onMounted(() => {
initCount()
})
const initCount = () => {
numAnim = new CountUp(countupRef.value, props.end, props.options)
numAnim.start()
}
</script>
<template>
<span ref="countupRef"></span>
</template>
這時我們發(fā)現(xiàn)，在 onMounted 執(zhí)行之后， 如果我們的endVal值發(fā)生了改動， 由于 CountUp.vue的 onMounted 已經(jīng)完成，并不會同步修改， 如果我們的值是異步獲取的，會造成渲染不出我們想要的結(jié)果，那么我們就需要在組件中把這個 initCount 方法給暴露給父組件使用，在vue3中，我們只需要使用 defineExpose 暴露即可， 同時我們也進一步完善一下我們的props， 校驗限制一下傳入的optinos值， 盡量避免使用上的錯誤， 同時修改一下默認(rèn)值，避免造成一些問題，最終的代碼如下
<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, // 開始的數(shù)字 一般設(shè)置0開始
decimalPlaces: 2, // number類型 小數(shù)位，整數(shù)自動添.00
duration: 2, // number類型 動畫延遲秒數(shù)，默認(rèn)值是2
useGrouping: true, // boolean類型 是否開啟逗號，默認(rèn)true(1,000)false(1000)
useEasing: true, // booleanl類型 動畫緩動效果(ease),默認(rèn)true
smartEasingThreshold: 500, // numberl類型 大于這個數(shù)值的值開啟平滑緩動
smartEasingAmount: 300, // numberl類型
separator: ',',// string 類型 分割用的符號
decimal: '.', // string 類型 小數(shù)分割符合
prefix: '', // sttring 類型 數(shù)字開頭添加固定字符
suffix: '', // sttring類型 數(shù)字末尾添加固定字符
numerals: [] // Array類型 替換從0到9對應(yīng)的字，也就是自定數(shù)字字符了,數(shù)組存儲
}
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>
文末
至此，CountUp 的組件開發(fā)已經(jīng)完成了，后續(xù)我們也可以根據(jù)自己的項目需求自行去調(diào)整組件。 這里是拿了一個很簡單的 countUp 組件舉了一個簡單例子，有的時候自己動手豐衣足食，很多插件的封裝比想象中簡單的多。
到此這篇關(guān)于Vue3基于countUp.js實現(xiàn)數(shù)字滾動的插件的文章就介紹到這了,更多相關(guān)Vue3 countUp.js數(shù)字滾動內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
BootStrap 下拉菜單點擊之后不會出現(xiàn)下拉菜單(下拉菜單不彈出)的解決方案
最近學(xué)到Bootstrap下拉菜單，學(xué)懂了教程內(nèi)容之后自己敲一個點擊按鈕底下彈出下拉菜單的小demo，寫完代碼發(fā)現(xiàn)運行之后點擊按鈕沒反應(yīng)，下拉菜單彈不出來，下面給大家分享下解決方案2016-12-12
這篇文章主要介紹了如何使用JavaScript檢測空閑的瀏覽器選項卡，本文通過實例代碼給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下2020-05-05
原生JS實現(xiàn)動態(tài)添加新元素、刪除元素方法
這篇文章主要介紹了原生js實現(xiàn)動態(tài)添加新元素、刪除元素方法 ,本文通過實例代碼給大家介紹的非常詳細(xì)，具有一定的參考借鑒價值，需要的朋友可以參考下2019-05-05
完美實現(xiàn)js拖拽效果 return false用法詳解
這篇文章主要為大家詳細(xì)介紹了完美實現(xiàn)js拖拽效果的代碼，一起學(xué)習(xí)return false的用法，具有一定的參考價值，感興趣的小伙伴們可以參考一下2017-07-07
淺析JavaScript中兩種類型的全局對象/函數(shù)
這篇文章主要介紹了JavaScript中兩種類型的全局對象/函數(shù)。需要的朋友可以過來參考下，希望對大家有所幫助2013-12-12
onkeydown事件解決按回車鍵直接提交數(shù)據(jù)的需求
登陸頁面需要撲捉用戶按下回車自動提交的需求，于是相到在body里添加onkeydown事件跳javascript在提交表單，具體看下實現(xiàn)代碼，希望對你有所幫助2013-04-04
原生JS實現(xiàn)圖片輪播 JS實現(xiàn)小廣告插件
這篇文章主要為大家詳細(xì)介紹了原生JS實現(xiàn)圖片輪播、小廣告插件，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價值，感興趣的小伙伴們可以參考一下2021-09-09
JavaScript中使用replace結(jié)合正則實現(xiàn)replaceAll的效果
JavaScript?中使用?replace?達(dá)到?replaceAll的效果，其實就用利用的正則的全局替換。2010-06-06
JavaScript常用正則驗證函數(shù)實例小結(jié)【年齡,數(shù)字,Email,手機,URL,日期等】
這篇文章主要介紹了JavaScript常用正則驗證函數(shù),結(jié)合實例形式總結(jié)分析了javascript針對年齡、數(shù)字、Email、手機、URL、日期等格式常用正則驗證技巧,需要的朋友可以參考下2017-01-01
js中回調(diào)函數(shù)的學(xué)習(xí)筆記
這篇文章主要介紹了js中回調(diào)函數(shù)的相關(guān)知識,需要的朋友可以參考下2014-07-07