limestone/Checkbox

Limestone styled checkbox components.

Loading Live Preview

Members

Checkbox Component

A Limestone-styled checkbox component.

Checkbox will manage its selected state via ui/Toggleableui/Toggleable unless set directly.

Extends: limestone/Checkboxlimestone/Checkbox.CheckboxBase
Wrapped with: limestone/Checkboxlimestone/Checkbox.CheckboxDecorator

CheckboxBase Component

A checkbox component, ready to use in Limestone applications.

Checkbox may be used independently to represent a toggleable state but is more commonly used as part of limestone/CheckboxItemlimestone/CheckboxItem.

Usage:

<Checkbox selected />

Extends: limestone/Iconlimestone/Icon.Icon

Properties

children

StringObject

The icon displayed when selected.

May be specified as either:

A string that represents an icon from the limestone/Iconlimestone/Icon.iconList,
An HTML entity string, Unicode reference or hex value (in the form '0x...'),
A URL specifying path to an icon image, or
An object representing a resolution independent resource (See ui/resolutionui/resolution)

Default: 'checkmark'

See: limestone/Icon.IconBase.children

css

Object

Customizes the component by mapping the supplied collection of CSS class names to the corresponding internal elements and states of this component.

The following classes are supported:

checkbox - The root class name
selected - Applied when the selected prop is true

disabled

Boolean

Disables Checkbox and becomes non-interactive.

Default: false

indeterminate

Boolean

Enables the "indeterminate" state.

An indeterminate, mixed, or half-selected state is typically used in a hierarchy or group to represent that some, not all, children are selected.

NOTE: This does not prevent updating the selected state. Applications must control this property directly.

Default: false

indeterminateIcon

String

The icon to be used in the indeterminate state.

May be specified as either:

A string that represents an icon from the limestone/Iconlimestone/Icon.Icon.iconList,
An HTML entity string, Unicode reference or hex value (in the form '0x...'),
A URL specifying path to an icon image, or
An object representing a resolution independent resource (See ui/resolutionui/resolution)

Default: 'minus'

selected

Boolean

Sets whether this control is in the 'on' or 'off' state. true for 'on', false for 'off'.

Default: false

CheckboxDecorator Higher-Order Component

Adds interactive functionality to Checkbox.

Includes: ui/Toggleableui/Toggleable.Toggleable
Includes: limestone/Skinnablelimestone/Skinnable.Skinnable
Includes: spotlight/Spottablespotlight/Spottable.Spottable