Hooks

Functions¶

useSuperglue(): SuperglueState

A lightweight hook that grabs the superglue state from the store.

useFlash\<T>(): T

A hook that returns the current flash state from the store. Flash is cleared automatically on every visit.

Pass a type parameter to narrow the flash shape:

const flash = useFlash<{ notice?: string; alert?: string }>()

Type Parameter	Default type
`T`	`FlashState`

T

useSetFlash(): { setFlash: (flash: FlashState) => void; clearFlash: (key?: string) => void; }

A hook that returns functions to set and clear flash messages on the client side.

const { setFlash, clearFlash } = useSetFlash()

setFlash({ notice: 'Saved!' })
clearFlash('notice')
clearFlash() // clears all

{ setFlash: (flash: FlashState) => void; clearFlash: (key?: string) => void; }

Name	Type	Defined in
`setFlash()`	(`flash`: `FlashState`) => `void`	hooks/index.ts:64
`clearFlash()`	(`key?`: `string`) => `void`	hooks/index.ts:64

Re-exports useContent

Re-exports unproxy