Comment implémenter un plug-in de défilement numérique dans Vue3 basé sur countUp.js

Introduction à countUp

CountUp.js est une classe JavaScript légère et sans dépendance qui peut être utilisée pour créer rapidement des animations qui affichent des données numériques de manière plus intéressante. CountUp peut compter dans les deux sens, en fonction des valeurs de début et de fin transmises.

Bien qu'il existe actuellement sur le marché de nombreux composants Vue basés sur l'encapsulation secondaire countUp.js, personnellement, je n'aime pas utiliser ces encapsulations tierces car il est difficile de garantir la fréquence de mise à jour des composants tiers. L'auteur les encapsule simplement sur un coup de tête. Il a été téléchargé et il n'y a aucune intention de continuer à le maintenir. S'il est utilisé, cela signifie qu'il ne sera plus du tout maintenable à l'avenir, je recommande donc d'implémenter cette encapsulation secondaire. par nous-mêmes. Nous pouvons nous familiariser avec la syntaxe vue3, tsvue3, 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 &#39;countup.js&#39;
  import type { CountUpOptions } from &#39;countup.js&#39;
  import { onMounted, ref } from &#39;vue&#39;

  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: &#39;,&#39;,// string 类型 分割用的符号
          decimal: &#39;.&#39;, // string 类型  小数分割符合
          prefix: &#39;￥&#39;, // sttring 类型  数字开头添加固定字符
          suffix: &#39;元&#39;, // 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

package de composants countUp🎜🎜Première installation🎜

<script setup lang="ts">
  import { CountUp } from &#39;countup.js&#39;
  import type { CountUpOptions } from &#39;countup.js&#39;
  import { onMounted, ref } from &#39;vue&#39;

  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 = [&#39;startVal&#39;, &#39;decimalPlaces&#39;, &#39;duration&#39;, &#39;useGrouping&#39;, &#39;useEasing&#39;, &#39;smartEasingThreshold&#39;, &#39;smartEasingAmount&#39;, &#39;separator&#39;, &#39;decimal&#39;, &#39;prefix&#39;, &#39;suffix&#39;, &#39;numerals&#39;]
        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: &#39;,&#39;,// string 类型 分割用的符号
          decimal: &#39;.&#39;, // string 类型  小数分割符合
          prefix: &#39;&#39;, // sttring 类型  数字开头添加固定字符
          suffix: &#39;&#39;, // 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=&#39;scss&#39;></style>

🎜Après l'installation, créez un nouveau fichier CountUp. vue. La partie modèle est très simple, une seule balise span, et donnez à <code>span un ref='countupRef' pour compléter. . Commencez par introduire countup.js, maintenez le bouton gauche de la souris enfoncé. Cliquez sur Countup.js pour voir le fichier d.ts, countUp.d.ts comme suit 🎜rrreee🎜. Ici exporté une classe CountUp et une interface CountUpOptions, le <code>constructeur de la classe CountUp reçoit trois paramètres, à savoir le nœud dom, endVal et options. Nous considérons ces trois paramètres comme des props transmis et une valeur par défaut est donnée. Tout d'abord, récupérez la référence de span comme conteneur pour l'initialisation de countUp. définir une variable numAnim et recevoir new CountUp (la valeur de retour de countupRef.value, props.end, props.options), initialiser countUp.js dans onMounted, et ensuite nous pouvons l'importer sur la page CountUp.vue Jetez un oeil à l'effet Parce qu'il y a une valeur par défaut, nous n'avons pas besoin de le faire. passez n'importe quel paramètre. Regardez-le. À ce moment, le code du composant CountUp.vue est le suivant : 🎜rrreee🎜À ce moment, nous avons constaté qu'après onMounted est. exécuté, si notre valeur endVal change, parce que le onMounted de CountUp.vue a été terminé, il ne sera pas modifié de manière synchrone. Si notre valeur est obtenue de manière asynchrone, le résultat sera obtenu. Want ne sera pas rendu, nous devons donc exposer cette méthode initCount au parent dans le composant. Utilisation du composant, dans vue3, nous n'avons besoin que d'utiliser defineExpose pour l'exposer. Dans le même temps, nous améliorons également nos accessoires et vérifions et limitons la valeur optinos entrante. Essayez d'éviter les erreurs d'utilisation et modifiez les valeurs par défaut pour éviter de causer des problèmes. comme suit 🎜rrreee

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!