limestone/FormCheckboxItem

Provides Limestone styled form item component and interactive toggleable checkbox.

Loading Live Preview

Import Usage

import FormCheckboxItem from '@enact/limestone/FormCheckboxItem';

Members

FormCheckboxItem   Component

A Limestone-styled form item with a checkbox component.

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

Import Usage

import FormCheckboxItem from '@enact/limestone/FormCheckboxItem';

Extends: limestone/FormCheckboxItemlimestone/FormCheckboxItem.FormCheckboxItemBase
Wrapped with: limestone/FormCheckboxItemlimestone/FormCheckboxItem.FormCheckboxItemDecorator

FormCheckboxItemBase   Component

A Limestone-styled form item with a checkbox component.

Useful to show a selected state on an item inside a form.

Import Usage

import {FormCheckboxItemBase} from '@enact/limestone/FormCheckboxItem';

Extends: limestone/Itemlimestone/Item.Item

Properties

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:

• formCheckboxItem - The root class name

---

icon

StringObject

The icon content.

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)

---

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.

---

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.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)

---

selected

Boolean

Controls the presence of the checkmark icon.

---

slotBefore

Node

Nodes to be inserted after the checkbox and before children.

FormCheckboxItemDecorator   Higher-Order Component

Adds interactive functionality to FormCheckboxItem.

Import Usage

import {FormCheckboxItemDecorator} from '@enact/limestone/FormCheckboxItem';

Includes: ui/Toggleableui/Toggleable.Toggleable