Interface: ShiftActionsProps
react-querybuilder.ShiftActionsProps
Props passed to shiftActions components.
Hierarchy
-
↳
ShiftActionsProps
Properties
className
Optional className: string
CSS classNames to be applied.
This is string and not Classname because the Rule
and RuleGroup components run clsx() to produce the className
that gets passed to each subcomponent.
Inherited from
CommonSubComponentProps.className
Defined in
packages/react-querybuilder/src/types/props.ts:29
context
Optional context: any
Container for custom props that are passed to all components.
Inherited from
CommonSubComponentProps.context
Defined in
packages/react-querybuilder/src/types/props.ts:50
disabled
Optional disabled: boolean
Disables the control.
Inherited from
CommonSubComponentProps.disabled
Defined in
packages/react-querybuilder/src/types/props.ts:45
labels
Optional labels: Object
Visible text for "shift up"/"shift down" elements.
Type declaration
| Name | Type |
|---|---|
shiftDown? | ReactNode |
shiftUp? | ReactNode |
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:114
level
level: number
The level of the current group. Always equal to path.length.
Inherited from
Defined in
packages/react-querybuilder/src/types/props.ts:37
path
path: Path
Path to this subcomponent's rule/group within the query.
Inherited from
Defined in
packages/react-querybuilder/src/types/props.ts:33
ruleOrGroup
ruleOrGroup: RuleType<string, string, any, string> | RuleGroupTypeAny
The RuleType or RuleGroupType/RuleGroupTypeIC associated with this element.
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:123
schema
schema: Schema<FullField<string, string, string, Option<string>, Option<string>>, string>
All subcomponents receive the configuration schema as a prop.
Inherited from
CommonSubComponentProps.schema
Defined in
packages/react-querybuilder/src/types/props.ts:62
shiftDown
Optional shiftDown: () => void
Method to shift the rule/group down one place.
Type declaration
(): void
Returns
void
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:131
shiftDownDisabled
Optional shiftDownDisabled: boolean
Whether shifting the rule/group down is disallowed.
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:139
shiftUp
Optional shiftUp: () => void
Method to shift the rule/group up one place.
Type declaration
(): void
Returns
void
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:127
shiftUpDisabled
Optional shiftUpDisabled: boolean
Whether shifting the rule/group up is disallowed.
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:135
testID
Optional testID: string
Test ID for this component.
Inherited from
CommonSubComponentProps.testID
Defined in
packages/react-querybuilder/src/types/props.ts:58
title
Optional title: string
The title/tooltip for this control.
Inherited from
Defined in
packages/react-querybuilder/src/types/props.ts:41
titles
Optional titles: Object
Tooltips for "shift up"/"shift down" elements.
Type declaration
| Name | Type |
|---|---|
shiftDown? | string |
shiftUp? | string |
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:118
validation
Optional validation: boolean | ValidationResult
Validation result of the parent rule/group.
Inherited from
CommonSubComponentProps.validation