Interface: ActionWithRulesProps
react-querybuilder.ActionWithRulesProps
Props passed to every group action component.
Hierarchy
-
↳
ActionWithRulesProps
Properties
className
Optional className: string
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
Defined in
packages/react-querybuilder/src/types/props.ts:29
context
Optional context: any
Container for custom props that are passed to all components.
Inherited from
Defined in
packages/react-querybuilder/src/types/props.ts:50
disabled
Optional disabled: boolean
Disables the control.
Inherited from
Defined in
packages/react-querybuilder/src/types/props.ts:45
disabledTranslation
Optional disabledTranslation: TranslationWithLabel
Translation which overrides the regular label/title props when
the element is disabled.
Inherited from
ActionProps.disabledTranslation
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:67
label
Optional label: ReactNode
Visible text.
Inherited from
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:60
level
level: number
The level of the current group. Always equal to path.length.
Inherited from
Defined in
packages/react-querybuilder/src/types/props.ts:37
path
path: Path
Path to this subcomponent's rule/group within the query.
Inherited from
Defined in
packages/react-querybuilder/src/types/props.ts:33
ruleOrGroup
ruleOrGroup: RuleType<string, string, any, string> | RuleGroupTypeAny
The RuleType or RuleGroupType/RuleGroupTypeIC associated with this element.
Inherited from
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:72
rules
Optional rules: RuleOrGroupArray
Rules already present for this group.
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:82
schema
schema: Schema<FullField<string, string, string, Option<string>, Option<string>>, string>
All subcomponents receive the configuration schema as a prop.
Inherited from
Defined in
packages/react-querybuilder/src/types/props.ts:62
testID
Optional testID: string
Test ID for this component.
Inherited from
Defined in
packages/react-querybuilder/src/types/props.ts:58
title
Optional title: string
The title/tooltip for this control.
Inherited from
Defined in
packages/react-querybuilder/src/types/props.ts:41
validation
Optional validation: boolean | ValidationResult
Validation result of the parent rule/group.
Inherited from
Defined in
packages/react-querybuilder/src/types/props.ts:54
Methods
handleOnClick
handleOnClick(e?): void
Call this function to trigger the action.
Parameters
| Name | Type |
|---|---|
e? | MouseEvent<Element, MouseEvent> |
Returns
void