Skip to main content

FluentNotToggleProps

Defined in: packages/fluent/src/FluentNotToggle.tsx:9

Extends​

Methods​

handleOnChange()​

handleOnChange(checked: boolean): void

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

Parameters​

ParameterType
checkedboolean

Returns​

void

Inherited from​

NotToggleProps.handleOnChange

Properties​

as?​

optional as?: "input"

Defined in: node_modules/@fluentui/react-utilities/dist/index.d.ts:858

Inherited from​

Omit.as

checked?​

optional checked?: boolean

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

Inherited from​

NotToggleProps.checked

children?​

optional children?: undefined

Defined in: node_modules/@fluentui/react-utilities/dist/index.d.ts:1241

Inherited from​

Omit.children

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

defaultChecked?​

optional defaultChecked?: boolean

Defined in: node_modules/@fluentui/react-switch/dist/index.d.ts:66

Defines whether the Switch is initially in a checked state or not when rendered.

Default​

false

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

disabledFocusable?​

optional disabledFocusable?: boolean

Defined in: node_modules/@fluentui/react-switch/dist/index.d.ts:60

When set, allows the Switch to be focusable even when it has been disabled. This is used in scenarios where it is important to keep a consistent tab order for screen reader and keyboard users.

Default​

false

Inherited from​

Omit.disabledFocusable

indicator?​

optional indicator?: NonNullable<WithSlotShorthandValue<{ as?: "div" | undefined; } & Omit<DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "children"> & { ...; }> | null>

Defined in: node_modules/@fluentui/react-switch/dist/index.d.ts:96

The track and the thumb sliding over it indicating the on and off status of the Switch.

Inherited from​

Omit.indicator

input?​

optional input?: { as?: "input"; } & Omit<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "children"> & { children?: undefined; }

Defined in: node_modules/@fluentui/react-switch/dist/index.d.ts:103

Hidden input that handles the Switch's functionality.

This is the PRIMARY slot: all native properties specified directly on the <Switch> tag will be applied to this slot, except className and style, which remain on the root slot.

Type Declaration​

as?​

optional as?: "input"

Type Declaration​

children?​

optional children?: undefined

Inherited from​

Omit.input

label?​

optional label?: ReactNode

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

Inherited from​

NotToggleProps.label

labelPosition?​

optional labelPosition?: "above" | "after" | "before"

Defined in: node_modules/@fluentui/react-switch/dist/index.d.ts:72

The position of the label relative to the Switch.

Default​

after

Inherited from​

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

NotToggleProps.level

onChange?​

optional onChange?: (ev: ChangeEvent<HTMLInputElement>, data: SwitchOnChangeData) => void

Defined in: node_modules/@fluentui/react-switch/dist/index.d.ts:82

Callback to be called when the checked state value changes.

Parameters​

ParameterType
evChangeEvent<HTMLInputElement>
dataSwitchOnChangeData

Returns​

void

Inherited from​

Omit.onChange

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

root?​

optional root?: NonNullable<WithSlotShorthandValue<{ as?: "div" | undefined; } & Omit<DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "children"> & { ...; }> | null>

Defined in: node_modules/@fluentui/react-switch/dist/index.d.ts:92

The root element of the Switch.

The root slot receives the className and style specified directly on the <Switch> tag. All other native props will be applied to the primary slot: input.

Inherited from​

Omit.root

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?: "small" | "medium"

Defined in: node_modules/@fluentui/react-switch/dist/index.d.ts:78

The size of the Switch.

Default​

'medium'

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

title?​

optional title?: string

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

The title/tooltip for this control.

Inherited from​

NotToggleProps.title

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

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.