Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AsyncSwitchProps

Hierarchy

Index

Properties

Properties

about?: string
accept?: string
accessKey?: string
alt?: string
aria-activedescendant?: string

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

aria-atomic?: Booleanish

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

aria-autocomplete?: "list" | "none" | "inline" | "both"

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

aria-busy?: Booleanish

Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

aria-checked?: boolean | "true" | "false" | "mixed"

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

see

aria-pressed @see aria-selected.

aria-colcount?: number

Defines the total number of columns in a table, grid, or treegrid.

see

aria-colindex.

aria-colindex?: number

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

see

aria-colcount @see aria-colspan.

aria-colspan?: number

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

see

aria-colindex @see aria-rowspan.

aria-controls?: string

Identifies the element (or elements) whose contents or presence are controlled by the current element.

see

aria-owns.

aria-current?: boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"

Indicates the element that represents the current item within a container or set of related elements.

aria-describedby?: string

Identifies the element (or elements) that describes the object.

see

aria-labelledby

aria-details?: string

Identifies the element that provides a detailed, extended description for the object.

see

aria-describedby.

aria-disabled?: Booleanish

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

see

aria-hidden @see aria-readonly.

aria-dropeffect?: "link" | "none" | "copy" | "execute" | "move" | "popup"

Indicates what functions can be performed when a dragged object is released on the drop target.

deprecated

in ARIA 1.1

aria-errormessage?: string

Identifies the element that provides an error message for the object.

see

aria-invalid @see aria-describedby.

aria-expanded?: Booleanish

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

aria-flowto?: string

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

aria-grabbed?: Booleanish

Indicates an element's "grabbed" state in a drag-and-drop operation.

deprecated

in ARIA 1.1

aria-haspopup?: boolean | "true" | "false" | "dialog" | "grid" | "listbox" | "menu" | "tree"

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

aria-hidden?: Booleanish

Indicates whether the element is exposed to an accessibility API.

see

aria-disabled.

aria-invalid?: boolean | "true" | "false" | "grammar" | "spelling"

Indicates the entered value does not conform to the format expected by the application.

see

aria-errormessage.

aria-keyshortcuts?: string

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

aria-label?: string

Defines a string value that labels the current element.

see

aria-labelledby.

aria-labelledby?: string

Identifies the element (or elements) that labels the current element.

see

aria-describedby.

aria-level?: number

Defines the hierarchical level of an element within a structure.

aria-live?: "off" | "assertive" | "polite"

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

aria-modal?: Booleanish

Indicates whether an element is modal when displayed.

aria-multiline?: Booleanish

Indicates whether a text box accepts multiple lines of input or only a single line.

aria-multiselectable?: Booleanish

Indicates that the user may select more than one item from the current selectable descendants.

aria-orientation?: "horizontal" | "vertical"

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

aria-owns?: string

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

see

aria-controls.

aria-placeholder?: string

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

aria-posinset?: number

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

see

aria-setsize.

aria-pressed?: boolean | "true" | "false" | "mixed"

Indicates the current "pressed" state of toggle buttons.

see

aria-checked @see aria-selected.

aria-readonly?: Booleanish

Indicates that the element is not editable, but is otherwise operable.

see

aria-disabled.

aria-relevant?: "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

see

aria-atomic.

aria-required?: Booleanish

Indicates that user input is required on the element before a form may be submitted.

aria-roledescription?: string

Defines a human-readable, author-localized description for the role of an element.

aria-rowcount?: number

Defines the total number of rows in a table, grid, or treegrid.

see

aria-rowindex.

aria-rowindex?: number

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

see

aria-rowcount @see aria-rowspan.

aria-rowspan?: number

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

see

aria-rowindex @see aria-colspan.

aria-selected?: Booleanish

Indicates the current "selected" state of various widgets.

see

aria-checked @see aria-pressed.

aria-setsize?: number

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

see

aria-posinset.

