Use History State

Open-code aq-ui React hook for Use History State.

Installation

pnpm dlx aq-ui@alpha add use-history-state

API reference

Client module

Import the parts you need, then jump to an export for its contract.

View full source

Quick start

"use client"

import { useHistoryState } from "@/hooks/use-history-state"

HistoryStateControls

interfaceSource L11

Type contract for HistoryStateControls.

interface HistoryStateControls<T>

Members

Name	Type
`back`	`() => void`
`forward`	`() => void`
`reset`	`(value?: T) => void`
`canUndo`	`boolean`
`canRedo`	`boolean`

HistoryStateUpdater

typeSource L5

Type contract for HistoryStateUpdater.

type HistoryStateUpdater<T> = T | ((current: T) => T)

useHistoryState

functionSource L24

Open-code aq-ui React hook for Use History State.

function useHistoryState<T>(initialValue: T | (() => T), { capacity = 100 }: UseHistoryStateOptions = {}): [T, (value: HistoryStateUpdater<T>) => void, HistoryStateControls<T>]

Returns: [T, (value: HistoryStateUpdater<T>) => void, HistoryStateControls<T>]

Parameters

Name	Type	Default
`initialValue`	`T \| (() => T)`	`—`
`options?`	`UseHistoryStateOptions`	`{}`

UseHistoryStateOptions

interfaceSource L7

Type contract for UseHistoryStateOptions.

interface UseHistoryStateOptions

Members

Name	Type	Default
`capacity?`	`number`	`100`

Files

hooks/use-history-state.ts