ui/ToggleItem

Properties

children •

Node

The main content of the toggle item.

component •

Component

The type of component to use to render as root element.

This receives the css prop for theme extension and therefore must be a custom component and not a simple HTML DOM node. Recommended component or themed derivative: SlotItem

iconComponent •

ComponentElement

The Icon to render in this item.

This component receives the selected prop and value, and must therefore respond to it in some way. It is recommended to use ToggleIcon for this.

componentRef

ObjectFunction

Called with a reference to the root component.

When using ui/ToggleItem.ToggleItem, the ref prop is forwarded to this component as componentRef.

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:

• toggleItem - The root class name

disabled

Boolean

Applies a disabled visual state to the toggle item.

Default: false

icon

StringObject

An optional prop that lets you override the icon of the iconComponent component.

This accepts any string that the Icon component supports, provided the recommendations of iconComponent are followed.

iconPosition

'before''after'

Specifies on which side ('before' or 'after') of children the icon appears.

Default: 'before'

itemIcon

Node

An additional customizable icon component.

Supports more granular positioning rules. This should only be used after specifying the icon property, as the positioning for this offers the ability to place this in front of or behind the existing icon. See itemIconPosition for options.

itemIconPosition

'before''beforeChildren''afterChildren''after'

Specifies where itemIcon appears.

• 'before' - first element in the item

• 'beforeChildren' - before children. If iconPosition is 'before', icon will be before itemIcon

• 'afterChildren' - after children. If iconPositionis'after', iconwill be afteritemIcon`

• 'after' - the last element in the item

Default: 'afterChildren'

onTap

Function

Called when the toggle item is toggled. Developers should generally use onToggle instead.

onToggle

Function

Called when the toggle item is toggled.

selected

Boolean

Applies the provided icon.

Default: false

value

Any

The value that will be sent to the onToggle handler.

Default: null