Skip to content
React PDF Viewer

Search

UseControllableStateOptions reference

Options for useControllableState: the controlled value, the initial value while uncontrolled, and the change callback.

Used by

Import

import type { UseControllableStateOptions } from '@kingtech/react-pdf-viewer';

Properties

NameTypeDefaultRequiredDescription
valueT—YesThe controlled value; undefined = uncontrolled.
defaultValueT | () => T—YesInitial value while uncontrolled.
onChange(value: T) => void—NoCalled with every change, controlled or not.
namestring—NoProp name used in development warnings.

Source

packages/react-pdf-viewer/src/hooks/useControllableState.ts

Generated from content/react-pdf-viewer/reference/use-controllable-state-options.schema.json. Do not edit by hand.