NotToggleProps

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

Props for notToggle components.

Extends

• CommonSubComponentProps

Properties

checked?

optional checked: boolean

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

---

className?

optional className: string

Defined in: packages/react-querybuilder/src/types/props.ts:29

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

CommonSubComponentProps.className

---

context?

optional context: any

Defined in: packages/react-querybuilder/src/types/props.ts:50

Container for custom props that are passed to all components.

Inherited from

CommonSubComponentProps.context

---

disabled?

optional disabled: boolean

Defined in: packages/react-querybuilder/src/types/props.ts:45

Disables the control.

Inherited from

CommonSubComponentProps.disabled

---

label?

optional label: ReactNode

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

---

level

level: number

Defined in: packages/react-querybuilder/src/types/props.ts:37

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

Inherited from

CommonSubComponentProps.level

---

path

path: Path

Defined in: packages/react-querybuilder/src/types/props.ts:33

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

Inherited from

CommonSubComponentProps.path

---

ruleGroup

ruleGroup: RuleGroupTypeAny

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

---

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?: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; ... 9 more ...; className?: Clas..., operator: string) => boolean; defaultOperator: string; defaultValue: any; disabled: boolean; id: string; inputType: null | InputType; label: string; name: string; operators: FlexibleOptionList<{ [key: string]: unknown; disabled: boolean; label: string; name: string; value: string; }>; placeholder: string; validator: RuleValidator; value: string; valueEditorType: ValueEditorType | (operator: string) => ValueEditorType; values: FlexibleOptionList<{ [key: string]: unknown; disabled: boolean; label: string; name: string; value: string; }>; valueSources: ValueSources | (operator: string) => ValueSources; }, string>

Defined in: packages/react-querybuilder/src/types/props.ts:62

All subcomponents receive the configuration schema as a prop.

Inherited from

CommonSubComponentProps.schema

---

testID?

optional testID: string

Defined in: packages/react-querybuilder/src/types/props.ts:58

Test ID for this component.

Inherited from

CommonSubComponentProps.testID

---

title?

optional title: string

Defined in: packages/react-querybuilder/src/types/props.ts:41

The title/tooltip for this control.

Inherited from

CommonSubComponentProps.title

---

validation?

optional validation: boolean | ValidationResult

Defined in: packages/react-querybuilder/src/types/props.ts:54

Validation result of the parent rule/group.

Inherited from

CommonSubComponentProps.validation

Methods

handleOnChange()

handleOnChange(checked: boolean): void

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

Parameters

Parameter	Type
checked	boolean

Returns

void

---

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.