Skip to main content

ControlElementsProp<F, O>

ControlElementsProp<F, O>: Partial<object>

Type declaration​

actionElement​

actionElement: ComponentType<ActionProps>

Default component for all button-type controls.

Default​

ActionElement

addGroupAction​

addGroupAction: ComponentType<ActionWithRulesAndAddersProps> | null

Adds a sub-group to the current group.

Default​

ActionElement

addRuleAction​

addRuleAction: ComponentType<ActionWithRulesAndAddersProps> | null

Adds a rule to the current group.

Default​

ActionElement

cloneGroupAction​

cloneGroupAction: ComponentType<ActionWithRulesProps> | null

Clones the current group.

Default​

ActionElement

cloneRuleAction​

cloneRuleAction: ComponentType<ActionProps> | null

Clones the current rule.

Default​

ActionElement

combinatorSelector​

combinatorSelector: ComponentType<CombinatorSelectorProps> | null

Selects the combinator property for the current group, or the current independent combinator value.

Default​

ValueSelector

dragHandle​

dragHandle: ForwardRefExoticComponent<DragHandleProps & RefAttributes<HTMLElement>> | null

Provides a draggable handle for reordering rules and groups.

Default​

DragHandle

fieldSelector​

fieldSelector: ComponentType<FieldSelectorProps<F>> | null

Selects the field property for the current rule.

Default​

ValueSelector

inlineCombinator​

inlineCombinator: ComponentType<InlineCombinatorProps> | null

A small wrapper around the combinatorSelector component.

Default​

InlineCombinator

lockGroupAction​

lockGroupAction: ComponentType<ActionWithRulesProps> | null

Locks the current group (sets the disabled property to true).

Default​

ActionElement

lockRuleAction​

lockRuleAction: ComponentType<ActionWithRulesProps> | null

Locks the current rule (sets the disabled property to true).

Default​

ActionElement

notToggle​

notToggle: ComponentType<NotToggleProps> | null

Toggles the not property of the current group between true and false.

Default​

NotToggle

operatorSelector​

operatorSelector: ComponentType<OperatorSelectorProps> | null

Selects the operator property for the current rule.

Default​

ValueSelector

removeGroupAction​

removeGroupAction: ComponentType<ActionWithRulesProps> | null

Removes the current group from its parent group's rules array.

Default​

ActionElement

removeRuleAction​

removeRuleAction: ComponentType<ActionProps> | null

Removes the current rule from its parent group's rules array.

Default​

ActionElement

rule​

rule: ComponentType<RuleProps>

Rule layout component.

Default​

Rule

ruleGroup​

ruleGroup: ComponentType<RuleGroupProps<F, O>>

Rule group layout component.

Default​

RuleGroup

ruleGroupBodyElements​

ruleGroupBodyElements: ComponentType<RuleGroupProps & ReturnType<typeof useRuleGroup>>

Rule group body components.

Default​

RuleGroupBodyComponents

ruleGroupHeaderElements​

ruleGroupHeaderElements: ComponentType<RuleGroupProps & ReturnType<typeof useRuleGroup>>

Rule group header components.

Default​

RuleGroupHeaderComponents

shiftActions​

shiftActions: ComponentType<ShiftActionsProps> | null

Shifts the current rule/group up or down in the query hierarchy.

Default​

ShiftActions

valueEditor​

valueEditor: ComponentType<ValueEditorProps<F, O>> | null

Updates the value property for the current rule.

Default​

ValueEditor

valueSelector​

valueSelector: ComponentType<ValueSelectorProps>

Default component for all value selector controls.

Default​

ValueSelector

valueSourceSelector​

valueSourceSelector: ComponentType<ValueSourceSelectorProps> | null

Selects the valueSource property for the current rule.

Default​

ValueSelector

Type Parameters​

Type Parameter
F extends FullField
O extends string

Defined in​

packages/react-querybuilder/src/types/propsUsingReact.ts:196

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.