MantineActionProps

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

Extends

• ActionWithRulesProps.Partial<ButtonProps>

Methods

handleOnClick()

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

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:269

Call this function to trigger the action.

Parameters

Parameter	Type
e?	MouseEvent<Element, MouseEvent>

Returns

void

Inherited from

ActionWithRulesProps.handleOnClick

Properties

__size?

optional __size: string

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

size property passed down the HTML element

Inherited from

Partial.__size

---

__vars?

optional __vars: CssVarsProp

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

CSS variables defined on root component element

Inherited from

Partial.__vars

---

autoContrast?

optional autoContrast: boolean

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

Determines whether button text color with filled variant should depend on background-color. If luminosity of the color prop is less than theme.luminosityThreshold, then theme.white will be used for text color, otherwise theme.black. Overrides theme.autoContrast.

Inherited from

Partial.autoContrast

---

bd?

optional bd: StyleProp<undefined | Border<string | number>>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:41

Border

Inherited from

Partial.bd

---

bg?

optional bg: StyleProp<DefaultMantineColor>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:43

Background, theme key: theme.colors

Inherited from

Partial.bg

---

bga?

optional bga: StyleProp<undefined | BackgroundAttachment>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:84

BackgroundAttachment

Inherited from

Partial.bga

---

bgp?

optional bgp: StyleProp<undefined | BackgroundPosition<string | number>>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:80

BackgroundPosition

Inherited from

Partial.bgp

---

bgr?

optional bgr: StyleProp<undefined | BackgroundRepeat>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:82

BackgroundRepeat

Inherited from

Partial.bgr

---

bgsz?

optional bgsz: StyleProp<undefined | BackgroundSize<string | number>>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:78

BackgroundSize

Inherited from

Partial.bgsz

---

bottom?

optional bottom: StyleProp<undefined | Bottom<string | number>>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:89

Inherited from

Partial.bottom

---

c?

optional c: StyleProp<DefaultMantineColor>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:45

Color

Inherited from

Partial.c

---

children?

optional children: ReactNode

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

Button content

Inherited from

Partial.children

---

className?

optional className: string

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:56

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

ActionWithRulesProps.className

---

classNames?

optional classNames: Partial<Record<ButtonStylesNames, string>> | (theme: MantineTheme, props: ButtonProps, ctx: unknown) => Partial<Record<ButtonStylesNames, string>>

Defined in: node_modules/@mantine/core/lib/core/styles-api/styles-api.types.d.ts:30

Inherited from

Partial.classNames

---

color?

optional color: DefaultMantineColor

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

Key of theme.colors or any valid CSS color, theme.primaryColor by default

Inherited from

Partial.color

---

context?

optional context: any

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:77

Container for custom props that are passed to all components.

Inherited from

ActionWithRulesProps.context

---

darkHidden?

optional darkHidden: boolean

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

Determines whether component should be hidden in dark color scheme with display: none

Inherited from

Partial.darkHidden

---

data-disabled?

optional data-disabled: boolean

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

Inherited from

Partial.data-disabled

---

disabled?

optional disabled: boolean

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:72

Disables the control.

Inherited from

ActionWithRulesProps.disabled

---

disabledTranslation?

optional disabledTranslation: TranslationWithLabel

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:274

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

Inherited from

ActionWithRulesProps.disabledTranslation

---

display?

optional display: StyleProp<undefined | Display>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:92

Inherited from

Partial.display

---

ff?

optional ff: StyleProp<"text" | string & { } | "heading" | "monospace">

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:48

FontFamily

Inherited from

Partial.ff

---

flex?

optional flex: StyleProp<undefined | Flex<string | number>>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:93

Inherited from

Partial.flex

---

fs?

optional fs: StyleProp<undefined | FontStyle>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:60

FontStyle

Inherited from

Partial.fs

---

fullWidth?

optional fullWidth: boolean

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

Determines whether button should take 100% width of its parent container, false by default

Inherited from

Partial.fullWidth

---

fw?

optional fw: StyleProp<undefined | FontWeight>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:52

FontWeight

Inherited from

Partial.fw

---

fz?

optional fz: StyleProp<number | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | MantineFontSize>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:50

FontSize, theme key: theme.fontSizes

Inherited from

Partial.fz

---

gradient?

optional gradient: MantineGradient

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

Gradient configuration used when variant="gradient", default value is theme.defaultGradient

Inherited from

Partial.gradient

---

h?

optional h: StyleProp<undefined | Height<string | number>>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:72

Height, theme key: theme.spacing

Inherited from

Partial.h

---

hiddenFrom?

optional hiddenFrom: MantineBreakpoint

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

Breakpoint above which the component is hidden with display: none

Inherited from

Partial.hiddenFrom

---

inset?

optional inset: StyleProp<undefined | Inset<string | number>>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:91

Inherited from

