Skip to main content

ShiftActionsREProps

Defined in: rules-engine/src/components/ShiftActionsRE.ts:8

Extends​

Properties​

className?​

optional className?: string

Defined in: react-querybuilder/src/types/props.ts:75

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​

Omit.className

context?​

optional context?: any

Defined in: react-querybuilder/src/types/props.ts:96

Container for custom props that are passed to all components.

Inherited from​

Omit.context

disabled?​

optional disabled?: boolean

Defined in: react-querybuilder/src/types/props.ts:91

Disables the control.

Inherited from​

Omit.disabled

labels?​

optional labels?: { shiftDown?: ReactNode; shiftUp?: ReactNode; }

Defined in: react-querybuilder/src/types/props.ts:320

Visible text for "shift up"/"shift down" elements.

shiftDown?​

optional shiftDown?: ReactNode

shiftUp?​

optional shiftUp?: ReactNode

Inherited from​

Omit.labels

level​

level: number

Defined in: react-querybuilder/src/types/props.ts:83

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

Inherited from​

Omit.level

path​

path: Path

Defined in: react-querybuilder/src/types/props.ts:79

Path to this subcomponent's rule/group within the query.

Inherited from​

Omit.path

schema​

schema: SchemaRE

Defined in: rules-engine/src/components/ShiftActionsRE.ts:9

shiftDown?​

optional shiftDown?: () => void

Defined in: react-querybuilder/src/types/props.ts:337

Method to shift the rule/group down one place.

Returns​

void

Inherited from​

Omit.shiftDown

shiftDownDisabled?​

optional shiftDownDisabled?: boolean

Defined in: react-querybuilder/src/types/props.ts:345

Whether shifting the rule/group down is disallowed.

Inherited from​

Omit.shiftDownDisabled

shiftUp?​

optional shiftUp?: () => void

Defined in: react-querybuilder/src/types/props.ts:333

Method to shift the rule/group up one place.

Returns​

void

Inherited from​

Omit.shiftUp

shiftUpDisabled?​

optional shiftUpDisabled?: boolean

Defined in: react-querybuilder/src/types/props.ts:341

Whether shifting the rule/group up is disallowed.

Inherited from​

Omit.shiftUpDisabled

testID?​

optional testID?: string

Defined in: react-querybuilder/src/types/props.ts:104

Test ID for this component.

Inherited from​

Omit.testID

title?​

optional title?: string

Defined in: react-querybuilder/src/types/props.ts:87

The title/tooltip for this control.

Inherited from​

Omit.title

titles?​

optional titles?: { shiftDown?: string; shiftUp?: string; }

Defined in: react-querybuilder/src/types/props.ts:324

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

shiftDown?​

optional shiftDown?: string

shiftUp?​

optional shiftUp?: string

Inherited from​

Omit.titles

validation?​

optional validation?: boolean | ValidationResult

Defined in: react-querybuilder/src/types/props.ts:100

Validation result of the parent rule/group.

Inherited from​

Omit.validation

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.