Skip to main content

PrimeNotToggleProps

Defined in: packages/prime/src/PrimeNotToggle.tsx:9

Extends​

  • NotToggleProps
  • Omit<ComponentPropsWithoutRef<typeof InputSwitch>, "checked" | "onChange">

Methods​

handleOnChange()​

handleOnChange(checked: boolean): void

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

Parameters​

ParameterType
checkedboolean

Returns​

void

Inherited from​

NotToggleProps.handleOnChange

Properties​

autoFocus?​

optional autoFocus?: boolean

Defined in: node_modules/primereact/inputswitch/inputswitch.d.ts:77

When present, it specifies that the component should automatically get focus on load.

Default Value​

false

Inherited from​

Omit.autoFocus


checked?​

optional checked?: boolean

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

Inherited from​

NotToggleProps.checked


children?​

readonly optional children?: ReactNode

Defined in: node_modules/primereact/inputswitch/inputswitch.d.ts:155

Used to get the child elements of the component.

Inherited from​

Omit.children


className?​

optional className?: string

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

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:103

Container for custom props that are passed to all components.

Inherited from​

NotToggleProps.context


disabled?​

optional disabled?: boolean

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

Disables the control.

Inherited from​

NotToggleProps.disabled


falseValue?​

optional falseValue?: any

Defined in: node_modules/primereact/inputswitch/inputswitch.d.ts:116

Value in unchecked state.

Default Value​

false

Inherited from​

Omit.falseValue


id?​

optional id?: string

Defined in: node_modules/primereact/inputswitch/inputswitch.d.ts:72

Unique identifier of the element.

Inherited from​

Omit.id


inputId?​

optional inputId?: string

Defined in: node_modules/primereact/inputswitch/inputswitch.d.ts:93

Identifier of the input element.

Inherited from​

Omit.inputId


inputRef?​

optional inputRef?: Ref<HTMLInputElement>

Defined in: node_modules/primereact/inputswitch/inputswitch.d.ts:81

Reference of the input element.

Inherited from​

Omit.inputRef


invalid?​

optional invalid?: boolean

Defined in: node_modules/primereact/inputswitch/inputswitch.d.ts:121

When present, it specifies that the component should have invalid state style.

Default Value​

false

Inherited from​

Omit.invalid


label?​

optional label?: ReactNode

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

Inherited from​

NotToggleProps.label


level​

level: number

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

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

Inherited from​

NotToggleProps.level


name?​

optional name?: string

Defined in: node_modules/primereact/inputswitch/inputswitch.d.ts:97

Name of the input element.

Inherited from​

Omit.name


onBlur?​

optional onBlur?: (event: FocusEvent<HTMLInputElement>) => void

Defined in: node_modules/primereact/inputswitch/inputswitch.d.ts:150

Callback to invoke when the element loses focus.

Parameters​

ParameterTypeDescription
eventFocusEvent<HTMLInputElement>Browser event

Returns​

void

Inherited from​

Omit.onBlur


onFocus?​

optional onFocus?: (event: FocusEvent<HTMLInputElement>) => void

Defined in: node_modules/primereact/inputswitch/inputswitch.d.ts:145

Callback to invoke when the element receives focus.

Parameters​

ParameterTypeDescription
eventFocusEvent<HTMLInputElement>Browser event

Returns​

void

Inherited from​

Omit.onFocus


path​

path: Path

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

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

Inherited from​

NotToggleProps.path


pt?​

optional pt?: InputSwitchPassThroughOptions

Defined in: node_modules/primereact/inputswitch/inputswitch.d.ts:160

Uses to pass attributes to DOM elements inside the component.

Inherited from​

Omit.pt


ptOptions?​

optional ptOptions?: PassThroughOptions

Defined in: node_modules/primereact/inputswitch/inputswitch.d.ts:165

Used to configure passthrough(pt) options of the component.

Inherited from​

Omit.ptOptions


ruleGroup​

ruleGroup: RuleGroupTypeAny

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

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?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | string[] | FlexibleOption<...>[] | (string | FlexibleOpt..., operator: string, meta?: { fieldData: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | string[] | FlexibleOption<...>[] | (string | FlexibleOpt...; }) => boolean); datatype?: unknown; defaultOperator?: string; defaultValue?: any; disabled?: boolean; id?: string; inputType?: InputType | null; label: string; matchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]; name: string; operators?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }> | 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?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | 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 | [FlexibleOption, ...FlexibleOption[]] | ((operator: string) => ValueSources | [FlexibleOption, ...FlexibleOption[]]); }, string>

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

All subcomponents receive the configuration schema as a prop.

Inherited from​

NotToggleProps.schema


style?​

optional style?: CSSProperties

Defined in: node_modules/primereact/inputswitch/inputswitch.d.ts:85

Inline style of the element.

Inherited from​

Omit.style


tabIndex?​

optional tabIndex?: number

Defined in: node_modules/primereact/inputswitch/inputswitch.d.ts:101

Index of the element in tabbing order.

Inherited from​

Omit.tabIndex


testID?​

optional testID?: string

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

Test ID for this component.

Inherited from​

NotToggleProps.testID


title?​

optional title?: string

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

The title/tooltip for this control.

Inherited from​

NotToggleProps.title


tooltip?​

optional tooltip?: string

Defined in: node_modules/primereact/inputswitch/inputswitch.d.ts:130

Content of the tooltip.

Inherited from​

Omit.tooltip


tooltipOptions?​

optional tooltipOptions?: TooltipOptions

Defined in: node_modules/primereact/inputswitch/inputswitch.d.ts:135

Configuration of the tooltip, refer to the tooltip documentation for more information.

Inherited from​

Omit.tooltipOptions


trueValue?​

optional trueValue?: any

Defined in: node_modules/primereact/inputswitch/inputswitch.d.ts:111

Value in checked state.

Default Value​

true

Inherited from​

Omit.trueValue


unstyled?​

optional unstyled?: boolean

Defined in: node_modules/primereact/inputswitch/inputswitch.d.ts:170

When enabled, it removes component related styles in the core.

Default Value​

false

Inherited from​

Omit.unstyled


validation?​

optional validation?: boolean | ValidationResult

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

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.