enact logoEnact
Edit on GitHub

sandstone/FormCheckboxItem

Provides Sandstone styled form item component and interactive toggleable checkbox.

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

Members

FormCheckboxItemComponent

A Sandstone-styled form item with a checkbox component.

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

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

FormCheckboxItemBaseComponent

A Sandstone-styled form item with a checkbox component.

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

import {FormCheckboxItemBase} from '@enact/sandstone/FormCheckboxItem';
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 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/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 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/resolution)

selected
Boolean

Controls the presence of the checkmark icon.

slotBefore
Node

Nodes to be inserted after the checkbox and before children.

FormCheckboxItemDecoratorHigher-Order Component

Adds interactive functionality to FormCheckboxItem.

import {FormCheckboxItemDecorator} from '@enact/sandstone/FormCheckboxItem';
ArrayBooleanFunctionModuleNumberObjectString