Shows exactly one child element at a time. This can be useful, for example, if a given UI element has multiple modes that present substantially different elements.

Live demo

The transition between child elements is instantenous. If you'd like the transition to be accompanied by visible animated effects, see basic-animation-stage.

This component doesn't provide any UI for changing which mode is shown.

Kind: global class Extends: ElementBase
Mixes: ContentItemsMixin , DistributedChildrenContentMixin , SingleSelectionMixin

• Modes ⇐ ElementBase
  • .canSelectNext : boolean
  • .canSelectPrevious : boolean
  • .content : Array.<HTMLElement>
  • "content-changed"
  • .contentChanged()
  • .itemAdded(item)
  • .itemAdded(item)
  • .items : Array.<HTMLElement>
  • "items-changed"
  • .itemsChanged()
  • .itemSelected(item, selected)
  • .itemSelected(item, selected)
  • "selected-index-changed"
  • "selected-item-changed"
  • .selectedIndex : number
  • .selectedItem : object
  • .selectFirst()
  • .selectionRequired : boolean
  • .selectionWraps : boolean
  • .selectLast()
  • .selectNext()
  • .selectPrevious()

True if the selection can be moved to the next item, false if not (the selected item is the last item in the list).

Kind: instance property of Modes. Defined by SingleSelection mixin.

True if the selection can be moved to the previous item, false if not (the selected item is the first one in the list).

Kind: instance property of Modes. Defined by SingleSelection mixin.

The content of this component, defined to be the flattened array of children distributed to the component.

Kind: instance property of Modes. Defined by DistributedChildrenContent mixin.

This event is raised when the component's contents (including distributed children) have changed.

Kind: event emitted by Modes. Defined by DistributedChildrenContent mixin.

Invoked when the contents of the component (including distributed children) have changed.

This method is also invoked when a component is first instantiated; the contents have essentially "changed" from being nothing. This allows the component to perform initial processing of its children.

Kind: instance method of Modes. Defined by DistributedChildrenContent mixin.

This method is invoked whenever a new item is added to the list.

The default implementation of this method does nothing. You can override this to perform per-item initialization.

Kind: static method of Modes. Defined by ContentItems#symbols mixin.

Handle a new item being added to the list.

The default implementation of this method simply sets the item's selection state to false.

Kind: static method of Modes. Defined by SingleSelection#symbols mixin.

The current set of items in the list. See the top-level documentation for mixin for a description of how items differ from plain content.

Kind: instance property of Modes. Defined by ContentItems mixin.

Fires when the items in the list change.

Kind: event emitted by Modes. Defined by ContentItems mixin.

This method is invoked when the underlying contents change. It is also invoked on component initialization – since the items have "changed" from being nothing.

Kind: static method of Modes. Defined by ContentItems#symbols mixin.

The selection state for a single item has changed.

Invoke this method to signal that the selected state of the indicated item has changed. By default, this applies a selected CSS class if the item is selected, and removed it if not selected.

Kind: static method of Modes. Defined by ContentItems#symbols mixin.

Apply the indicate selection state to the item.

The default implementation of this method does nothing. User-visible effects will typically be handled by other mixins.

Kind: static method of Modes. Defined by SingleSelection#symbols mixin.

Fires when the selectedIndex property changes.

Kind: event emitted by Modes. Defined by SingleSelection mixin.

Fires when the selectedItem property changes.

Kind: event emitted by Modes. Defined by SingleSelection mixin.

The index of the item which is currently selected.

A selectedIndex of -1 indicates there is no selection. Setting this property to -1 will remove any existing selection.

Kind: instance property of Modes. Defined by SingleSelection mixin.

The currently selected item, or null if there is no selection.

Setting this property to null deselects any currently-selected item. Setting this property to an object that is not in the list has no effect.

TODO: Even if selectionRequired, can still explicitly set selectedItem to null. TODO: If selectionRequired, leave selection alone?

Kind: instance property of Modes. Defined by SingleSelection mixin.

Select the first item in the list.

Kind: instance method of Modes. Defined by SingleSelection mixin.

True if the list should always have a selection (if it has items).

Kind: instance property of Modes. Defined by SingleSelection mixin. Default: false

True if selection navigations wrap from last to first, and vice versa.

Kind: instance property of Modes. Defined by SingleSelection mixin. Default: false

Select the last item in the list.

Kind: instance method of Modes. Defined by SingleSelection mixin.

Select the next item in the list.

Kind: instance method of Modes. Defined by SingleSelection mixin.

Select the previous item in the list.

If the list has no selection, the last item will be selected.

Kind: instance method of Modes. Defined by SingleSelection mixin.