VueUserefAutoReset
A ref which will be reset to the default value after some time.
Demo
Default message
Usage
ts
import { refAutoReset } from '@vueuse/core'
const message = refAutoReset('default message', 1000)
const setMessage = () => {
// here the value will change to 'message has set' but after 1000ms, it will change to 'default message'
message.value = 'message has set'
}
import { refAutoReset } from '@vueuse/core'
const message = refAutoReset('default message', 1000)
const setMessage = () => {
// here the value will change to 'message has set' but after 1000ms, it will change to 'default message'
message.value = 'message has set'
}
Type Declarations
typescript
/**
* Create a ref which will be reset to the default value after some time.
*
* @see https://vueuse.org/refAutoReset
* @param defaultValue The value which will be set.
* @param afterMs A zero-or-greater delay in milliseconds.
*/
export declare function refAutoReset<T>(
defaultValue: T,
afterMs?: MaybeComputedRef<number>
): Ref<T>
export { refAutoReset as autoResetRef }
/**
* Create a ref which will be reset to the default value after some time.
*
* @see https://vueuse.org/refAutoReset
* @param defaultValue The value which will be set.
* @param afterMs A zero-or-greater delay in milliseconds.
*/
export declare function refAutoReset<T>(
defaultValue: T,
afterMs?: MaybeComputedRef<number>
): Ref<T>
export { refAutoReset as autoResetRef }
Source
Contributors
Anthony Fu
sun0day
wheat
Kasper Seweryn