Skip to content

refDebounced

Category
Last Changed
6 months ago
Alias
useDebouncedebouncedRef
Related

Debounce execution of a ref value.

具有防抖功能的 ref。

Demo

Delay is set to 1000ms for this demo.

Debounced:

Times Updated: 0

Usage 使用




 



















import { refDebounced } from '@vueuse/core'

const input = ref('foo')
const debounced = refDebounced(input, 1000)

input.value = 'bar'
console.log(debounced.value) // 'foo'

await sleep(1100)

console.log(debounced.value) // 'bar'
import { refDebounced } from '@vueuse/core'

const input = ref('foo')
const debounced = refDebounced(input, 1000)

input.value = 'bar'
console.log(debounced.value) // 'foo'

await sleep(1100)

console.log(debounced.value) // 'bar'

You can also pass an optional 3rd parameter including maxWait option. See useDebounceFnfor details.

还可以传递包括 maxWati 选项在内的第三个可选在参数。详见 useDebounceFn

Type Declarations

/**
 * Debounce updates of a ref.
 *
 * @return A new debounced ref.
 */
export declare function refDebounced<T>(
  value: Ref<T>,
  ms?: number,
  options?: DebounceFilterOptions
): Readonly<Ref<T>>
export { refDebounced as useDebounce, refDebounced as debouncedRef }
/**
 * Debounce updates of a ref.
 *
 * @return A new debounced ref.
 */
export declare function refDebounced<T>(
  value: Ref<T>,
  ms?: number,
  options?: DebounceFilterOptions
): Readonly<Ref<T>>
export { refDebounced as useDebounce, refDebounced as debouncedRef }

Source

SourceDemoDocs

Contributors

Anthony Fu
lzdFeiFei

Changelog

No recent changes

Released under the MIT License.