aria-sort?: "none" | "ascending" | "descending" | "other"

Indicates if items in a table or grid are sorted in ascending or descending order.

aria-valuemax?: number

Defines the maximum allowed value for a range widget.

aria-valuemin?: number

Defines the minimum allowed value for a range widget.

aria-valuenow?: number

Defines the current value for a range widget.

see

aria-valuetext.

aria-valuetext?: string

Defines the human readable text alternative of aria-valuenow for a range widget.

autoCapitalize?: string
autoComplete?: string
autoCorrect?: string
autoFocus?: boolean
autoSave?: string
ballClassName?: string

An optional className to apply to the switch's ball.

ballStyle?: CSSProperties

An optional style to apply to the switch's ball.

capture?: boolean | "user" | "environment"
checked?: boolean
children?: ReactNode

Any optional children that should be displayed within the switch's ball.

className?: string
color?: string
contentEditable?: Booleanish | "inherit"
contextMenu?: string
crossOrigin?: string
dangerouslySetInnerHTML?: { __html: string }

Type declaration

  • __html: string
datatype?: string
defaultChecked?: boolean
defaultValue?: string | number | readonly string[]
dir?: string
disabled?: boolean
draggable?: Booleanish
enterKeyHint?: "search" | "enter" | "next" | "done" | "go" | "previous" | "send"
error?: boolean

Boolean if the input toggle is currently errored. This will update the label and the input to gain error colors.

form?: string
formAction?: string
formEncType?: string
formMethod?: string
formNoValidate?: boolean
formTarget?: string
height?: string | number
hidden?: boolean
iconAfter?: boolean

Boolean if the input toggle should appear after the label instead of before.

id: string

The id for the radio or checkbox. This is required for a11y and will be used as the for attribute if the label prop is provided.

inline?: boolean

Boolean if the container element should be rendered as inline-flex instead of flex.

inlist?: any
inputMode?: "none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"

Hints at the type of data that might be entered by the user while editing the element or its contents

see

https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

is?: string

Specify that a standard HTML element should behave like a defined custom built-in element

see

https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

itemID?: string
itemProp?: string
itemRef?: string
itemScope?: boolean
itemType?: string
label?: ReactNode

An optional label to display with the input. If this prop is omitted and you aren't adding a custom <label> anywhere else, you should apply an aria-label or aria-labelledby for a11y.

labelClassName?: string

An optional className to apply to the <label> when the label prop is used.

labelDisabled?: boolean

An optional boolean if the label should gain the disabled style. When this is undefined, the disabled prop will be used instead. This is really just useful when you want to disable the switch from being toggled while some async action is being called, but not changing styles during the wait.

labelStyle?: CSSProperties

An optional style to apply to the <label> when the label prop is used.

lang?: string
list?: string
loading: boolean

Boolean if the switch is still loading. This will "disable" the switch and add the circular progress indicator in the switch's ball until it is set back to false.

