Skip to main content

ActionWithRulesProps

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

Props passed to every group action component.

Extends​

Extended by​

Methods​

handleOnClick()​

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

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

Call this function to trigger the action.

Parameters​

ParameterType
e?MouseEvent<Element, MouseEvent>

Returns​

void

Inherited from​

ActionProps.handleOnClick

Properties​

className?​

optional className: string

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

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/propsUsingReact.ts:111

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/propsUsingReact.ts:106

Disables the control.

Inherited from​

ActionProps.disabled

disabledTranslation?​

optional disabledTranslation: TranslationWithLabel

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

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

Inherited from​

ActionProps.disabledTranslation

label?​

optional label: ReactNode

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

Visible text.

Inherited from​

ActionProps.label

level​

level: number

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

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

Inherited from​

ActionProps.level

path​

path: Path

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

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

Inherited from​

ActionProps.path

ruleOrGroup​

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

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

The RuleType or RuleGroupType/RuleGroupTypeIC associated with this element.

Inherited from​

ActionProps.ruleOrGroup

rules?​

optional rules: RuleOrGroupArray

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

Rules already present for this group.

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?: null | InputType; 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 | ValueSourceFlexibleOptions | (operator: string) => ValueSources | ValueSourceFlexibleOptions; }, string>

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

All subcomponents receive the configuration schema as a prop.

Inherited from​

ActionProps.schema

testID?​

optional testID: string

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

Test ID for this component.

Inherited from​

ActionProps.testID

title?​

optional title: string

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

The title/tooltip for this control.

Inherited from​

ActionProps.title

validation?​

optional validation: boolean | ValidationResult

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

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.