Skip to main content

MaterialActionProps

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

Extends​

Methods​

handleOnClick()​

handleOnClick(e?: MouseEvent<Element, MouseEvent>, context?: any): void

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

Triggers the action, e.g. the addition of a new rule or group. The second parameter will be forwarded to the onAddRule or onAddGroup callback if appropriate.

Parameters​

ParameterType
e?MouseEvent<Element, MouseEvent>
context?any

Returns​

void

Inherited from​

ActionProps.handleOnClick

Properties​

children?​

optional children?: ReactNode

Defined in: node_modules/@mui/material/Button/Button.d.mts:15

The content of the component.

Inherited from​

ComponentPropsWithoutRef.children

classes?​

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

Defined in: node_modules/@mui/material/Button/Button.d.mts:19

Override or extend the styles applied to the component.

Inherited from​

ComponentPropsWithoutRef.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​

ActionProps.className

color?​

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

Defined in: node_modules/@mui/material/Button/Button.d.mts:26

The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.

Default​

'primary'

Inherited from​

ComponentPropsWithoutRef.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​

ActionProps.context

disabled?​

optional disabled?: boolean

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

Disables the control.

Inherited from​

ActionProps.disabled

disabledTranslation?​

optional disabledTranslation?: TranslationWithLabel

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

Translation which overrides the regular label/title props when the element is disabled.

Inherited from​

ActionProps.disabledTranslation

disableElevation?​

optional disableElevation?: boolean

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

If true, no elevation is used.

Default​

false

Inherited from​

ComponentPropsWithoutRef.disableElevation

disableFocusRipple?​

optional disableFocusRipple?: boolean

Defined in: node_modules/@mui/material/Button/Button.d.mts:41

If true, the keyboard focus ripple is disabled.

Default​

false

Inherited from​

ComponentPropsWithoutRef.disableFocusRipple

endIcon?​

optional endIcon?: ReactNode

Defined in: node_modules/@mui/material/Button/Button.d.mts:45

Element placed after the children.

Inherited from​

ComponentPropsWithoutRef.endIcon

fullWidth?​

optional fullWidth?: boolean

Defined in: node_modules/@mui/material/Button/Button.d.mts:50

If true, the button will take up the full width of its container.

Default​

false

Inherited from​

ComponentPropsWithoutRef.fullWidth

href?​

optional href?: string

Defined in: node_modules/@mui/material/Button/Button.d.mts:55

The URL to link to when the button is clicked. If defined, an a element will be used as the root node.

Inherited from​

ComponentPropsWithoutRef.href

label?​

optional label?: ReactNode

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

Visible text.

Inherited from​

ActionProps.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​

ActionProps.level

loading?​

optional loading?: boolean | null

Defined in: node_modules/@mui/material/Button/Button.d.mts:61

If true, the loading indicator is visible and the button is disabled. If true | false, the loading wrapper is always rendered before the children to prevent Google Translation Crash.

Default​

null

Inherited from​

ComponentPropsWithoutRef.loading

loadingIndicator?​

optional loadingIndicator?: ReactNode

Defined in: node_modules/@mui/material/Button/Button.d.mts:68

Element placed before the children if the button is in loading state. The node should contain an element with role="progressbar" with an accessible name. By default, it renders a CircularProgress that is labeled by the button itself.

Default​

<CircularProgress color="inherit" size={16} />

Inherited from​

ComponentPropsWithoutRef.loadingIndicator

loadingPosition?​

optional loadingPosition?: "center" | "start" | "end"

Defined in: node_modules/@mui/material/Button/Button.d.mts:73

The loading indicator can be positioned on the start, end, or the center of the button.

Default​

'center'

Inherited from​

ComponentPropsWithoutRef.loadingPosition

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​

ActionProps.path

ruleOrGroup​

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

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

The RuleType or RuleGroupType/RuleGroupTypeIC associated with this element.

Inherited from​

MaterialActionProps.ruleOrGroup

rules?​

optional rules?: RuleOrGroupArray

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

Rules in this group (if the action element is for a group).

Inherited from​

ActionProps.rules

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​

ActionProps.schema

showInputLabels?​

optional showInputLabels?: boolean

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

Inherited from​

MuiAugmentation.showInputLabels

size?​

optional size?: OverridableStringUnion<"small" | "medium" | "large", ButtonPropsSizeOverrides>

Defined in: node_modules/@mui/material/Button/Button.d.mts:79

The size of the component. small is equivalent to the dense button styling.

Default​

'medium'

Inherited from​

ComponentPropsWithoutRef.size

startIcon?​

optional startIcon?: ReactNode

Defined in: node_modules/@mui/material/Button/Button.d.mts:83

Element placed before the children.

Inherited from​

ComponentPropsWithoutRef.startIcon

style?​

optional style?: CSSProperties

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

Inherited from​

ComponentPropsWithoutRef.style

sx?​

optional sx?: SxProps<Theme>

Defined in: node_modules/@mui/material/Button/Button.d.mts:87

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

Inherited from​

ComponentPropsWithoutRef.sx

testID?​

optional testID?: string

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

Test ID for this component.

Inherited from​

ActionProps.testID

title?​

optional title?: string

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

The title/tooltip for this control.

Inherited from​

ActionProps.title

validation?​

optional validation?: boolean | ValidationResult

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

Validation result of the parent rule/group.

Inherited from​

ActionProps.validation

variant?​

optional variant?: OverridableStringUnion<"text" | "contained" | "outlined", ButtonPropsVariantOverrides>

Defined in: node_modules/@mui/material/Button/Button.d.mts:92

The variant to use.

Default​

'text'

Inherited from​

ComponentPropsWithoutRef.variant

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.