Partial.inset

---

justify?

optional justify: JustifyContent

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

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

Inherited from

Partial.justify

---

label?

optional label: ReactNode

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

Visible text.

Inherited from

ActionWithRulesProps.label

---

left?

optional left: StyleProp<undefined | Left<string | number>>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:88

Inherited from

Partial.left

---

leftSection?

optional leftSection: ReactNode

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

Content displayed on the left side of the button label

Inherited from

Partial.leftSection

---

level

level: number

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:64

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

Inherited from

ActionWithRulesProps.level

---

lh?

optional lh: StyleProp<number | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | MantineLineHeight>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:58

LineHeight, theme key: lineHeights

Inherited from

Partial.lh

---

lightHidden?

optional lightHidden: boolean

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

Determines whether component should be hidden in light color scheme with display: none

Inherited from

Partial.lightHidden

---

loaderProps?

optional loaderProps: LoaderProps

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

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:33

Determines whether the Loader component should be displayed over the button

Inherited from

Partial.loading

---

lts?

optional lts: StyleProp<undefined | LetterSpacing<string | number>>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:54

LetterSpacing

Inherited from

Partial.lts

---

m?

optional m: StyleProp<MantineSpacing>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:5

Margin, theme key: theme.spacing

Inherited from

Partial.m

---

mah?

optional mah: StyleProp<undefined | MaxHeight<string | number>>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:76

MaxHeight, theme key: theme.spacing

Inherited from

Partial.mah

---

maw?

optional maw: StyleProp<undefined | MaxWidth<string | number>>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:70

MaxWidth, theme key: theme.spacing

Inherited from

Partial.maw

---

mb?

optional mb: StyleProp<MantineSpacing>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:13

MarginBottom, theme key: theme.spacing

Inherited from

Partial.mb

---

me?

optional me: StyleProp<MantineSpacing>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:17

MarginInlineEnd, theme key: theme.spacing

Inherited from

Partial.me

---

mih?

optional mih: StyleProp<undefined | MinHeight<string | number>>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:74

MinHeight, theme key: theme.spacing

Inherited from

Partial.mih

---

miw?

optional miw: StyleProp<undefined | MinWidth<string | number>>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:68

MinWidth, theme key: theme.spacing

Inherited from

Partial.miw

---

ml?

optional ml: StyleProp<MantineSpacing>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:19

MarginLeft, theme key: theme.spacing

Inherited from

Partial.ml

---

mod?

optional mod: BoxMod

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

Element modifiers transformed into data- attributes, for example, { 'data-size': 'xl' }, falsy values are removed

Inherited from

Partial.mod

---

mr?

optional mr: StyleProp<MantineSpacing>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:21

MarginRight, theme key: theme.spacing

Inherited from

Partial.mr

---

ms?

optional ms: StyleProp<MantineSpacing>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:15

MarginInlineStart, theme key: theme.spacing

Inherited from

Partial.ms

---

mt?

optional mt: StyleProp<MantineSpacing>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:11

MarginTop, theme key: theme.spacing

Inherited from

Partial.mt

---

mx?

optional mx: StyleProp<MantineSpacing>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:9

MarginInline, theme key: theme.spacing

Inherited from

Partial.mx

---

my?

optional my: StyleProp<MantineSpacing>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:7

MarginBlock, theme key: theme.spacing

Inherited from

Partial.my

---

opacity?

optional opacity: StyleProp<undefined | Opacity>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:46

Inherited from

Partial.opacity

---

p?

optional p: StyleProp<MantineSpacing>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:23

Padding, theme key: theme.spacing

Inherited from

Partial.p

---

path

path: Path

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:60

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

Inherited from

ActionWithRulesProps.path

---

pb?

optional pb: StyleProp<MantineSpacing>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:31

PaddingBottom, theme key: theme.spacing

Inherited from

Partial.pb

---

pe?

optional pe: StyleProp<MantineSpacing>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:35

PaddingInlineEnd, theme key: theme.spacing

Inherited from

Partial.pe

---

pl?

optional pl: StyleProp<MantineSpacing>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:37

PaddingLeft, theme key: theme.spacing

Inherited from

Partial.pl

---

pos?

optional pos: StyleProp<undefined | Position>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:86

Position

Inherited from

Partial.pos

---

pr?

optional pr: StyleProp<MantineSpacing>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:39

PaddingRight, theme key: theme.spacing

Inherited from

Partial.pr

---

ps?

optional ps: StyleProp<MantineSpacing>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:33

PaddingInlineStart, theme key: theme.spacing

Inherited from

Partial.ps

---

pt?

optional pt: StyleProp<MantineSpacing>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:29

PaddingTop, theme key: theme.spacing

Inherited from

Partial.pt

---

px?

optional px: StyleProp<MantineSpacing>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:27

PaddingInline, theme key: theme.spacing

