Skip to main content

FullOption<N>

FullOption<N>: Simplify<WithUnknownIndex<SetRequired<BaseOption<N>, "name" | "value">>>

Defined in: packages/react-querybuilder/src/types/options.ts:81

A generic Option requiring both name and value properties. Props that extend OptionList accept BaseOption, but corresponding props sent to subcomponents will always be translated to this type first to ensure both name and value are available.

NOTE: Do not extend from this type directly. Use BaseFullOption (optionally wrapped in WithUnknownIndex) instead, otherwise the unknown index property will cause issues. See Option and ValueOption for examples.

Type Parameters

Type ParameterDefault type
N extends stringstring

caution

API documentation is generated from the latest commit on the main branch. It may be somewhat inconsistent with official releases of React Query Builder.