max?: string | number
maxLength?: number
min?: string | number
minLength?: number
multiple?: boolean
name?: string
onAbort?: ReactEventHandler<HTMLInputElement>
onAbortCapture?: ReactEventHandler<HTMLInputElement>
onAnimationEnd?: AnimationEventHandler<HTMLInputElement>
onAnimationEndCapture?: AnimationEventHandler<HTMLInputElement>
onAnimationIteration?: AnimationEventHandler<HTMLInputElement>
onAnimationIterationCapture?: AnimationEventHandler<HTMLInputElement>
onAnimationStart?: AnimationEventHandler<HTMLInputElement>
onAnimationStartCapture?: AnimationEventHandler<HTMLInputElement>
onAuxClick?: MouseEventHandler<HTMLInputElement>
onAuxClickCapture?: MouseEventHandler<HTMLInputElement>
onBeforeInput?: FormEventHandler<HTMLInputElement>
onBeforeInputCapture?: FormEventHandler<HTMLInputElement>
onBlur?: FocusEventHandler<HTMLInputElement>
onBlurCapture?: FocusEventHandler<HTMLInputElement>
onCanPlay?: ReactEventHandler<HTMLInputElement>
onCanPlayCapture?: ReactEventHandler<HTMLInputElement>
onCanPlayThrough?: ReactEventHandler<HTMLInputElement>
onCanPlayThroughCapture?: ReactEventHandler<HTMLInputElement>
onChange?: ChangeEventHandler<HTMLInputElement>
onChangeCapture?: FormEventHandler<HTMLInputElement>
onClick?: MouseEventHandler<HTMLInputElement>
onClickCapture?: MouseEventHandler<HTMLInputElement>
onCompositionEnd?: CompositionEventHandler<HTMLInputElement>
onCompositionEndCapture?: CompositionEventHandler<HTMLInputElement>
onCompositionStart?: CompositionEventHandler<HTMLInputElement>
onCompositionStartCapture?: CompositionEventHandler<HTMLInputElement>
onCompositionUpdate?: CompositionEventHandler<HTMLInputElement>
onCompositionUpdateCapture?: CompositionEventHandler<HTMLInputElement>
onContextMenu?: MouseEventHandler<HTMLInputElement>
onContextMenuCapture?: MouseEventHandler<HTMLInputElement>
onCopy?: ClipboardEventHandler<HTMLInputElement>
onCopyCapture?: ClipboardEventHandler<HTMLInputElement>
onCut?: ClipboardEventHandler<HTMLInputElement>
onCutCapture?: ClipboardEventHandler<HTMLInputElement>
onDoubleClick?: MouseEventHandler<HTMLInputElement>
onDoubleClickCapture?: MouseEventHandler<HTMLInputElement>
onDrag?: DragEventHandler<HTMLInputElement>
onDragCapture?: DragEventHandler<HTMLInputElement>
onDragEnd?: DragEventHandler<HTMLInputElement>
onDragEndCapture?: DragEventHandler<HTMLInputElement>
onDragEnter?: DragEventHandler<HTMLInputElement>
onDragEnterCapture?: DragEventHandler<HTMLInputElement>
onDragExit?: DragEventHandler<HTMLInputElement>
onDragExitCapture?: DragEventHandler<HTMLInputElement>
onDragLeave?: DragEventHandler<HTMLInputElement>
onDragLeaveCapture?: DragEventHandler<HTMLInputElement>
onDragOver?: DragEventHandler<HTMLInputElement>
onDragOverCapture?: DragEventHandler<HTMLInputElement>
onDragStart?: DragEventHandler<HTMLInputElement>
onDragStartCapture?: DragEventHandler<HTMLInputElement>
onDrop?: DragEventHandler<HTMLInputElement>
onDropCapture?: DragEventHandler<HTMLInputElement>
onDurationChange?: ReactEventHandler<HTMLInputElement>
onDurationChangeCapture?: ReactEventHandler<HTMLInputElement>
onEmptied?: ReactEventHandler<HTMLInputElement>
onEmptiedCapture?: ReactEventHandler<HTMLInputElement>
onEncrypted?: ReactEventHandler<HTMLInputElement>
onEncryptedCapture?: ReactEventHandler<HTMLInputElement>
onEnded?: ReactEventHandler<HTMLInputElement>
onEndedCapture?: ReactEventHandler<HTMLInputElement>
onError?: ReactEventHandler<HTMLInputElement>
onErrorCapture?: ReactEventHandler<HTMLInputElement>
onFocus?: FocusEventHandler<HTMLInputElement>
onFocusCapture?: FocusEventHandler<HTMLInputElement>
onGotPointerCapture?: PointerEventHandler<HTMLInputElement>
onGotPointerCaptureCapture?: PointerEventHandler<HTMLInputElement>
onInput?: FormEventHandler<HTMLInputElement>
onInputCapture?: FormEventHandler<HTMLInputElement>
onInvalid?: FormEventHandler<HTMLInputElement>
onInvalidCapture?: FormEventHandler<HTMLInputElement>
onKeyDown?: KeyboardEventHandler<HTMLInputElement>
onKeyDownCapture?: KeyboardEventHandler<HTMLInputElement>
onKeyPress?: KeyboardEventHandler<HTMLInputElement>
deprecated
onKeyPressCapture?: KeyboardEventHandler<HTMLInputElement>
deprecated
onKeyUp?: KeyboardEventHandler<HTMLInputElement>
onKeyUpCapture?: KeyboardEventHandler<HTMLInputElement>
onLoad?: ReactEventHandler<HTMLInputElement>
onLoadCapture?: ReactEventHandler<HTMLInputElement>
onLoadStart?: ReactEventHandler<HTMLInputElement>
onLoadStartCapture?: ReactEventHandler<HTMLInputElement>
onLoadedData?: ReactEventHandler<HTMLInputElement>
onLoadedDataCapture?: ReactEventHandler<HTMLInputElement>
onLoadedMetadata?: ReactEventHandler<HTMLInputElement>
onLoadedMetadataCapture?: ReactEventHandler<HTMLInputElement>
onLostPointerCapture?: PointerEventHandler<HTMLInputElement>
onLostPointerCaptureCapture?: PointerEventHandler<HTMLInputElement>
onMouseDown?: MouseEventHandler<HTMLInputElement>
onMouseDownCapture?: MouseEventHandler<HTMLInputElement>
onMouseEnter?: MouseEventHandler<HTMLInputElement>
onMouseLeave?: MouseEventHandler<HTMLInputElement>
onMouseMove?: MouseEventHandler<HTMLInputElement>
onMouseMoveCapture?: MouseEventHandler<HTMLInputElement>
onMouseOut?: MouseEventHandler<HTMLInputElement>
onMouseOutCapture?: MouseEventHandler<HTMLInputElement>
onMouseOver?: MouseEventHandler<HTMLInputElement>
onMouseOverCapture?: MouseEventHandler<HTMLInputElement>
onMouseUp?: MouseEventHandler<HTMLInputElement>
onMouseUpCapture?: MouseEventHandler<HTMLInputElement>
onPaste?: ClipboardEventHandler<HTMLInputElement>
onPasteCapture?: ClipboardEventHandler<HTMLInputElement>
onPause?: ReactEventHandler<HTMLInputElement>
onPauseCapture?: ReactEventHandler<HTMLInputElement>
onPlay?: ReactEventHandler<HTMLInputElement>
onPlayCapture?: ReactEventHandler<HTMLInputElement>
onPlaying?: ReactEventHandler<HTMLInputElement>
onPlayingCapture?: ReactEventHandler<HTMLInputElement>
onPointerCancel?: PointerEventHandler<HTMLInputElement>
onPointerCancelCapture?: PointerEventHandler<HTMLInputElement>
onPointerDown?: PointerEventHandler<HTMLInputElement>
onPointerDownCapture?: PointerEventHandler<HTMLInputElement>
onPointerEnter?: PointerEventHandler<HTMLInputElement>
onPointerEnterCapture?: PointerEventHandler<HTMLInputElement>
onPointerLeave?: PointerEventHandler<HTMLInputElement>
onPointerLeaveCapture?: PointerEventHandler<HTMLInputElement>
onPointerMove?: PointerEventHandler<HTMLInputElement>
onPointerMoveCapture?: PointerEventHandler<HTMLInputElement>
onPointerOut?: PointerEventHandler<HTMLInputElement>
onPointerOutCapture?: PointerEventHandler<HTMLInputElement>
onPointerOver?: PointerEventHandler<HTMLInputElement>
onPointerOverCapture?: PointerEventHandler<HTMLInputElement>
onPointerUp?: PointerEventHandler<HTMLInputElement>
onPointerUpCapture?: PointerEventHandler<HTMLInputElement>
onProgress?: ReactEventHandler<HTMLInputElement>
onProgressCapture?: ReactEventHandler<HTMLInputElement>
onRateChange?: ReactEventHandler<HTMLInputElement>
onRateChangeCapture?: ReactEventHandler<HTMLInputElement>
onReset?: FormEventHandler<HTMLInputElement>
onResetCapture?: FormEventHandler<HTMLInputElement>
onScroll?: UIEventHandler<HTMLInputElement>
onScrollCapture?: UIEventHandler<HTMLInputElement>
onSeeked?: ReactEventHandler<HTMLInputElement>
onSeekedCapture?: ReactEventHandler<HTMLInputElement>
onSeeking?: ReactEventHandler<HTMLInputElement>
onSeekingCapture?: ReactEventHandler<HTMLInputElement>
onSelect?: ReactEventHandler<HTMLInputElement>
onSelectCapture?: ReactEventHandler<HTMLInputElement>
onStalled?: ReactEventHandler<HTMLInputElement>
onStalledCapture?: ReactEventHandler<HTMLInputElement>
onSubmit?: FormEventHandler<HTMLInputElement>
onSubmitCapture?: FormEventHandler<HTMLInputElement>
onSuspend?: ReactEventHandler<HTMLInputElement>
onSuspendCapture?: ReactEventHandler<HTMLInputElement>
onTimeUpdate?: ReactEventHandler<HTMLInputElement>
onTimeUpdateCapture?: ReactEventHandler<HTMLInputElement>
onTouchCancel?: TouchEventHandler<HTMLInputElement>
onTouchCancelCapture?: TouchEventHandler<HTMLInputElement>
onTouchEnd?: TouchEventHandler<HTMLInputElement>
onTouchEndCapture?: TouchEventHandler<HTMLInputElement>
onTouchMove?: TouchEventHandler<HTMLInputElement>
onTouchMoveCapture?: TouchEventHandler<HTMLInputElement>
onTouchStart?: TouchEventHandler<HTMLInputElement>
onTouchStartCapture?: TouchEventHandler<HTMLInputElement>
onTransitionEnd?: TransitionEventHandler<HTMLInputElement>
onTransitionEndCapture?: TransitionEventHandler<HTMLInputElement>
onVolumeChange?: ReactEventHandler<HTMLInputElement>
onVolumeChangeCapture?: ReactEventHandler<HTMLInputElement>
onWaiting?: ReactEventHandler<HTMLInputElement>
onWaitingCapture?: ReactEventHandler<HTMLInputElement>
onWheel?: WheelEventHandler<HTMLInputElement>
onWheelCapture?: WheelEventHandler<HTMLInputElement>
pattern?: string
placeholder?: string
prefix?: string
progressClassName?: string

An optional class name to apply to the progress bar while the loading state is enabled.

progressStyle?: CSSProperties

An optional style to apply to the progress bar while the loading state is enabled.

property?: string
radioGroup?: string
required?: boolean
resource?: string
results?: number
role?: AriaRole
security?: string
size?: number
slot?: string
spellCheck?: Booleanish
src?: string
stacked?: boolean

Boolean if the label should be stacked above/below the input toggle instead of inline.

step?: string | number
style?: CSSProperties
suppressContentEditableWarning?: boolean
suppressHydrationWarning?: boolean
tabIndex?: number
title?: string
trackClassName?: string

An optional className to apply to the switch's track (this is the <input type="checkbox"> used behind the scenes).

trackStyle?: CSSProperties

An optional style to apply to the switch's track (this is the <input type="checkbox"> used behind the scenes).

translate?: "yes" | "no"
typeof?: string
unselectable?: "on" | "off"
value?: string | number | readonly string[]
vocab?: string
width?: string | number

Generated using TypeDoc