defaultControlElements
constdefaultControlElements:object
Default components used by QueryBuilder.
Type declaration
actionElement()
actionElement: (
props) =>Element=ActionElement
Default <button> component used by QueryBuilder.
Parameters
| Parameter | Type |
|---|---|
props | ActionProps |
Returns
Element
addGroupAction()
addGroupAction: (
props) =>Element=ActionElement
Default <button> component used by QueryBuilder.
Parameters
| Parameter | Type |
|---|---|
props | ActionProps |
Returns
Element
addRuleAction()
addRuleAction: (
props) =>Element=ActionElement
Default <button> component used by QueryBuilder.
Parameters
| Parameter | Type |
|---|---|
props | ActionProps |
Returns
Element
cloneGroupAction()
cloneGroupAction: (
props) =>Element=ActionElement
Default <button> component used by QueryBuilder.
Parameters
| Parameter | Type |
|---|---|
props | ActionProps |
Returns
Element
cloneRuleAction()
cloneRuleAction: (
props) =>Element=ActionElement
Default <button> component used by QueryBuilder.
Parameters
| Parameter | Type |
|---|---|
props | ActionProps |
Returns
Element
combinatorSelector()
combinatorSelector: <
Opt>(props) =>Element=ValueSelector
Default <select> component used by QueryBuilder.
Type Parameters
| Type Parameter | Default type |
|---|---|
Opt extends FullOption<string> | FullOption<string> |
Parameters
| Parameter | Type |
|---|---|
props | ValueSelectorProps<Opt> |
Returns
Element
dragHandle
dragHandle:
ForwardRefExoticComponent<DragHandleProps&RefAttributes<HTMLSpanElement>> =DragHandle
fieldSelector()
fieldSelector: <
Opt>(props) =>Element=ValueSelector
Default <select> component used by QueryBuilder.
Type Parameters
| Type Parameter | Default type |
|---|---|
Opt extends FullOption<string> | FullOption<string> |
Parameters
| Parameter | Type |
|---|---|
props | ValueSelectorProps<Opt> |
Returns
Element
inlineCombinator()
inlineCombinator: (
allProps) =>Element=InlineCombinator
Default inlineCombinator component used by QueryBuilder. A small <div>
wrapper around the combinatorSelector component, used when either
showCombinatorsBetweenRules or independentCombinators are true.
Parameters
| Parameter | Type |
|---|---|
allProps | InlineCombinatorProps |
Returns
Element
lockGroupAction()
lockGroupAction: (
props) =>Element=ActionElement
Default <button> component used by QueryBuilder.
Parameters
| Parameter | Type |
|---|---|
props | ActionProps |
Returns
Element
lockRuleAction()
lockRuleAction: (
props) =>Element=ActionElement
Default <button> component used by QueryBuilder.
Parameters
| Parameter | Type |
|---|---|
props | ActionProps |
Returns
Element
notToggle()
notToggle: (
props) =>Element=NotToggle
Default notToggle (aka inversion) component used by QueryBuilder.
Parameters
| Parameter | Type |
|---|---|
props | NotToggleProps |
Returns
Element
operatorSelector()
operatorSelector: <
Opt>(props) =>Element=ValueSelector
Default <select> component used by QueryBuilder.
Type Parameters
| Type Parameter | Default type |
|---|---|
Opt extends FullOption<string> | FullOption<string> |
Parameters
| Parameter | Type |
|---|---|
props | ValueSelectorProps<Opt> |
Returns
Element
removeGroupAction()
removeGroupAction: (
props) =>Element=ActionElement
Default <button> component used by QueryBuilder.
Parameters
| Parameter | Type |
|---|---|
props | ActionProps |
Returns
Element
removeRuleAction()
removeRuleAction: (
props) =>Element=ActionElement
Default <button> component used by QueryBuilder.
Parameters
| Parameter | Type |
|---|---|
props | ActionProps |
Returns
Element
rule
rule:
MemoExoticComponent<(props) =>Element> =Rule
ruleGroup
ruleGroup:
MemoExoticComponent<(props) =>Element> =RuleGroup
ruleGroupBodyElements
ruleGroupBodyElements:
MemoExoticComponent<(rg) =>Element[]> =RuleGroupBodyComponents
ruleGroupHeaderElements
ruleGroupHeaderElements:
MemoExoticComponent<(rg) =>Element> =RuleGroupHeaderComponents
shiftActions()
shiftActions: (
props) =>Element=ShiftActions
Default "shift up"/"shift down" buttons used by QueryBuilder.
Parameters
| Parameter | Type |
|---|---|
props | ShiftActionsProps |
Returns
Element
valueEditor()
valueEditor: <
F>(allProps) =>null|Element=ValueEditor
Default valueEditor component used by QueryBuilder.
Type Parameters
| Type Parameter |
|---|
F extends FullField<string, string, string, Option<string>, Option<string>> |
Parameters
| Parameter | Type |
|---|---|
allProps | ValueEditorProps<F, string> |
Returns
null | Element
valueSelector()
valueSelector: <
Opt>(props) =>Element=ValueSelector
Default <select> component used by QueryBuilder.
Type Parameters
| Type Parameter | Default type |
|---|---|
Opt extends FullOption<string> | FullOption<string> |
Parameters
| Parameter | Type |
|---|---|
props | ValueSelectorProps<Opt> |
Returns
Element
valueSourceSelector()
valueSourceSelector: <
Opt>(props) =>Element=ValueSelector
Default <select> component used by QueryBuilder.
Type Parameters
| Type Parameter | Default type |
|---|---|
Opt extends FullOption<string> | FullOption<string> |
Parameters
| Parameter | Type |
|---|---|
props | ValueSelectorProps<Opt> |
Returns
Element
Defined in
packages/react-querybuilder/src/components/defaults.ts:15
API documentation is generated from the latest commit on the main branch. It may be somewhat inconsistent with official releases of React Query Builder.