Skip to main content

MaterialDragHandleProps

Defined in: packages/material/src/MaterialDragHandle.tsx:13

Extends​

Properties​

children?​

optional children?: ReactNode

Defined in: node_modules/@mui/material/SvgIcon/SvgIcon.d.mts:13

Node passed into the SVG element.

Inherited from​

Omit.children

classes?​

optional classes?: Partial<SvgIconClasses> & Partial<ClassNameMap<never>>

Defined in: node_modules/@mui/material/SvgIcon/SvgIcon.d.mts:17

Override or extend the styles applied to the component.

Inherited from​

Omit.classes

className?​

optional className?: string

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

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​

MaterialActionProps.className

color?​

optional color?: OverridableStringUnion<"error" | "info" | "disabled" | "action" | "inherit" | "secondary" | "primary" | "success" | "warning", SvgIconPropsColorOverrides>

Defined in: node_modules/@mui/material/SvgIcon/SvgIcon.d.mts:25

The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide. You can use the htmlColor prop to apply a color attribute to the SVG element.

Default​

'inherit'

Inherited from​

Omit.color

context?​

optional context?: any

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

Container for custom props that are passed to all components.

Inherited from​

MaterialActionProps.context

disabled?​

optional disabled?: boolean

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

Disables the control.

Inherited from​

MaterialActionProps.disabled

dragHandleAttributes?​

optional dragHandleAttributes?: HTMLAttributes<HTMLElement>

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

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.

Inherited from​

DragHandleProps.dragHandleAttributes

fontSize?​

optional fontSize?: OverridableStringUnion<"small" | "inherit" | "medium" | "large", SvgIconPropsSizeOverrides>

Defined in: node_modules/@mui/material/SvgIcon/SvgIcon.d.mts:30

The fontSize applied to the icon. Defaults to 24px, but can be configure to inherit font size.

Default​

'medium'

Inherited from​

Omit.fontSize

htmlColor?​

optional htmlColor?: string

Defined in: node_modules/@mui/material/SvgIcon/SvgIcon.d.mts:34

Applies a color attribute to the SVG element.

Inherited from​

Omit.htmlColor

inheritViewBox?​

optional inheritViewBox?: boolean

Defined in: node_modules/@mui/material/SvgIcon/SvgIcon.d.mts:42

If true, the root node will inherit the custom component's viewBox and the viewBox prop will be ignored. Useful when you want to reference a custom component and have SvgIcon pass that component's viewBox to the root node.

Default​

false

Inherited from​

Omit.inheritViewBox

label?​

optional label?: ReactNode

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

Inherited from​

DragHandleProps.label

level​

level: number

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

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

Inherited from​

MaterialActionProps.level

muiComponents?​

optional muiComponents?: RQBMaterialComponents

Defined in: packages/material/src/types.ts:60

Inherited from​

MuiAugmentation.muiComponents

path​

path: Path

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

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

Inherited from​

MaterialActionProps.path

ruleOrGroup​

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

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

Inherited from​

MaterialDragHandleProps.ruleOrGroup

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 | [FlexibleOption, ...FlexibleOption[]] | ((operator: string) => ValueSources | [FlexibleOption, ...FlexibleOption[]]); }, string>

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

All subcomponents receive the configuration schema as a prop.

Inherited from​

DragHandleProps.schema

shapeRendering?​

optional shapeRendering?: string

Defined in: node_modules/@mui/material/SvgIcon/SvgIcon.d.mts:48

The shape-rendering attribute. The behavior of the different options is described on the MDN Web Docs. If you are having issues with blurry icons you should investigate this prop.

Inherited from​

Omit.shapeRendering

showInputLabels?​

optional showInputLabels?: boolean

Defined in: packages/material/src/types.ts:61

Inherited from​

MuiAugmentation.showInputLabels

style?​

optional style?: CSSProperties

Defined in: node_modules/@mui/material/OverridableComponent/index.d.mts:36

Inherited from​

Omit.style

sx?​

optional sx?: SxProps<Theme>

Defined in: node_modules/@mui/material/SvgIcon/SvgIcon.d.mts:52

The system prop that allows defining system overrides as well as additional CSS styles.

Inherited from​

Omit.sx

testID?​

optional testID?: string

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

Test ID for this component.

Inherited from​

MaterialActionProps.testID

title?​

optional title?: string

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

The title/tooltip for this control.

Inherited from​

MaterialActionProps.title

titleAccess?​

optional titleAccess?: string

Defined in: node_modules/@mui/material/SvgIcon/SvgIcon.d.mts:57

Provides a human-readable title for the element that contains it. https://www.w3.org/TR/SVG-access/#Equivalent

Inherited from​

Omit.titleAccess

validation?​

optional validation?: boolean | ValidationResult

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

Validation result of the parent rule/group.

Inherited from​

MaterialActionProps.validation

viewBox?​

optional viewBox?: string

Defined in: node_modules/@mui/material/SvgIcon/SvgIcon.d.mts:66

Allows you to redefine what the coordinates without units mean inside an SVG element. For example, if the SVG element is 500 (width) by 200 (height), and you pass viewBox="0 0 50 20", this means that the coordinates inside the SVG will go from the top left corner (0,0) to bottom right (50,20) and each unit will be worth 10px.

Default​

'0 0 24 24'

Inherited from​

Omit.viewBox

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.