RollingText 翻滚文本

介绍

文本翻滚动效，可以翻滚数字和其他类型文本。

引入

通过以下方式来引入组件。

import { createApp } from 'vue';
import { RollingText } from '@szhn/dh-design-mobile';

const app = createApp();
app.use(RollingText);

代码演示

基础用法

你可以通过 start-num 设置起始数值，target-num 设置目标数值。RollingText 组件会自动开始动画，从起始数值翻滚到目标数值。

<van-rolling-text :start-num="0" :target-num="123" />

设置翻滚方向

你可以通过 direction 属性设置数字的翻滚方向，默认为向下翻滚，设置为 up 即可向上翻滚。

<van-rolling-text :start-num="0" :target-num="432" direction="up" />

设置各数位停止顺序

你可以通过 stop-order 属性设置动画各个数位的停止先后顺序。默认先停止高位，设置为 rtl 可以先从个位停止。

<van-rolling-text :start-num="0" :target-num="54321" stop-order="rtl" />

翻转非数字内容

你可以使用 text-list 属性设置非数字内容的翻转。组件会从数组的第一项翻转到最后一项，请确保数组长度大于等于 2，以及每一项的长度一致。

<van-rolling-text :text-list="textList" :duration="1" />

import { ref } from 'vue';

export default {
  setup() {
    const textList = ref([
      'aaaaa',
      'bbbbb',
      'ccccc',
      'ddddd',
      'eeeee',
      'fffff',
      'ggggg',
    ]);
    return { textList };
  },
};

自定义样式

RollingText 组件提供了一些 CSS 变量，你可以覆盖这些变量来自定义样式，也可以直接修改组件的样式。此外，你还可以通过 height 属性设置数字高度。

<van-rolling-text
  class="my-rolling-text"
  :height="54"
  :start-num="12345"
  :target-num="54321"
/>

.my-rolling-text {
  --van-rolling-text-background: #1989fa;
  --van-rolling-text-color: white;
  --van-rolling-text-font-size: 24px;
  --van-rolling-text-gap: 6px;
  --van-rolling-text-item-border-radius: 5px;
  --van-rolling-text-item-width: 40px;
}

手动控制

通过 ref 获取到组件实例后，你可以调用 start、reset 方法，start 方法用于开始动画，reset 方法用于重置动画。

<van-rolling-text
  ref="rollingTextRef"
  :start-num="0"
  :target-num="54321"
  :auto-start="false"
/>
<van-grid clickable :column-num="3">
  <van-grid-item icon="play-circle-o" :text="start" @click="start" />
  <van-grid-item icon="replay" :text="reset" @click="reset" />
</van-grid>

import { ref } from 'vue';

export default {
  setup() {
    const rollingTextRef = ref(null);
    const start = () => {
      rollingTextRef.value.start();
    };
    const reset = () => {
      rollingTextRef.value.reset();
    };
    return { rollingTextRef, start, reset };
  },
};

API

Props

参数	说明	类型	默认值
start-num	起始数值	number	0
target-num	目标数值	number	-
text-list	内容数组，用于翻转非数字内容	string[]	[]
duration	动画时长，单位为秒	number	2
direction	文本翻滚方向，值为 down 和 up	string	down
auto-start	是否自动开始动画	boolean	true
stop-order	各个数位动画停止先后顺序，值为 ltr 和 rtl	string	ltr
height	数字高度，单位为 px	number	40

方法

通过 ref 可以获取到 RollingText 实例并调用实例方法。

方法名	说明	参数	返回值
start	开始动画	-	-
reset	重置动画	-	-

类型定义

组件导出以下类型定义：

import type {
  RollingTextProps,
  RollingTextInstance,
  RollingTextDirection,
  RollingTextStopOrder,
} from '@szhn/dh-design-mobile';

主题定制

样式变量

组件提供了下列 CSS 变量，可用于自定义样式，使用方法请参考 ConfigProvider 组件。

名称	默认值	描述
--van-rolling-text-background	inherit	单个数位背景色
--van-rolling-text-color	var(--van-text-color)	数字颜色
--van-rolling-text-font-size	var(--van-font-size-md)	字体大小
--van-rolling-text-gap	0px	数位之间的间隔
--van-rolling-text-item-width	15px	单个数位宽度
--van-rolling-text-item-border-radius	0px	单个数位边框圆角