throttle 节流
17:43说明
$u.throttle 接收回调和间隔时间,返回一个节流函数:wait 窗口内只允许执行一次。立即模式在窗口起点执行,延迟模式在窗口结束时执行。
示例
普通点击(无节流)
对照组:每次点击都计数,没有间隔限制。
查看源码
vue
<template>
<ux-cell-group :border="false">
<ux-cell-item title="点击次数" :value="clickCount" :arrow="false" :border-bottom="false" />
</ux-cell-group>
<ux-gap :height="8" />
<ux-button size="small" type="primary" block text="普通点击" @click="onClick()" />
</template>
<script setup lang="ts">
const clickCount = ref(0);
function onClick(): void {
clickCount.value++;
}
</script>节流点击(立即执行)
immediate 为 true,窗口起点先执行一次,1000ms 内的后续点击被忽略。
查看源码
vue
<template>
<ux-cell-group :border="false">
<ux-cell-item title="触发次数" :value="clickCount" :arrow="false" />
<ux-cell-item title="实际执行次数" :value="executeCount" :arrow="false" />
<ux-cell-item title="最近执行时间" :value="lastExecuteTime.length > 0 ? lastExecuteTime : '-'" :arrow="false" :border-bottom="false" />
</ux-cell-group>
<ux-gap :height="8" />
<ux-button size="small" type="primary" block text="节流点击(1000ms)" @click="onClick()" />
</template>
<script setup lang="ts">
import { $u } from '@/uni_modules/uview-pro-x';
const clickCount = ref(0);
const executeCount = ref(0);
const lastExecuteTime = ref('');
// 节流函数只创建一次,跨点击复用;immediate 为 true 表示窗口起点先执行
const throttledFn = $u.throttle((): void => {
executeCount.value++;
lastExecuteTime.value = new Date().toLocaleTimeString();
}, 1000, true);
function onClick(): void {
clickCount.value++;
throttledFn();
}
</script>节流点击(延迟执行)
immediate 为 false,窗口结束时执行一次,且只取窗口内第一次触发。
查看源码
vue
<template>
<ux-cell-group :border="false">
<ux-cell-item title="实际执行次数" :value="executeCount" :arrow="false" :border-bottom="false" />
</ux-cell-group>
<ux-gap :height="8" />
<ux-button size="small" type="primary" block text="延迟执行(1000ms)" @click="onClick()" />
</template>
<script setup lang="ts">
import { $u } from '@/uni_modules/uview-pro-x';
const executeCount = ref(0);
// immediate 为 false:窗口结束时执行一次
const delayFn = $u.throttle((): void => {
executeCount.value++;
}, 1000, false);
function onClick(): void {
delayFn();
}
</script>API
参数
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| func | 要执行的回调 | () => void | - | - |
| wait | 节流间隔(ms) | number | 500 | - |
| immediate | 是否在窗口起点执行 | boolean | true | - |
返回值
| 类型 | 说明 |
|---|---|
() => void | 节流后的函数,不接收参数也没有返回值 |
注意事项
immediate为true时窗口起点立即执行一次,wait内的后续调用被忽略,窗口结束后才恢复。immediate为false时窗口结束时才执行,且只取窗口内第一次触发的回调,后续触发不排队。- 返回的函数需要保存引用复用;每次调用
$u.throttle都会创建独立的节流状态。 - 返回的函数没有取消方法,离开页面后计时器仍会按原计划触发回调。