Inherited from

Partial.px

---

py?

optional py: StyleProp<MantineSpacing>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:25

PaddingBlock, theme key: theme.spacing

Inherited from

Partial.py

---

radius?

optional radius: MantineRadius

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

Key of theme.radius or any valid CSS value to set border-radius, theme.defaultRadius by default

Inherited from

Partial.radius

---

right?

optional right: StyleProp<undefined | Right<string | number>>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:90

Inherited from

Partial.right

---

rightSection?

optional rightSection: ReactNode

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

Content displayed on the right side of the button label

Inherited from

Partial.rightSection

---

ruleOrGroup

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

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:279

The RuleType or RuleGroupType/RuleGroupTypeIC associated with this element.

Inherited from

ActionWithRulesProps.ruleOrGroup

---

rules?

optional rules: RuleOrGroupArray

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:291

Rules already present for this group.

Inherited from

ActionWithRulesProps.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?: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; ... 9 more ...; className?: Clas..., operator: string) => boolean; defaultOperator?: string; defaultValue?: any; disabled?: boolean; id?: string; inputType?: null | InputType; label: string; name: string; operators?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; }>; placeholder?: string; validator?: RuleValidator; value: string; valueEditorType?: ValueEditorType | (operator: string) => ValueEditorType; values?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; }>; valueSources?: ValueSources | (operator: string) => ValueSources; }, string>

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:89

All subcomponents receive the configuration schema as a prop.

Inherited from

ActionWithRulesProps.schema

---

size?

optional size: string & { } | MantineSize | "compact-xs" | "compact-sm" | "compact-md" | "compact-lg" | "compact-xl"

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

Controls button height, font-size and horizontal padding, 'sm' by default

Inherited from

Partial.size

---

style?

optional style: MantineStyleProp

Defined in: node_modules/@mantine/core/lib/core/Box/Box.d.ts:10

Inline style added to root component element, can subscribe to theme defined on MantineProvider

Inherited from

Partial.style

---

styles?

optional styles: Partial<Record<ButtonStylesNames, CSSProperties>> | (theme: MantineTheme, props: ButtonProps, ctx: unknown) => Partial<Record<ButtonStylesNames, CSSProperties>>

Defined in: node_modules/@mantine/core/lib/core/styles-api/styles-api.types.d.ts:31

Inherited from

Partial.styles

---

ta?

optional ta: StyleProp<undefined | TextAlign>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:56

TextAlign

Inherited from

Partial.ta

---

td?

optional td: StyleProp<undefined | TextDecoration<string | number>>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:64

TextDecoration

Inherited from

Partial.td

---

testID?

optional testID: string

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:85

Test ID for this component.

Inherited from

ActionWithRulesProps.testID

---

title?

optional title: string

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:68

The title/tooltip for this control.

Inherited from

ActionWithRulesProps.title

---

top?

optional top: StyleProp<undefined | Top<string | number>>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:87

Inherited from

Partial.top

---

tt?

optional tt: StyleProp<undefined | TextTransform>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:62

TextTransform

Inherited from

Partial.tt

---

unstyled?

optional unstyled: boolean

Defined in: node_modules/@mantine/core/lib/core/styles-api/styles-api.types.d.ts:28

Inherited from

Partial.unstyled

---

validation?

optional validation: boolean | ValidationResult

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:81

Validation result of the parent rule/group.

Inherited from

ActionWithRulesProps.validation

---

variant?

optional variant: string & { } | ButtonVariant

Defined in: node_modules/@mantine/core/lib/core/styles-api/styles-api.types.d.ts:29

Inherited from

Partial.variant

---

vars?

optional vars: PartialVarsResolver<{ defaultComponent: "button"; defaultRef: HTMLButtonElement; props: ButtonProps; staticComponents: { Group: MantineComponent<{ props: ButtonGroupProps; ref: HTMLDivElement; stylesNames: "group"; vars: ButtonGroupCssVariables; }>; GroupSection: MantineComponent<{ props: ButtonGroupSectionProps; ref: HTMLDivElement; stylesNames: "groupSection"; variant: ButtonVariant; vars: ButtonGroupSectionCssVariables; }>; }; stylesNames: ButtonStylesNames; variant: ButtonVariant; vars: ButtonCssVariables; }>

Defined in: node_modules/@mantine/core/lib/core/styles-api/styles-api.types.d.ts:32

Inherited from

Partial.vars

---

visibleFrom?

optional visibleFrom: MantineBreakpoint

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

Breakpoint below which the component is hidden with display: none

Inherited from

Partial.visibleFrom

---

w?

optional w: StyleProp<undefined | Width<string | number>>

Defined in: node_modules/@mantine/core/lib/core/Box/style-props/style-props.types.d.ts:66

Width, theme key: theme.spacing

Inherited from

Partial.w

---

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.