Interface ControllableValueOptions<TValue, TReason>

Configuration shared by controlled and uncontrolled values.

interface ControllableValueOptions<TValue, TReason extends string> {
    defaultValue: TValue;
    getValue?: () => TValue;
    onValueChange?: (value: TValue, details: ChangeDetails<TReason>) => void;
    subscribeValue?: (listener: () => void) => Unsubscribe;
}

Type Parameters

TValue
TReason extends string

Index

Properties

defaultValue getValue? onValueChange? subscribeValue?

Properties

`Readonly`defaultValue

defaultValue: TValue

Initial value used only in uncontrolled mode.

`Optional` `Readonly`getValue

getValue?: () => TValue

Reads the consumer-owned value. Its presence enables controlled mode.

`Optional` `Readonly`onValueChange

onValueChange?: (value: TValue, details: ChangeDetails<TReason>) => void

Receives every accepted value request and its typed cause.

`Optional` `Readonly`subscribeValue

subscribeValue?: (listener: () => void) => Unsubscribe

Subscribes to consumer-owned value changes in controlled mode.