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 wrappped in WithUnknownIndex) instead, otherwise
the unknown
index property will cause issues.
Extends
WithUnknownIndex
<SetRequired
<BaseOption
<N
>,"name"
|"value"
>>
Extended by
Type Parameters
Type Parameter | Default type |
---|---|
N extends string | string |
Properties
disabled?
optional
disabled:boolean
Inherited from
WithUnknownIndex.disabled
Defined in
packages/react-querybuilder/src/types/options.ts:33
label
label:
string
Inherited from
WithUnknownIndex.label
Defined in
packages/react-querybuilder/src/types/options.ts:32
name
name:
N
Inherited from
WithUnknownIndex.name
Defined in
packages/react-querybuilder/src/types/options.ts:30
value
value:
N
Inherited from
WithUnknownIndex.value
Defined in
packages/react-querybuilder/src/types/options.ts:31
API documentation is generated from the latest commit on the main
branch. It may be somewhat inconsistent with official releases of React Query Builder.