Module: Checkbox

MDCCheckbox component implemented by react component.

Parameters:
Name Type Description
props Object

Attributes other than followings are passed to the input element of React as is.

Properties
Name Type Attributes Description
label string <optional>

The label text of the checkbox.

checked boolean <optional>

Specifies true if you want to check the checkbox.

indeterminate boolean <optional>

Specifies true if you want to set the checkbox in indeterminate.

className string <optional>

The class name that is added to the root element.

disabled boolean <optional>

Specifies true if you want to disable the checkbox. Default to false.

disablesMdcInstance boolean <optional>

Specifies true if you do not want to instantiate MDC Component. Default to false.

supportsTouch boolean <optional>

Whether to support touch in Material Design specification. Material Design spec advises that touch targets should be at least 48 x 48 px.

mdcCheckboxRef React.MutableRefObject <optional>

MutableRefObject which bind an MDCCheckbox instance to. The instance is not bind if props.disablesMdcInstance is true.

mdcFormFieldRef React.MutableRefObject <optional>

MutableRefObject which bind an MDCormField instance to. The instance is not bind if props.disablesMdcInstance is true.

Source:
Returns:
Type
DetailedReactHTMLElement