useStateManualReset

Category

Reactivity

Export Size

686 B

Last Changed

5 days ago

A state with manual reset functionality.

Demo

Usage

import { useStateManualReset } from '@reause/shared'

const [message, setMessage, resetMessage] = useStateManualReset('default message')

setMessage('message has set')

resetMessage()

console.log(message) // 'default message'

Type Declarations

export type UseStateManualResetReturn<T> = [
    value: T,
    setValue: Dispatch<SetStateAction<T>>,
    reset: () => void
]

export type State<T> = StateValue<T>

export function useStateManualReset<T>(value: State<T>): UseStateManualResetReturn<T>

export function useControllableState<T>(state: State<T>, options?: UseControllableStateOptions<T>): StateTuple<T>

Source

Source · Demo · VueUse

Contributors

Changelog

v0.1.0 on

159b8 - fix(shared): resolve useStateManualReset audit findings (#745)

f6d3d - feat(shared): add useStateManualReset (#52)