Controls<F, O>
Subcomponents.
Type parameters
| Type parameter |
|---|
F extends FullField |
O extends string |
Properties
actionElement
actionElement:
ComponentType<ActionProps>
Default component for all button-type controls.
Default
ActionElement
Source
packages/react-querybuilder/src/types/propsUsingReact.ts:196
addGroupAction
addGroupAction:
ComponentType<ActionWithRulesAndAddersProps>
Adds a sub-group to the current group.
Default
ActionElement
Source
packages/react-querybuilder/src/types/propsUsingReact.ts:202
addRuleAction
addRuleAction:
ComponentType<ActionWithRulesAndAddersProps>
Adds a rule to the current group.
Default
ActionElement
Source
packages/react-querybuilder/src/types/propsUsingReact.ts:208
cloneGroupAction
cloneGroupAction:
ComponentType<ActionWithRulesProps>
Clones the current group.
Default
ActionElement
Source
packages/react-querybuilder/src/types/propsUsingReact.ts:214
cloneRuleAction
cloneRuleAction:
ComponentType<ActionProps>
Clones the current rule.
Default
ActionElement
Source
packages/react-querybuilder/src/types/propsUsingReact.ts:220
combinatorSelector
combinatorSelector:
ComponentType<CombinatorSelectorProps>
Selects the combinator property for the current group, or the current independent combinator value.
Default
ValueSelector
Source
packages/react-querybuilder/src/types/propsUsingReact.ts:226
dragHandle
dragHandle:
ForwardRefExoticComponent<DragHandleProps&RefAttributes<HTMLElement>>
Provides a draggable handle for reordering rules and groups.
Default
DragHandle
Source
packages/react-querybuilder/src/types/propsUsingReact.ts:232
fieldSelector
fieldSelector:
ComponentType<FieldSelectorProps<F>>
Selects the field property for the current rule.
Default
ValueSelector
Source
packages/react-querybuilder/src/types/propsUsingReact.ts:238
inlineCombinator
inlineCombinator:
ComponentType<InlineCombinatorProps>
A small wrapper around the combinatorSelector component.
Default
InlineCombinator
Source
packages/react-querybuilder/src/types/propsUsingReact.ts:244
lockGroupAction
lockGroupAction:
ComponentType<ActionWithRulesProps>
Locks the current group (sets the disabled property to true).
Default
ActionElement
Source
packages/react-querybuilder/src/types/propsUsingReact.ts:250
lockRuleAction
lockRuleAction:
ComponentType<ActionWithRulesProps>
Locks the current rule (sets the disabled property to true).
Default
ActionElement
Source
packages/react-querybuilder/src/types/propsUsingReact.ts:256
notToggle
notToggle:
ComponentType<NotToggleProps>
Toggles the not property of the current group between true and false.
Default
NotToggle
Source
packages/react-querybuilder/src/types/propsUsingReact.ts:262
operatorSelector
operatorSelector:
ComponentType<OperatorSelectorProps>
Selects the operator property for the current rule.
Default
ValueSelector
Source
packages/react-querybuilder/src/types/propsUsingReact.ts:268
removeGroupAction
removeGroupAction:
ComponentType<ActionWithRulesProps>
Removes the current group from its parent group's rules array.
Default
ActionElement
Source
packages/react-querybuilder/src/types/propsUsingReact.ts:274
removeRuleAction
removeRuleAction:
ComponentType<ActionProps>
Removes the current rule from its parent group's rules array.
Default
ActionElement
Source
packages/react-querybuilder/src/types/propsUsingReact.ts:280
rule
rule:
ComponentType<RuleProps<string,string>>
Rule layout component.
Default
Rule
Source
packages/react-querybuilder/src/types/propsUsingReact.ts:286
ruleGroup
ruleGroup:
ComponentType<RuleGroupProps<F,O>>
Rule group layout component.
Default
RuleGroup
Source
packages/react-querybuilder/src/types/propsUsingReact.ts:292
shiftActions
shiftActions:
ComponentType<ShiftActionsProps>
Shifts the current rule/group up or down in the query hierarchy.
Default
ShiftActions
Source
packages/react-querybuilder/src/types/propsUsingReact.ts:298
valueEditor
valueEditor:
ComponentType<ValueEditorProps<F,O>>
Updates the value property for the current rule.
Default
ValueEditor
Source
packages/react-querybuilder/src/types/propsUsingReact.ts:304
valueSelector
valueSelector:
ComponentType<ValueSelectorProps<FullOption<string>>>
Default component for all value selector controls.
Default
ValueSelector
Source
packages/react-querybuilder/src/types/propsUsingReact.ts:310
valueSourceSelector
valueSourceSelector:
ComponentType<ValueSourceSelectorProps>
Selects the valueSource property for the current rule.
Default
ValueSelector
Source
packages/react-querybuilder/src/types/propsUsingReact.ts:316
API documentation is generated from the latest commit on the main branch. It may be somewhat inconsistent with official releases of React Query Builder.