Skip to main content

Interface: FieldSelectorProps<F>

react-querybuilder.FieldSelectorProps

Props for fieldSelector components.

Type parameters

NameType
Fextends FullField = FullField

Hierarchy

Properties

className

Optional className: string

CSS classNames to be applied.

This is string and not Classname because the Rule and RuleGroup components run clsx() to produce the className that gets passed to each subcomponent.

Inherited from

BaseSelectorProps.className

Defined in

packages/react-querybuilder/src/types/props.ts:29


context

Optional context: any

Container for custom props that are passed to all components.

Inherited from

BaseSelectorProps.context

Defined in

packages/react-querybuilder/src/types/props.ts:50


disabled

Optional disabled: boolean

Disables the control.

Inherited from

BaseSelectorProps.disabled

Defined in

packages/react-querybuilder/src/types/props.ts:45


level

level: number

The level of the current group. Always equal to path.length.

Inherited from

BaseSelectorProps.level

Defined in

packages/react-querybuilder/src/types/props.ts:37


operator

Optional operator: F extends FullField<string, OperatorName, string, Option<OperatorName>, Option<string>> ? OperatorName : string

Defined in

packages/react-querybuilder/src/types/props.ts:113


options

options: FullOptionList<F>

Inherited from

BaseSelectorProps.options

Defined in

packages/react-querybuilder/src/types/props.ts:87


path

path: Path

Path to this subcomponent's rule/group within the query.

Inherited from

BaseSelectorProps.path

Defined in

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


rule

rule: RuleType<string, string, any, string>

Inherited from

CommonRuleSubComponentProps.rule

Defined in

packages/react-querybuilder/src/types/props.ts:79


schema

schema: Schema<ToFullOption<F>, string>

All subcomponents receive the configuration schema as a prop.

Inherited from

BaseSelectorProps.schema

Defined in

packages/react-querybuilder/src/types/props.ts:62


testID

Optional testID: string

Test ID for this component.

Inherited from

BaseSelectorProps.testID

Defined in

packages/react-querybuilder/src/types/props.ts:58


title

Optional title: string

The title/tooltip for this control.

Inherited from

BaseSelectorProps.title

Defined in

packages/react-querybuilder/src/types/props.ts:41


validation

Optional validation: boolean | ValidationResult

Validation result of the parent rule/group.

Inherited from

BaseSelectorProps.validation

Defined in

packages/react-querybuilder/src/types/props.ts:54


value

Optional value: string

Inherited from

BaseSelectorProps.value

Defined in

packages/react-querybuilder/src/types/props.ts:70

Methods

handleOnChange

handleOnChange(value): void

Parameters

NameType
valueany

Returns

void

Inherited from

BaseSelectorProps.handleOnChange

Defined in

packages/react-querybuilder/src/types/props.ts:72