Skip to main content

DragHandleProps

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

Props for dragHandle components.

Extends​

Extended by​

Properties​

className?​

optional className?: string

Defined in: packages/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​

CommonSubComponentProps.className

context?​

optional context?: any

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

Container for custom props that are passed to all components.

Inherited from​

CommonSubComponentProps.context

disabled?​

optional disabled?: boolean

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

Disables the control.

Inherited from​

CommonSubComponentProps.disabled

dragHandleAttributes?​

optional dragHandleAttributes?: HTMLAttributes<HTMLElement>

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

Props to spread onto the drag handle element, supplied by the active drag-and-drop adapter (e.g. ARIA attributes and sensor event listeners). Custom dragHandle components should spread these onto the same element that receives the forwarded ref.

label?​

optional label?: ReactNode

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

level​

level: number

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

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

Inherited from​

CommonSubComponentProps.level

path​

path: Path

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

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

Inherited from​

CommonSubComponentProps.path

ruleOrGroup​

ruleOrGroup: RuleType<string, string, any, string, Record<string, any>> | RuleGroupTypeAny

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

schema​

schema: Schema<{[key: string]: unknown; className?: Classname; comparator?: string | ((f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string | FlexibleOpt..., operator: string) => boolean); defaultOperator?: string; defaultValue?: any; disabled?: boolean; id?: string; inputType?: InputType | null; label: string; matchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]; name: string; operators?: string[] | FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }> | FlexibleOption<string>[] | string | FlexibleOption<string>[]; placeholder?: string; subproperties?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string | FlexibleOpt...>; validator?: RuleValidator; value: string; valueEditorType?: ValueEditorType | ((operator: string) => ValueEditorType); values?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; valueSources?: ValueSources | ValueSourceFlexibleOptions | ((operator: string) => ValueSources | ValueSourceFlexibleOptions); }, string>

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

All subcomponents receive the configuration schema as a prop.

Inherited from​

CommonSubComponentProps.schema

testID?​

optional testID?: string

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

Test ID for this component.

Inherited from​

CommonSubComponentProps.testID

title?​

optional title?: string

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

The title/tooltip for this control.

Inherited from​

CommonSubComponentProps.title

validation?​

optional validation?: boolean | ValidationResult

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

Validation result of the parent rule/group.

Inherited from​

CommonSubComponentProps.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.