ActionWithRulesProps
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:326
Props passed to every group action component.
Deprecated
Use ActionProps instead.
Extends
Methods
handleOnClick()
handleOnClick(
e?
:MouseEvent
<Element
,MouseEvent
>,context?
:any
):void
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:303
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
Parameter | Type |
---|---|
e? | MouseEvent <Element , MouseEvent > |
context? | any |
Returns
void
Inherited from
Properties
className?
optional
className:string
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:67
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
context?
optional
context:any
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:88
Container for custom props that are passed to all components.
Inherited from
disabled?
optional
disabled:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:83
Disables the control.
Inherited from
disabledTranslation?
optional
disabledTranslation:TranslationWithLabel
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:308
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:297
Visible text.
Inherited from
level
level:
number
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:75
The level of the current group. Always equal to path.length
.
Inherited from
path
path:
Path
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:71
Path to this subcomponent's rule/group within the query.
Inherited from
ruleOrGroup
ruleOrGroup:
RuleType
<string
,string
,any
,string
> |RuleGroupTypeAny
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:313
The RuleType or RuleGroupType/RuleGroupTypeIC associated with this element.
Inherited from
rules?
optional
rules:RuleOrGroupArray
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:317
Rules in this group (if the action element is for a group).
Inherited from
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:100
All subcomponents receive the configuration schema as a prop.
Inherited from
testID?
optional
testID:string
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:96
Test ID for this component.
Inherited from
title?
optional
title:string
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:79
The title/tooltip for this control.
Inherited from
validation?
optional
validation:boolean
|ValidationResult
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:92
Validation result of the parent rule/group.
Inherited from
API documentation is generated from the latest commit on the main
branch. It may be somewhat inconsistent with official releases of React Query Builder.