MantineNotToggleProps
Defined in: packages/mantine/src/MantineNotToggle.tsx:9
Extends
NotToggleProps.Partial<SwitchProps>
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
Properties
checked?
optionalchecked?:boolean
Defined in: packages/react-querybuilder/src/types/props.ts:305
Inherited from
className?
optionalclassName?: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
color?
optionalcolor?:DefaultMantineColor
Defined in: node_modules/@mantine/core/lib/components/Switch/Switch.d.ts:18
Key of theme.colors or any valid CSS color to set input color in checked state
Default
theme.primaryColor
Inherited from
Partial.color
context?
optionalcontext?:any
Defined in: packages/react-querybuilder/src/types/props.ts:96
Container for custom props that are passed to all components.
Inherited from
description?
optionaldescription?:ReactNode
Defined in: node_modules/@mantine/core/lib/components/Switch/Switch.d.ts:30
Description displayed below the label
Inherited from
Partial.description
disabled?
optionaldisabled?:boolean
Defined in: packages/react-querybuilder/src/types/props.ts:91
Disables the control.
Inherited from
error?
optionalerror?:ReactNode
Defined in: node_modules/@mantine/core/lib/components/Switch/Switch.d.ts:32
Error displayed below the label
Inherited from
Partial.error
id?
optionalid?:string
Defined in: node_modules/@mantine/core/lib/components/Switch/Switch.d.ts:10
Id used to bind input and label, if not passed, unique id will be generated instead
Inherited from
Partial.id
label?
optionallabel?:ReactNode
Defined in: packages/react-querybuilder/src/types/props.ts:307
Inherited from
labelPosition?
optionallabelPosition?:"left"|"right"
Defined in: node_modules/@mantine/core/lib/components/Switch/Switch.d.ts:28
Position of the label relative to the input
Default
'right'
Inherited from
Partial.labelPosition
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
offLabel?
optionaloffLabel?:ReactNode
Defined in: node_modules/@mantine/core/lib/components/Switch/Switch.d.ts:14
Inner label when the Switch is in unchecked state
Inherited from
Partial.offLabel
onLabel?
optionalonLabel?:ReactNode
Defined in: node_modules/@mantine/core/lib/components/Switch/Switch.d.ts:16
Inner label when the Switch is in checked state
Inherited from
Partial.onLabel
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
radius?
optionalradius?:MantineRadius
Defined in: node_modules/@mantine/core/lib/components/Switch/Switch.d.ts:22
Key of theme.radius or any valid CSS value to set border-radius
Default
'xl'
Inherited from
Partial.radius
rootRef?
optionalrootRef?:Ref<HTMLDivElement>
Defined in: node_modules/@mantine/core/lib/components/Switch/Switch.d.ts:34
Assigns ref of the root element
Inherited from
Partial.rootRef
ruleGroup
ruleGroup:
RuleGroupTypeAny
Defined in: packages/react-querybuilder/src/types/props.ts:308
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?: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
size?
optionalsize?:string& { } |MantineSize
Defined in: node_modules/@mantine/core/lib/components/Switch/Switch.d.ts:20
Controls size of all elements
Inherited from
Partial.size
testID?
optionaltestID?:string
Defined in: packages/react-querybuilder/src/types/props.ts:104
Test ID for this component.
Inherited from
thumbIcon?
optionalthumbIcon?:ReactNode
Defined in: node_modules/@mantine/core/lib/components/Switch/Switch.d.ts:26
Icon inside the thumb of the switch
Inherited from
Partial.thumbIcon
title?
optionaltitle?:string
Defined in: packages/react-querybuilder/src/types/props.ts:87
The title/tooltip for this control.
Inherited from
validation?
optionalvalidation?:boolean|ValidationResult
Defined in: packages/react-querybuilder/src/types/props.ts:100
Validation result of the parent rule/group.
Inherited from
withThumbIndicator?
optionalwithThumbIndicator?:boolean
Defined in: node_modules/@mantine/core/lib/components/Switch/Switch.d.ts:36
If set, displays a colored dot inside the thumb that matches the track background color
Default
true
Inherited from
Partial.withThumbIndicator
wrapperProps?
optionalwrapperProps?:ClassAttributes<HTMLDivElement> &HTMLAttributes<HTMLDivElement> &DataAttributes
Defined in: node_modules/@mantine/core/lib/components/Switch/Switch.d.ts:24
Props passed down to the root element
Inherited from
Partial.wrapperProps
API documentation is generated from the latest commit on the main branch. It may be somewhat inconsistent with official releases of React Query Builder.