FullOption<N>

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.

Extends

• WithUnknownIndex<SetRequired<BaseOption<N>, "name" | "value">>

Extended by

• FullField
• FullOperator
• FullCombinator

Type Parameters

Type Parameter	Default type
N extends string	string

Indexable

[key: string]: unknown

Properties

disabled?

optional disabled: boolean

Inherited from

WithUnknownIndex.disabled

Defined in

packages/react-querybuilder/src/types/options.ts:34

---

label

label: string

Inherited from

WithUnknownIndex.label

Defined in

packages/react-querybuilder/src/types/options.ts:33

---

name

name: N

Inherited from

WithUnknownIndex.name

Defined in

packages/react-querybuilder/src/types/options.ts:31

---

value

value: N

Inherited from

WithUnknownIndex.value

Defined in

packages/react-querybuilder/src/types/options.ts:32

---

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.