Skip to main content

AntDActionProps

Defined in: packages/antd/src/AntDActionElement.tsx:15

Extends​

  • ActionProps.RemoveDataIndexKeys<ComponentPropsWithoutRef<typeof Button>>

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​

autoInsertSpace?​

optional autoInsertSpace?: boolean

Defined in: node_modules/antd/es/button/Button.d.ts:52

Inherited from​

RemoveDataIndexKeys.autoInsertSpace

block?​

optional block?: boolean

Defined in: node_modules/antd/es/button/Button.d.ts:40

Inherited from​

RemoveDataIndexKeys.block

children?​

optional children?: ReactNode

Defined in: node_modules/antd/es/button/Button.d.ts:41

Inherited from​

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

classNames?​

optional classNames?: DeepClassNameType<{ content?: string; icon?: string; root?: string; } | undefined> | ((info: { props: BaseButtonProps; }) => DeepClassNameType<{ content?: string; icon?: string; root?: string; } | undefined>)

Defined in: node_modules/antd/es/button/Button.d.ts:43

Inherited from​

RemoveDataIndexKeys.classNames

color?​

optional color?: "default" | "danger" | "primary" | "blue" | "purple" | "cyan" | "green" | "magenta" | "pink" | "red" | "orange" | "yellow" | "volcano" | "geekblue" | "lime" | "gold"

Defined in: node_modules/antd/es/button/Button.d.ts:22

Inherited from​

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

danger?​

optional danger?: boolean

Defined in: node_modules/antd/es/button/Button.d.ts:39

Inherited from​

RemoveDataIndexKeys.danger

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

ghost?​

optional ghost?: boolean

Defined in: node_modules/antd/es/button/Button.d.ts:38

Inherited from​

RemoveDataIndexKeys.ghost

href?​

optional href?: string

Defined in: node_modules/antd/es/button/Button.d.ts:50

Inherited from​

RemoveDataIndexKeys.href

htmlType?​

optional htmlType?: "button" | "reset" | "submit"

Defined in: node_modules/antd/es/button/Button.d.ts:51

Inherited from​

RemoveDataIndexKeys.htmlType

icon?​

optional icon?: ReactNode

Defined in: node_modules/antd/es/button/Button.d.ts:24

Inherited from​

RemoveDataIndexKeys.icon

iconPlacement?​

optional iconPlacement?: "start" | "end"

Defined in: node_modules/antd/es/button/Button.d.ts:27

Inherited from​

RemoveDataIndexKeys.iconPlacement

iconPosition?​

optional iconPosition?: "start" | "end"

Defined in: node_modules/antd/es/button/Button.d.ts:26

Deprecated​

please use iconPlacement instead

Inherited from​

RemoveDataIndexKeys.iconPosition

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 | { delay?: number; icon?: ReactNode; }

Defined in: node_modules/antd/es/button/Button.d.ts:31

Inherited from​

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

prefixCls?​

optional prefixCls?: string

Defined in: node_modules/antd/es/button/Button.d.ts:35

Inherited from​

RemoveDataIndexKeys.prefixCls

rootClassName?​

optional rootClassName?: string

Defined in: node_modules/antd/es/button/Button.d.ts:37

Inherited from​

RemoveDataIndexKeys.rootClassName

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​

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

shape?​

optional shape?: "default" | "round" | "circle" | "square"

Defined in: node_modules/antd/es/button/Button.d.ts:28

Inherited from​

RemoveDataIndexKeys.shape

size?​

optional size?: SizeType

Defined in: node_modules/antd/es/button/Button.d.ts:29

Inherited from​

RemoveDataIndexKeys.size

styles?​

optional styles?: DeepStylesType<{ content?: CSSProperties; icon?: CSSProperties; root?: CSSProperties; } | undefined> | ((info: { props: BaseButtonProps; }) => DeepStylesType<{ content?: CSSProperties; icon?: CSSProperties; root?: CSSProperties; } | undefined>)

Defined in: node_modules/antd/es/button/Button.d.ts:44

Inherited from​

RemoveDataIndexKeys.styles

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

type?​

optional type?: "default" | "text" | "link" | "primary" | "dashed"

Defined in: node_modules/antd/es/button/Button.d.ts:21

Inherited from​

RemoveDataIndexKeys.type

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?: "text" | "link" | "dashed" | "outlined" | "solid" | "filled"

Defined in: node_modules/antd/es/button/Button.d.ts:23

Inherited from​

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