Interface TypeCheckboxProps

The component used to render a link when the href prop is provided.

Props applied to the TouchRipple element.

A ref for imperative actions. It currently only supports focusVisible() action.

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

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.

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 the current "checked" state of checkboxes, radio buttons, and other widgets.

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

Indicates whether the element is exposed to an accessibility API.

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

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

Defines a string value that labels the current element.

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

Defines the hierarchical level of an element within a structure.

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.

Indicates whether an element is modal when displayed.

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

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

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

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.

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.

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 the current "pressed" state of toggle buttons.

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

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

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

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

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

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

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

Indicates the current "selected" state of various widgets.

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.

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

Defines the maximum allowed value for a range widget.

Defines the minimum allowed value for a range widget.

Defines the current value for a range widget.

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

If true, the ripples are centered. They won't start at the cursor interaction position.

If true, the component is checked.

The icon to display when the component is checked.

Override or extend the styles applied to the component.

The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.

The default checked state. Use when the component is not controlled.

If true, the keyboard focus ripple is disabled.

If true, the ripple effect is disabled.

If true, the touch ripple effect is disabled.

If true, the component is disabled.

If given, uses a negative margin to counteract the padding on one side (this is often helpful for aligning the left or right side of the icon with content above or below, without ruining the border size and shape).

If true, the base button will have a keyboard focus ripple.

This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed.

The icon to display when the component is unchecked.

The id of the input element.

If true, the component appears indeterminate. This does not set the native input element to indeterminate due to inconsistent behavior across browsers. However, we set a data-indeterminate attribute on the input.

The icon to display when the component is indeterminate.

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

Attributes applied to the input element.

Pass a ref to the input element.

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

Name attribute of the input element.

Callback fired when the component is focused with a keyboard. We trigger a onFocus callback too.

If true, the input element is required.

The size of the component. small is equivalent to the dense checkbox styling.

The system prop that allows defining system overrides as well as additional CSS styles.

A ref that points to the TouchRipple element.

The value of the component. The DOM API casts this to a string. The browser uses "on" as the default value.