ChakraNotToggleProps

Defined in: packages/chakra/src/ChakraNotToggle.tsx:9

Extends

• NotToggleProps.Omit<SwitchProps, "label">

Methods

handleOnChange()

handleOnChange(checked: boolean): void

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

Parameters

Parameter	Type
checked	boolean

Returns

void

Inherited from

NotToggleProps.handleOnChange

Properties

as?

optional as?: ElementType

Defined in: node_modules/@chakra-ui/react/dist/types/styled-system/factory.types.d.ts:14

Inherited from

Omit.as

---

asChild?

optional asChild?: boolean

Defined in: node_modules/@ark-ui/react/dist/components/factory.d.ts:6

Use the provided child element as the default rendered element, combining their props and behavior.

Inherited from

Omit.asChild

---

checked?

optional checked?: boolean

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

Inherited from

NotToggleProps.checked

---

className?

optional className?: string

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

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

NotToggleProps.className

---

context?

optional context?: any

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

Container for custom props that are passed to all components.

Inherited from

NotToggleProps.context

---

css?

optional css?: SystemStyleObject | Omit<(SystemStyleObject | undefined)[], keyof any[]>

Defined in: node_modules/@chakra-ui/react/dist/types/styled-system/factory.types.d.ts:49

Inherited from

Omit.css

---

defaultChecked?

optional defaultChecked?: boolean

Defined in: node_modules/@zag-js/switch/dist/switch.types.d.mts:51

The initial checked state of the switch when rendered. Use when you don't need to control the checked state of the switch.

Inherited from

Omit.defaultChecked

---

disabled?

optional disabled?: boolean

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

Disables the control.

Inherited from

NotToggleProps.disabled

---

form?

optional form?: string

Defined in: node_modules/@zag-js/switch/dist/switch.types.d.mts:60

The id of the form that the switch belongs to

Inherited from

Omit.form

---

htmlContent?

optional htmlContent?: string

Defined in: node_modules/@chakra-ui/react/dist/types/styled-system/factory.types.d.ts:22

Inherited from

Omit.htmlContent

---

htmlHeight?

optional htmlHeight?: string | number

Defined in: node_modules/@chakra-ui/react/dist/types/styled-system/factory.types.d.ts:20

Inherited from

Omit.htmlHeight

---

htmlSize?

optional htmlSize?: number

Defined in: node_modules/@chakra-ui/react/dist/types/styled-system/factory.types.d.ts:18

Inherited from

Omit.htmlSize

---

htmlTranslate?

optional htmlTranslate?: "yes" | "no"

Defined in: node_modules/@chakra-ui/react/dist/types/styled-system/factory.types.d.ts:21

Inherited from

Omit.htmlTranslate

---

htmlWidth?

optional htmlWidth?: string | number

Defined in: node_modules/@chakra-ui/react/dist/types/styled-system/factory.types.d.ts:19

Inherited from

Omit.htmlWidth

---

id?

optional id?: string

Defined in: node_modules/@zag-js/types/dist/index.d.mts:41

The unique identifier of the machine.

Inherited from

Omit.id

---

ids?

optional ids?: Partial<{ control: string; hiddenInput: string; label: string; root: string; thumb: string; }>

Defined in: node_modules/@zag-js/switch/dist/switch.types.d.mts:18

The ids of the elements in the switch. Useful for composition.

Inherited from

Omit.ids

---

inputProps?

optional inputProps?: InputHTMLAttributes<HTMLInputElement>

Defined in: packages/chakra/src/snippets/switch.tsx:5

Inherited from

Omit.inputProps

---

invalid?

optional invalid?: boolean

Defined in: node_modules/@zag-js/switch/dist/switch.types.d.mts:30

If true, the switch is marked as invalid.

Inherited from

Omit.invalid

---

label?

optional label?: ReactNode

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

Inherited from

NotToggleProps.label

---

level

level: number

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

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

Inherited from

NotToggleProps.level

---

name?

optional name?: string

Defined in: node_modules/@zag-js/switch/dist/switch.types.d.mts:56

The name of the input field in a switch (Useful for form submission).

Inherited from

Omit.name

---

onCheckedChange?

optional onCheckedChange?: (details: CheckedChangeDetails) => void

Defined in: node_modules/@zag-js/switch/dist/switch.types.d.mts:42

Function to call when the switch is clicked.

Parameters

Parameter	Type
details	CheckedChangeDetails

Returns

void

Inherited from

Omit.onCheckedChange

---

path

path: Path

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

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

Inherited from

NotToggleProps.path

---

readOnly?

optional readOnly?: boolean

Defined in: node_modules/@zag-js/switch/dist/switch.types.d.mts:38

Whether the switch is read-only

Inherited from

Omit.readOnly

---

recipe?

optional recipe?: SlotRecipeDefinition<string, SlotRecipeVariantRecord<string>>

Defined in: node_modules/@chakra-ui/react/dist/types/styled-system/generated/recipes.gen.d.ts:1702

Inherited from

Omit.recipe

---

required?

optional required?: boolean

Defined in: node_modules/@zag-js/switch/dist/switch.types.d.mts:34

If true, the switch input is marked as required,

Inherited from

Omit.required

---

rootRef?

optional rootRef?: Ref<HTMLLabelElement>

Defined in: packages/chakra/src/snippets/switch.tsx:6

Inherited from

Omit.rootRef

---

ruleGroup

ruleGroup: RuleGroupTypeAny

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

Inherited from

NotToggleProps.ruleGroup

---

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

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

All subcomponents receive the configuration schema as a prop.

Inherited from

NotToggleProps.schema

---

size?

optional size?: ConditionalValue<"sm" | "md" | "lg" | "xs" | undefined>

Defined in: node_modules/@chakra-ui/react/dist/types/styled-system/generated/recipes.gen.d.ts:1286

Default

"md"

Inherited from

Omit.size

---

testID?

optional testID?: string

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

Test ID for this component.

Inherited from

NotToggleProps.testID

---

thumbLabel?

optional thumbLabel?: { off: ReactNode; on: ReactNode; }

Defined in: packages/chakra/src/snippets/switch.tsx:8

off

off: ReactNode

on

on: ReactNode

Inherited from

Omit.thumbLabel

---

title?

optional title?: string

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

The title/tooltip for this control.

Inherited from

NotToggleProps.title

---

trackLabel?

optional trackLabel?: { off: ReactNode; on: ReactNode; }

Defined in: packages/chakra/src/snippets/switch.tsx:7

off

off: ReactNode

on

on: ReactNode

Inherited from

Omit.trackLabel

---

unstyled?

optional unstyled?: boolean

Defined in: node_modules/@chakra-ui/react/dist/types/styled-system/factory.types.d.ts:11

If true, the element will opt out of the theme styles.

Inherited from

Omit.unstyled

---

validation?

optional validation?: boolean | ValidationResult

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

Validation result of the parent rule/group.

Inherited from

NotToggleProps.validation

---

value?

optional value?: string | number

Defined in: node_modules/@zag-js/switch/dist/switch.types.d.mts:65

The value of switch input. Useful for form submission.

Default

"on"

Inherited from

Omit.value

---

variant?

optional variant?: ConditionalValue<"solid" | "raised" | undefined>

Defined in: node_modules/@chakra-ui/react/dist/types/styled-system/generated/recipes.gen.d.ts:1284

Default

"solid"

Inherited from

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