Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
Optional aria-atomic
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.
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.
Optional aria-busy
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.
Indicates what functions can be performed when a dragged object is released on the drop target.
deprecated
in ARIA 1.1
Optional aria-errormessage
aria-errormessage?:string
Identifies the element that provides an error message for the object.
see
aria-invalid @see aria-describedby.
Optional aria-expanded
aria-expanded?:Booleanish
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
Optional aria-flowto
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.
Optional aria-grabbed
aria-grabbed?:Booleanish
Indicates an element's "grabbed" state in a drag-and-drop operation.
Indicates the entered value does not conform to the format expected by the application.
see
aria-errormessage.
Optional aria-keyshortcuts
aria-keyshortcuts?:string
Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
Optional aria-label
aria-label?:string
Defines a string value that labels the current element.
see
aria-labelledby.
Optional aria-labelledby
aria-labelledby?:string
Identifies the element (or elements) that labels the current element.
see
aria-describedby.
Optional aria-level
aria-level?:number
Defines the hierarchical level of an element within a structure.
Optional aria-live
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.
Optional aria-modal
aria-modal?:Booleanish
Indicates whether an element is modal when displayed.
Optional aria-multiline
aria-multiline?:Booleanish
Indicates whether a text box accepts multiple lines of input or only a single line.
Optional aria-multiselectable
aria-multiselectable?:Booleanish
Indicates that the user may select more than one item from the current selectable descendants.
Optional aria-orientation
aria-orientation?:"horizontal" | "vertical"
Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
Optional aria-owns
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.
Optional aria-placeholder
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.
Optional aria-posinset
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.
Indicates if items in a table or grid are sorted in ascending or descending order.
Optional aria-valuemax
aria-valuemax?:number
Defines the maximum allowed value for a range widget.
Optional aria-valuemin
aria-valuemin?:number
Defines the minimum allowed value for a range widget.
Optional aria-valuenow
aria-valuenow?:number
Defines the current value for a range widget.
see
aria-valuetext.
Optional aria-valuetext
aria-valuetext?:string
Defines the human readable text alternative of aria-valuenow for a range widget.
Optional autoCapitalize
autoCapitalize?:string
Optional autoComplete
autoComplete?:string
Optional autoCorrect
autoCorrect?:string
Optional autoFocus
autoFocus?:boolean
Optional autoSave
autoSave?:string
Optional capture
capture?:boolean | "user" | "environment"
Optional checked
checked?:boolean
Optional children
children?:ReactNode
Optional content to render after the icon element.
Optional className
className?:string
Optional color
color?:string
Optional contentEditable
contentEditable?:Booleanish | "inherit"
Optional contextMenu
contextMenu?:string
Optional crossOrigin
crossOrigin?:string
Optional dangerouslySetInnerHTML
dangerouslySetInnerHTML?:{ __html: string }
Type declaration
__html: string
Optional datatype
datatype?:string
Optional defaultChecked
defaultChecked?:boolean
Optional defaultValue
defaultValue?:string | number | readonly string[]
Optional dir
dir?:string
Optional disableIconOverlay
disableIconOverlay?:boolean
Boolean if the icon's overlay should be disabled. The way the Checkbox and
Radio input elements work is by applying different opacity to the
::before and ::after pseudo selectors and animating it. If you want to
use a custom icon that is not a material-icon checkbox outline or radio
button, you should probably enable this prop.
Optional disablePressedFallback
disablePressedFallback?:boolean
Boolean if the component should fallback to using the custom pressed class
names when ripples are disabled.
defaultvalue
false
Optional disableProgrammaticRipple
disableProgrammaticRipple?:boolean
Boolean if the ripple component should not be triggered after a
"programmatic" ripple effect. This would be if the .click() function is
called on an element through javascript or some other means.
Optional disableRipple
disableRipple?:boolean
Boolean if the ripple effect should be disabled for all child components
that use the Ripple states.
Boolean if the input toggle is currently errored. This will update the
label and the input to gain error colors.
Optional form
form?:string
Optional formAction
formAction?:string
Optional formEncType
formEncType?:string
Optional formMethod
formMethod?:string
Optional formNoValidate
formNoValidate?:boolean
Optional formTarget
formTarget?:string
Optional height
height?:string | number
Optional hidden
hidden?:boolean
Optional icon
icon?:ReactNode
The icon to use for either a radio or a checkbox.
Optional iconAfter
iconAfter?:boolean
Boolean if the input toggle should appear after the label instead of
before.
Optional iconClassName
iconClassName?:string
An optional className to apply to the <span> surrounding the toggle icon.
Optional iconStyle
iconStyle?:CSSProperties
An optional style to apply to the <span> surrounding the toggle icon.
id
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.
Optional inline
inline?:boolean
Boolean if the container element should be rendered as inline-flex
instead of flex.
Optional inlist
inlist?:any
Optional inputClassName
inputClassName?:string
An optional className to provide to the invisible <input> element that
is used to toggle the checked state. This prop does not have many uses and
is really just provided since the className is passed to the container
element instead of the <input>. However, this can be used to update the
icon styles if needed using the :checked state:
An optional style to provide to the invisible <input> element that is
used to toggle the checked state. This prop is only available since the
style prop is passed to the container element, but you probably shouldn't
really style this element anyways.
remarks
@since 2.2.0
Optional is
is?:string
Specify that a standard HTML element should behave like a defined custom built-in element
An optional label to display with the input. If this prop is omitted, you
should apply an aria-label or aria-labelledby for a11y.
Optional labelClassName
labelClassName?:string
An optional className to apply to the <label> when the label prop is
used.
Optional labelDisabled
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.
Optional labelStyle
labelStyle?:CSSProperties
An optional style to apply to the <label> when the label prop is used.
The class names to apply during the different stages for the ripple
animation. You probably don't want to use this.
Optional rippleTimeout
rippleTimeout?:TransitionTimeout
The amount of time before a ripple finishes its animation. You probably
don't want to change this value unless you updated the duration in scss or
changed the different class names for the ripple animation.
Optional role
role?:AriaRole
Optional security
security?:string
Optional size
size?:number
Optional slot
slot?:string
Optional spellCheck
spellCheck?:Booleanish
Optional src
src?:string
Optional stacked
stacked?:boolean
Boolean if the label should be stacked above/below the input toggle instead
of inline.
Optional step
step?:string | number
Optional style
style?:CSSProperties
Optional suppressContentEditableWarning
suppressContentEditableWarning?:boolean
Optional suppressHydrationWarning
suppressHydrationWarning?:boolean
Optional tabIndex
tabIndex?:number
Optional title
title?:string
Optional toggleClassName
toggleClassName?:string
An optional className to apply to the toggle <span> element. The
className prop will be applied to the container <div> element instead.
Optional toggleStyle
toggleStyle?:CSSProperties
An optional style to apply to the toggle <span> element. The style prop
will be applied to the container <div> element instead.
Optional translate
translate?:"yes" | "no"
Optional typeof
typeof?:string
Optional unselectable
unselectable?:"on" | "off"
value
value:string | number | readonly string[]
A value is required for a radio button unlike a checkbox.
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.