Skip to main content

MantineActionProps

Defined in: packages/mantine/src/MantineActionElement.tsx:9

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​

autoContrast?​

optional autoContrast?: boolean

Defined in: node_modules/@mantine/core/lib/components/Button/Button.d.ts:38

If set, adjusts text color based on background color for filled variant

Inherited from​

Partial.autoContrast

children?​

optional children?: ReactNode

Defined in: node_modules/@mantine/core/lib/components/Button/Button.d.ts:32

Button content

Inherited from​

Partial.children

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?: DefaultMantineColor

Defined in: node_modules/@mantine/core/lib/components/Button/Button.d.ts:16

Key of theme.colors or any valid CSS color

Default​

theme.primaryColor

Inherited from​

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

data-disabled?​

optional data-disabled?: boolean

Defined in: node_modules/@mantine/core/lib/components/Button/Button.d.ts:12

Inherited from​

Partial.data-disabled

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

fullWidth?​

optional fullWidth?: boolean

Defined in: node_modules/@mantine/core/lib/components/Button/Button.d.ts:24

Sets width: 100%

Default​

false

Inherited from​

Partial.fullWidth

gradient?​

optional gradient?: MantineGradient

Defined in: node_modules/@mantine/core/lib/components/Button/Button.d.ts:28

Gradient configuration used for variant="gradient"

Default​

theme.defaultGradient

Inherited from​

Partial.gradient

justify?​

optional justify?: JustifyContent

Defined in: node_modules/@mantine/core/lib/components/Button/Button.d.ts:18

Sets justify-content of inner element, can be used to change distribution of sections and label

Default​

'center'

Inherited from​

Partial.justify

label?​

optional label?: ReactNode

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

Visible text.

Inherited from​

ActionProps.label

leftSection?​

optional leftSection?: ReactNode

Defined in: node_modules/@mantine/core/lib/components/Button/Button.d.ts:20

Content on the left side of the button label

Inherited from​

Partial.leftSection

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

loaderProps?​

optional loaderProps?: LoaderProps

Defined in: node_modules/@mantine/core/lib/components/Button/Button.d.ts:36

Props added to the Loader component (only visible when loading prop is set)

Inherited from​

Partial.loaderProps

loading?​

optional loading?: boolean

Defined in: node_modules/@mantine/core/lib/components/Button/Button.d.ts:34

If set, the Loader component is displayed over the button

Inherited from​

Partial.loading

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

radius?​

optional radius?: MantineRadius

Defined in: node_modules/@mantine/core/lib/components/Button/Button.d.ts:26

Key of theme.radius or any valid CSS value to set border-radius

Default​

theme.defaultRadius

Inherited from​

Partial.radius

rightSection?​

optional rightSection?: ReactNode

Defined in: node_modules/@mantine/core/lib/components/Button/Button.d.ts:22

Content on the right side of the button label

Inherited from​

Partial.rightSection

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​

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

size?​

optional size?: ButtonSize

Defined in: node_modules/@mantine/core/lib/components/Button/Button.d.ts:14

Controls button height, font-size and horizontal padding

Default​

'sm'

Inherited from​

Partial.size

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

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.