UseRule

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

Rule props.

Extends

• RuleProps

Properties

actions

actions: QueryActions

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

Inherited from

RuleProps.actions

---

classNames

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

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

cloneRule

cloneRule: string

dragHandle

dragHandle: string

fields

fields: string

lockRule

lockRule: string

matchMode

matchMode: string

matchThreshold

matchThreshold: string

muteRule

muteRule: 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:460

---

context?

optional context?: any

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

Inherited from

RuleProps.context

---

disabled?

optional disabled?: boolean

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

Inherited from

RuleProps.disabled

---

dndRef?

optional dndRef?: Ref<HTMLDivElement>

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

Inherited from

UseRuleDnD.dndRef

---

dragHandleAttributes?

optional dragHandleAttributes?: HTMLAttributes<HTMLElement>

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

Props to spread onto the drag handle element (ARIA attributes, listeners).

Inherited from

UseRuleDnD.dragHandleAttributes

---

dragMonitorId?

optional dragMonitorId?: string | symbol

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

Inherited from

UseRuleDnD.dragMonitorId

---

dragRef?

optional dragRef?: Ref<HTMLSpanElement>

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

Inherited from

UseRuleDnD.dragRef

---

dropEffect?

optional dropEffect?: DropEffect

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

"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:785

Inherited from

UseRuleDnD.dropMonitorId

---

dropNotAllowed?

optional dropNotAllowed?: boolean

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

Inherited from

UseRuleDnD.dropNotAllowed

---

field?

optional field?: string

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

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?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string...; defaultOperator?: string; defaultValue?: any; disabled?: boolean; id?: string; inputType?: InputType | null; label: string; matchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]; name: string; operators?: string[] | FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: 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?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: 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 | [FlexibleOption, ...FlexibleOption[]] | ((operator: string) => ValueSources | [FlexibleOption, ...FlexibleOption[]]); }, operator: string) => boolean); defaultOperator?: string; defaultValue?: any; disabled?: boolean; id?: string; inputType?: InputType | null; label: string; matchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]; name: string; operators?: string[] | FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: 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?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: 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?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: 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?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: 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 | [FlexibleOption, ...FlexibleOption[]] | ((operator: string) => ValueSources | [FlexibleOption, ...FlexibleOption[]]); }>; validator?: RuleValidator; value: string; valueEditorType?: ValueEditorType | ((operator: string) => ValueEditorType); values?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; valueSources?: ValueSources | [FlexibleOption, ...FlexibleOption[]] | ((operator: string) => ValueSources | [FlexibleOption, ...FlexibleOption[]]); }

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

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?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string...; defaultOperator?: string; defaultValue?: any; disabled?: boolean; id?: string; inputType?: InputType | null; label: string; matchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]; name: string; operators?: string[] | FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: 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?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: 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 | [FlexibleOption, ...FlexibleOption[]] | ((operator: string) => ValueSources | [FlexibleOption, ...FlexibleOption[]]); }, operator: string) => boolean)

defaultOperator?

optional defaultOperator?: string

defaultValue?

optional defaultValue?: any

disabled?

optional disabled?: boolean

id?

optional id?: string

inputType?

optional inputType?: InputType | null

label

label: string

matchModes?

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

name

name: string

operators?

optional operators?: string[] | FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }> | FlexibleOption<string>[] | string | FlexibleOption<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?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: 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?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: 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?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: 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 | [FlexibleOption, ...FlexibleOption[]] | ((operator: string) => ValueSources | [FlexibleOption, ...FlexibleOption[]]); }>

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 | [FlexibleOption, ...FlexibleOption[]] | ((operator: string) => ValueSources | [FlexibleOption, ...FlexibleOption[]])

---

generateOnChangeHandler

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

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

Parameters

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

Returns

ValueChangeEventHandler

---

groupItems?

optional groupItems?: boolean

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

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:470

---

id?

optional id?: string

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

Inherited from

RuleProps.id

---

inputType

inputType: InputType | null

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

---

isDragging?

optional isDragging?: boolean

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

Inherited from

UseRuleDnD.isDragging

---

isOver?

optional isOver?: boolean

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

Inherited from

UseRuleDnD.isOver

---

matchModes

matchModes: MatchModeOptions

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

---

muted?

optional muted?: boolean

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

---

onChangeField

onChangeField: ValueChangeEventHandler

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

---

onChangeMatchMode

onChangeMatchMode: ValueChangeEventHandler

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

---

onChangeOperator

onChangeOperator: ValueChangeEventHandler

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

---

onChangeValue

onChangeValue: ValueChangeEventHandler

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

---

onChangeValueSource

onChangeValueSource: ValueChangeEventHandler

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

---

operator?

optional operator?: string

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

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:473

---

outerClassName

outerClassName: string

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

---

parentDisabled?

optional parentDisabled?: boolean

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

Inherited from

RuleProps.parentDisabled

---

parentMuted?

optional parentMuted?: boolean

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

Overrides

RuleProps.parentMuted

---

path

path: Path

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

Inherited from

RuleProps.path

---

removeRule

removeRule: ActionElementEventHandler

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

---

rule

rule: RuleType<string, string>

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

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:727

Inherited from

RuleProps.schema

---

shiftDownDisabled?

optional shiftDownDisabled?: boolean

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

Inherited from

RuleProps.shiftDownDisabled

---

shiftRuleDown

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

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

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:476

Parameters

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

Returns

void

---

shiftUpDisabled?

optional shiftUpDisabled?: boolean

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

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?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string...; defaultOperator?: string; defaultValue?: any; disabled?: boolean; id?: string; inputType?: InputType | null; label: string; matchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]; name: string; operators?: string[] | FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: 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?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: 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 | [FlexibleOption, ...FlexibleOption[]] | ((operator: string) => ValueSources | [FlexibleOption, ...FlexibleOption[]]); }, operator: string) => boolean); defaultOperator?: string; defaultValue?: any; disabled?: boolean; id?: string; inputType?: InputType | null; label: string; matchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]; name: string; operators?: string[] | FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: 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?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: 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?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: 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?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: 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 | [FlexibleOption, ...FlexibleOption[]] | ((operator: string) => ValueSources | [FlexibleOption, ...FlexibleOption[]]); }>; validator?: RuleValidator; value: string; valueEditorType?: ValueEditorType | ((operator: string) => ValueEditorType); values?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; valueSources?: ValueSources | [FlexibleOption, ...FlexibleOption[]] | ((operator: string) => ValueSources | [FlexibleOption, ...FlexibleOption[]]); }>

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

---

subQueryBuilderProps

subQueryBuilderProps: Record<string, unknown>

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

---

toggleLockRule

toggleLockRule: ActionElementEventHandler

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

---

toggleMuteRule

toggleMuteRule: ActionElementEventHandler

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

---

translations

translations: Translations

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

Inherited from

RuleProps.translations

---

validationResult

validationResult: boolean | ValidationResult

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

---

value?

optional value?: any

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

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:483

---

valueEditorType

valueEditorType: ValueEditorType

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

---

values

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

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

---

valueSource?

optional valueSource?: ValueSource

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

Deprecated

Use the valueSource property of the rule prop instead

Inherited from

RuleProps.valueSource

---

valueSourceOptions

valueSourceOptions: [{ label: string; name: ValueSource; value: ValueSource; }, ...{ label: string; name: ValueSource; value: ValueSource }[]]

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

---

valueSources

valueSources: ValueSources

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

---

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.