UseRule

Defined in: packages/react-querybuilder/src/components/Rule.tsx:413

Rule props.

Extends

• RuleProps

Properties

actions

actions: QueryActions

Defined in: packages/react-querybuilder/src/types/props.ts:623

Inherited from

RuleProps.actions

---

classNames

classNames: { cloneRule: string; dragHandle: string; fields: string; lockRule: string; matchMode: string; matchThreshold: string; operators: string; removeRule: string; shiftActions: string; value: string; valueSource: string; }

Defined in: packages/react-querybuilder/src/components/Rule.tsx:414

cloneRule

cloneRule: string

dragHandle

dragHandle: string

fields

fields: string

lockRule

lockRule: string

matchMode

matchMode: string

matchThreshold

matchThreshold: string

operators

operators: string

removeRule

removeRule: string

shiftActions

shiftActions: string

value

value: string

valueSource

valueSource: string

---

cloneRule

cloneRule: ActionElementEventHandler

Defined in: packages/react-querybuilder/src/components/Rule.tsx:427

---

context?

optional context: any

Defined in: packages/react-querybuilder/src/types/props.ts:628

Inherited from

RuleProps.context

---

disabled?

optional disabled: boolean

Defined in: packages/react-querybuilder/src/types/props.ts:624

Inherited from

RuleProps.disabled

---

dndRef?

optional dndRef: Ref<HTMLDivElement>

Defined in: packages/react-querybuilder/src/types/props.ts:681

Inherited from

UseRuleDnD.dndRef

---

dragMonitorId?

optional dragMonitorId: string | symbol

Defined in: packages/react-querybuilder/src/types/props.ts:677

Inherited from

UseRuleDnD.dragMonitorId

---

dragRef?

optional dragRef: Ref<HTMLSpanElement>

Defined in: packages/react-querybuilder/src/types/props.ts:680

Inherited from

UseRuleDnD.dragRef

---

dropEffect?

optional dropEffect: DropEffect

Defined in: packages/react-querybuilder/src/types/props.ts:683

"move" by default; "copy" if the modifier key is pressed.

Inherited from

UseRuleDnD.dropEffect

---

dropMonitorId?

optional dropMonitorId: string | symbol

Defined in: packages/react-querybuilder/src/types/props.ts:679

Inherited from

UseRuleDnD.dropMonitorId

---

dropNotAllowed?

optional dropNotAllowed: boolean

Defined in: packages/react-querybuilder/src/types/props.ts:686

Inherited from

UseRuleDnD.dropNotAllowed

---

field?

optional field: string

Defined in: packages/react-querybuilder/src/types/props.ts:701

Deprecated

Use the field property of the rule prop instead

Inherited from

RuleProps.field

---

fieldData

