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
An screen reader label to use for the checkbox. Either this or the
aria-labelledby prop are required for a11y.
Note: This is defaulted automatically to "Toggle Row Selection".
Optional aria-labelledby
aria-labelledby?:string
An optional id or space-delimited list of ids that describe the checkbox.
Either this or the aria-label props are required for a11y.
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 what notifications the user agent will trigger when the accessibility tree within a live region is modified.
see
aria-atomic.
Optional aria-required
aria-required?:Booleanish
Indicates that user input is required on the element before a form may be submitted.
Optional aria-roledescription
aria-roledescription?:string
Defines a human-readable, author-localized description for the role of an element.
Optional aria-rowcount
aria-rowcount?:number
Defines the total number of rows in a table, grid, or treegrid.
see
aria-rowindex.
Optional 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.
Optional 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.
Optional aria-selected
aria-selected?:Booleanish
Indicates the current "selected" state of various widgets.
see
aria-checked @see aria-pressed.
Optional aria-setsize
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.
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 autoCorrect
autoCorrect?:string
Optional autoSave
autoSave?:string
Optional cellId
cellId?:string
An optional id to provide to the <td> element. The base id prop is
passed to the checkbox input instead.
Optional checkboxClassName
checkboxClassName?:string
An optional className to apply to the checkbox. The base className is
passed to the <td>.
Optional checkboxRef
checkboxRef?:Ref<HTMLInputElement>
An optional ref to apply to the checkbox element. The base ref is
passed to the <td> element.
Optional checkboxStyle
checkboxStyle?:CSSProperties
An optional style to apply to the checkbox. The base style is passed to
the <td>.
Optional checked
checked?:boolean
Optional children
children?:ReactNode
Optional className
className?:string
Optional colSpan
colSpan?:number
Optional color
color?:string
Optional contentEditable
contentEditable?:Booleanish | "inherit"
Optional contextMenu
contextMenu?: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 draggable
draggable?:Booleanish
Optional headers
headers?: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 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 checkbox. This is required for a11y.
Optional indeterminate
indeterminate?:boolean
Boolean if the checkbox can have an indeterminate state. This is used when
there is a checkbox group where a single checkbox and select/deselect all
related checkboxes. This should be enabled when not all the related
checkboxes have been checked.
If this is a trueish value, the cell will become a sticky cell that will be
fixed while the user scrolls the table. When this is a boolean (or
inherited from a TableHeader) or set to "header", the cell will act as
a sticky header that will be visible for vertical scrolling.
When this is set to "cell", the cell will be fixed to the left or right
for horizontal scrolling.
Finally, if this is set to "header-cell", it will be a combination of
both vertical and horizontal scrolling. This means that other sticky header
cells will scroll beneath this cell.
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.
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.