Skip to main content

ShiftActionsProps

Props passed to shiftActions components.

Extends

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.

shiftDown?

optional shiftDown: ReactNode

shiftUp?

optional shiftUp: ReactNode

Defined in

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


level

level: number

The level of the current group. Always equal to path.length.

Inherited from

CommonSubComponentProps.level

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

CommonSubComponentProps.path

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


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.

Returns

void

Defined in

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


shiftDownDisabled?

optional shiftDownDisabled: boolean

Whether shifting the rule/group down is disallowed.

Defined in

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


shiftUp()?

optional shiftUp: () => void

Method to shift the rule/group up one place.

Returns

void

Defined in

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


shiftUpDisabled?

optional shiftUpDisabled: boolean

Whether shifting the rule/group up is disallowed.

Defined in

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


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

CommonSubComponentProps.title

Defined in

packages/react-querybuilder/src/types/props.ts:41


titles?

optional titles: object

Tooltips for "shift up"/"shift down" elements.

shiftDown?

optional shiftDown: string

shiftUp?

optional shiftUp: string

Defined in

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


validation?

optional validation: boolean | ValidationResult

Validation result of the parent rule/group.

Inherited from

CommonSubComponentProps.validation

Defined in

packages/react-querybuilder/src/types/props.ts:54


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.