fieldData: {[key: string]: unknown; className?: Classname; comparator?: string | (f: {[key: string]: unknown; className?: Classname; comparator?: string | ((f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | string[] | FlexibleOption<...>[] | (string...; defaultOperator?: string; defaultValue?: any; disabled?: boolean; id?: string; inputType?: null | InputType; label: string; matchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]; name: string; operators?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }> | string[] | FlexibleOption<string>[] | string | FlexibleOption<string>[]; placeholder?: string; subproperties?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | string[] | FlexibleOption<...>[] | (string | FlexibleOpt...>; validator?: RuleValidator; value: string; valueEditorType?: ValueEditorType | (operator: string) => ValueEditorType; values?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; valueSources?: ValueSources | ValueSourceFlexibleOptions | (operator: string) => ValueSources | ValueSourceFlexibleOptions; }, operator: string) => boolean; defaultOperator?: string; defaultValue?: any; disabled?: boolean; id?: string; inputType?: null | InputType; label: string; matchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]; name: string; operators?: string[] | FlexibleOption<string>[] | string | FlexibleOption<string>[] | FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; placeholder?: string; subproperties?: FlexibleOptionList<{[key: string]: unknown; className?: Classname | undefined; comparator?: string | (f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | string[] | FlexibleOption<...>[] | (string | FlexibleOpt..., operator: string) => boolean; defaultOperator?: string; defaultValue?: any; disabled?: boolean; id?: string; inputType?: InputType | null | undefined; label: string; matchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]; name: string; operators?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | string[] | FlexibleOption<string>[] | (string | FlexibleOption<...>)[] | undefined; placeholder?: string; subproperties?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | string[] | FlexibleOption<...>[] | (s...; validator?: RuleValidator; value: string; valueEditorType?: ValueEditorType | ((operator: string) => ValueEditorType) | undefined; values?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | undefined; valueSources?: ValueSources | ValueSourceFlexibleOptions | ((operator: string) => ValueSources | ValueSourceFlexibleOptions) | undefined; }>; validator?: RuleValidator; value: string; valueEditorType?: ValueEditorType | (operator: string) => ValueEditorType; values?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; valueSources?: ValueSources | ValueSourceFlexibleOptions | (operator: string) => ValueSources | ValueSourceFlexibleOptions; }

Defined in: packages/react-querybuilder/src/components/Rule.tsx:428

Index Signature

[key: string]: unknown

className?

optional className: Classname

comparator?

optional comparator: string | (f: {[key: string]: unknown; className?: Classname; comparator?: string | ((f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | string[] | FlexibleOption<...>[] | (string...; defaultOperator?: string; defaultValue?: any; disabled?: boolean; id?: string; inputType?: null | InputType; label: string; matchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]; name: string; operators?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }> | string[] | FlexibleOption<string>[] | string | FlexibleOption<string>[]; placeholder?: string; subproperties?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | string[] | FlexibleOption<...>[] | (string | FlexibleOpt...>; validator?: RuleValidator; value: string; valueEditorType?: ValueEditorType | (operator: string) => ValueEditorType; values?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; valueSources?: ValueSources | ValueSourceFlexibleOptions | (operator: string) => ValueSources | ValueSourceFlexibleOptions; }, operator: string) => boolean

defaultOperator?

optional defaultOperator: string

defaultValue?

optional defaultValue: any

disabled?

optional disabled: boolean

id?

optional id: string

inputType?

optional inputType: null | InputType

label

label: string

matchModes?

optional matchModes: boolean | MatchMode[] | FlexibleOption<MatchMode>[]

name

name: string

operators?

optional operators: string[] | FlexibleOption<string>[] | string | FlexibleOption<string>[] | FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>

placeholder?

optional placeholder: string

subproperties?

optional subproperties: FlexibleOptionList<{[key: string]: unknown; className?: Classname | undefined; comparator?: string | (f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | string[] | FlexibleOption<...>[] | (string | FlexibleOpt..., operator: string) => boolean; defaultOperator?: string; defaultValue?: any; disabled?: boolean; id?: string; inputType?: InputType | null | undefined; label: string; matchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]; name: string; operators?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | string[] | FlexibleOption<string>[] | (string | FlexibleOption<...>)[] | undefined; placeholder?: string; subproperties?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | string[] | FlexibleOption<...>[] | (s...; validator?: RuleValidator; value: string; valueEditorType?: ValueEditorType | ((operator: string) => ValueEditorType) | undefined; values?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | undefined; valueSources?: ValueSources | ValueSourceFlexibleOptions | ((operator: string) => ValueSources | ValueSourceFlexibleOptions) | undefined; }>

Properties of items in the value.

validator?

optional validator: RuleValidator

value

value: string

valueEditorType?

optional valueEditorType: ValueEditorType | (operator: string) => ValueEditorType

values?

optional values: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>

valueSources?

optional valueSources: ValueSources | ValueSourceFlexibleOptions | (operator: string) => ValueSources | ValueSourceFlexibleOptions

---

generateOnChangeHandler()

generateOnChangeHandler: (prop: "match" | "value" | "disabled" | "field" | "operator" | "valueSource" | "combinatorPreceding") => ValueChangeEventHandler

Defined in: packages/react-querybuilder/src/components/Rule.tsx:429

Parameters

Parameter	Type
prop	"match" | "value" | "disabled" | "field" | "operator" | "valueSource" | "combinatorPreceding"

Returns

ValueChangeEventHandler

---

groupItems?

optional groupItems: boolean

Defined in: packages/react-querybuilder/src/types/props.ts:685

True if the dragged and hovered items should form a new group.

Inherited from

UseRuleDnD.groupItems

---

hideValueControls

hideValueControls: boolean

Defined in: packages/react-querybuilder/src/components/Rule.tsx:437

---

id?

optional id: string

Defined in: packages/react-querybuilder/src/types/props.ts:618

Inherited from

RuleProps.id

---

inputType

inputType: null | InputType

Defined in: packages/react-querybuilder/src/components/Rule.tsx:438

---

isDragging?

optional isDragging: boolean

Defined in: packages/react-querybuilder/src/types/props.ts:676

Inherited from

UseRuleDnD.isDragging

---

isOver?

optional isOver: boolean

Defined in: packages/react-querybuilder/src/types/props.ts:678

Inherited from

UseRuleDnD.isOver

---

matchModes

matchModes: MatchModeOptions

Defined in: packages/react-querybuilder/src/components/Rule.tsx:439

---

onChangeField

onChangeField: ValueChangeEventHandler

Defined in: packages/react-querybuilder/src/components/Rule.tsx:433

---

onChangeMatchMode

onChangeMatchMode: ValueChangeEventHandler

Defined in: packages/react-querybuilder/src/components/Rule.tsx:434

---

onChangeOperator

onChangeOperator: ValueChangeEventHandler

Defined in: packages/react-querybuilder/src/components/Rule.tsx:435

---

onChangeValue

onChangeValue: ValueChangeEventHandler

Defined in: packages/react-querybuilder/src/components/Rule.tsx:436

---

onChangeValueSource

onChangeValueSource: ValueChangeEventHandler

Defined in: packages/react-querybuilder/src/components/Rule.tsx:432

---

operator?

optional operator: string

Defined in: packages/react-querybuilder/src/types/props.ts:705

Deprecated

Use the operator property of the rule prop instead

Inherited from

RuleProps.operator

---

operators

operators: OptionList<FullOperator<string>>

Defined in: packages/react-querybuilder/src/components/Rule.tsx:440

---

outerClassName

outerClassName: string

Defined in: packages/react-querybuilder/src/components/Rule.tsx:441

---

parentDisabled?

optional parentDisabled: boolean

Defined in: packages/react-querybuilder/src/types/props.ts:620

Inherited from

RuleProps.parentDisabled

---

path

path: Path

Defined in: packages/react-querybuilder/src/types/props.ts:619

Inherited from

RuleProps.path

---

removeRule

removeRule: ActionElementEventHandler

Defined in: packages/react-querybuilder/src/components/Rule.tsx:442

---

rule

rule: RuleType<string, string>

Defined in: packages/react-querybuilder/src/types/props.ts:697

Inherited from

RuleProps.rule

---

schema

schema: Schema<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }, string>

Defined in: packages/react-querybuilder/src/types/props.ts:622

Inherited from

RuleProps.schema

---

shiftDownDisabled?

optional shiftDownDisabled: boolean

Defined in: packages/react-querybuilder/src/types/props.ts:626

Inherited from

RuleProps.shiftDownDisabled

---

shiftRuleDown()

shiftRuleDown: (event?: MouseEvent<Element, MouseEvent>, _context?: any) => void

Defined in: packages/react-querybuilder/src/components/Rule.tsx:444

Parameters

Parameter	Type
event?	MouseEvent<Element, MouseEvent>
_context?	any

Returns

void

---

shiftRuleUp()

shiftRuleUp: (event?: MouseEvent<Element, MouseEvent>, _context?: any) => void

Defined in: packages/react-querybuilder/src/components/Rule.tsx:443

Parameters

Parameter	Type
event?	MouseEvent<Element, MouseEvent>
_context?	any

Returns

void

---

shiftUpDisabled?

optional shiftUpDisabled: boolean

Defined in: packages/react-querybuilder/src/types/props.ts:625

Inherited from

RuleProps.shiftUpDisabled

---

subproperties

subproperties: UseFields<{[key: string]: unknown; className?: Classname; comparator?: string | (f: {[key: string]: unknown; className?: Classname; comparator?: string | ((f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | string[] | FlexibleOption<...>[] | (string...; defaultOperator?: string; defaultValue?: any; disabled?: boolean; id?: string; inputType?: null | InputType; label: string; matchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]; name: string; operators?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }> | string[] | FlexibleOption<string>[] | string | FlexibleOption<string>[]; placeholder?: string; subproperties?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | string[] | FlexibleOption<...>[] | (string | FlexibleOpt...>; validator?: RuleValidator; value: string; valueEditorType?: ValueEditorType | (operator: string) => ValueEditorType; values?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; valueSources?: ValueSources | ValueSourceFlexibleOptions | (operator: string) => ValueSources | ValueSourceFlexibleOptions; }, operator: string) => boolean; defaultOperator?: string; defaultValue?: any; disabled?: boolean; id?: string; inputType?: null | InputType; label: string; matchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]; name: string; operators?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }> | string[] | FlexibleOption<string>[] | string | FlexibleOption<string>[]; placeholder?: string; subproperties?: FlexibleOptionList<{[key: string]: unknown; className?: Classname | undefined; comparator?: string | (f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | string[] | FlexibleOption<...>[] | (string | FlexibleOpt..., operator: string) => boolean; defaultOperator?: string; defaultValue?: any; disabled?: boolean; id?: string; inputType?: InputType | null | undefined; label: string; matchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]; name: string; operators?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | string[] | FlexibleOption<string>[] | (string | FlexibleOption<...>)[] | undefined; placeholder?: string; subproperties?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | string[] | FlexibleOption<...>[] | (s...; validator?: RuleValidator; value: string; valueEditorType?: ValueEditorType | ((operator: string) => ValueEditorType) | undefined; values?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | undefined; valueSources?: ValueSources | ValueSourceFlexibleOptions | ((operator: string) => ValueSources | ValueSourceFlexibleOptions) | undefined; }>; validator?: RuleValidator; value: string; valueEditorType?: ValueEditorType | (operator: string) => ValueEditorType; values?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; valueSources?: ValueSources | ValueSourceFlexibleOptions | (operator: string) => ValueSources | ValueSourceFlexibleOptions; }>

Defined in: packages/react-querybuilder/src/components/Rule.tsx:445

---

subQueryBuilderProps

subQueryBuilderProps: Record<string, unknown>

Defined in: packages/react-querybuilder/src/components/Rule.tsx:446

---

toggleLockRule

toggleLockRule: ActionElementEventHandler

Defined in: packages/react-querybuilder/src/components/Rule.tsx:447

---

translations

translations: Translations

Defined in: packages/react-querybuilder/src/types/props.ts:621

Inherited from

RuleProps.translations

---

validationResult

validationResult: boolean | ValidationResult

Defined in: packages/react-querybuilder/src/components/Rule.tsx:448

---

value?

optional value: any

Defined in: packages/react-querybuilder/src/types/props.ts:710

Deprecated

Use the value property of the rule prop instead

Inherited from

RuleProps.value

---

valueEditorSeparator

valueEditorSeparator: ReactNode

Defined in: packages/react-querybuilder/src/components/Rule.tsx:449

---

valueEditorType

valueEditorType: ValueEditorType

Defined in: packages/react-querybuilder/src/components/Rule.tsx:450

---

values

values: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; }>

Defined in: packages/react-querybuilder/src/components/Rule.tsx:451

---

valueSource?

optional valueSource: ValueSource

Defined in: packages/react-querybuilder/src/types/props.ts:714

Deprecated

Use the valueSource property of the rule prop instead

Inherited from

RuleProps.valueSource

---

valueSourceOptions

valueSourceOptions: ValueSourceFullOptions

Defined in: packages/react-querybuilder/src/components/Rule.tsx:452

---

valueSources

valueSources: ValueSources

Defined in: packages/react-querybuilder/src/components/Rule.tsx:453

---

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.