Skip to main content

ChakraActionProps

Defined in: packages/chakra/src/ChakraActionElement.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​

as?​

optional as?: ElementType

Defined in: node_modules/@chakra-ui/react/dist/types/styled-system/factory.types.d.ts:14

Inherited from​

ComponentPropsWithoutRef.as

asChild?​

optional asChild?: boolean

Defined in: node_modules/@chakra-ui/react/dist/types/styled-system/factory.types.d.ts:15

Inherited from​

ComponentPropsWithoutRef.asChild

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

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

css?​

optional css?: SystemStyleObject | Omit<(SystemStyleObject | undefined)[], keyof any[]>

Defined in: node_modules/@chakra-ui/react/dist/types/styled-system/factory.types.d.ts:49

Inherited from​

ComponentPropsWithoutRef.css

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

htmlContent?​

optional htmlContent?: string

Defined in: node_modules/@chakra-ui/react/dist/types/styled-system/factory.types.d.ts:22

Inherited from​

ComponentPropsWithoutRef.htmlContent

htmlHeight?​

optional htmlHeight?: string | number

Defined in: node_modules/@chakra-ui/react/dist/types/styled-system/factory.types.d.ts:20

Inherited from​

ComponentPropsWithoutRef.htmlHeight

htmlSize?​

optional htmlSize?: number

Defined in: node_modules/@chakra-ui/react/dist/types/styled-system/factory.types.d.ts:18

Inherited from​

ComponentPropsWithoutRef.htmlSize

htmlTranslate?​

optional htmlTranslate?: "yes" | "no"

Defined in: node_modules/@chakra-ui/react/dist/types/styled-system/factory.types.d.ts:21

Inherited from​

ComponentPropsWithoutRef.htmlTranslate

htmlWidth?​

optional htmlWidth?: string | number

Defined in: node_modules/@chakra-ui/react/dist/types/styled-system/factory.types.d.ts:19

Inherited from​

ComponentPropsWithoutRef.htmlWidth

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

Defined in: node_modules/@chakra-ui/react/dist/types/components/button/button.d.ts:7

If true, the button will show a loading spinner.

Default​

false

Inherited from​

ComponentPropsWithoutRef.loading

loadingText?​

optional loadingText?: ReactNode

Defined in: node_modules/@chakra-ui/react/dist/types/components/button/button.d.ts:11

The text to show while loading.

Inherited from​

ComponentPropsWithoutRef.loadingText

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

recipe?​

optional recipe?: RecipeDefinition<RecipeVariantRecord>

Defined in: node_modules/@chakra-ui/react/dist/types/styled-system/generated/recipes.gen.d.ts:1727

Inherited from​

ComponentPropsWithoutRef.recipe

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​

ChakraActionProps.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?: ConditionalValue<"sm" | "md" | "lg" | "xl" | "2xl" | "2xs" | "xs" | undefined>

Defined in: node_modules/@chakra-ui/react/dist/types/styled-system/generated/recipes.gen.d.ts:21

Default​

"md"

Inherited from​

ComponentPropsWithoutRef.size

spinner?​

optional spinner?: ReactNode

Defined in: node_modules/@chakra-ui/react/dist/types/components/button/button.d.ts:15

The spinner to show while loading.

Inherited from​

ComponentPropsWithoutRef.spinner

spinnerPlacement?​

optional spinnerPlacement?: "end" | "start"

Defined in: node_modules/@chakra-ui/react/dist/types/components/button/button.d.ts:20

The placement of the spinner

Default​

"start"

Inherited from​

ComponentPropsWithoutRef.spinnerPlacement

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

unstyled?​

optional unstyled?: boolean

Defined in: node_modules/@chakra-ui/react/dist/types/styled-system/factory.types.d.ts:11

If true, the element will opt out of the theme styles.

Inherited from​

ComponentPropsWithoutRef.unstyled

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?: ConditionalValue<"outline" | "solid" | "subtle" | "surface" | "ghost" | "plain" | undefined>

Defined in: node_modules/@chakra-ui/react/dist/types/styled-system/generated/recipes.gen.d.ts:23

Default​

"solid"

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.