SlidingPages

A typical carousel with a sliding effect. The user can move between items with touch, the mouse, the keyboard, or a trackpad.

Mountain lake Terraced farm Winter trees Forest river Red panda
Demo: You can navigate sliding pages with touch/mouse/keyboard/trackpad

SlidingPages wraps a SlidingStage and adds various input mixins, such as TouchSwipeMixin.

SlidingPages provides no visible UI elements for navigation the items. For a variation of SlidingPages that includes left/right arrow buttons and page dots, see Carousel.

Usage

import SlidingPages from 'elix/src/SlidingPages.js';
const slidingPages = new SlidingPages(); // or
const slidingPages = document.createElement('elix-sliding-pages');

In HTML:

<script type="module" src="node_modules/elix/src/SlidingPages.js"></script>
<elix-sliding-pages>
  <!-- Carousel items such as img elements go here. -->
</elix-sliding-pages>

SlidingPages is appropriate when:

  • You want to present to the user a collection of images, or a mixture of graphical and textual content.
  • You want to let the user focus on a single item at a time.
  • The number of items may be large, but you can give the user a reasonable starting point in the collection, and there is reason to believe that the item(s) they will want to see are close to that point. If you have a small collection of items (10 or fewer), consider using Carousel instead, which provides dots for easy navigation.

The simpler Modes component is useful in cases where you do not need to provide a sliding effect.

API

Ancestry: SlidingPages → SlidingStageReactiveElement → HTMLElement

Built with mixins AriaListMixin, AttributeMarshallingMixin, DirectionSelectionMixin, FocusVisibleMixin, KeyboardDirectionMixin, KeyboardMixin, LanguageDirectionMixin, ReactiveMixin, RenderUpdatesMixin, ShadowTemplateMixin, SingleSelectionMixin, SlotItemsMixin, SwipeDirectionMixin, TouchSwipeMixin, and TrackpadSwipeMixin.

$ property

The collection of references to the elements with IDs in the component's Shadow DOM subtree.

Example: if component's template contains a shadow element <button id="foo">, you can use the reference this.$.foo to obtain the corresponding button in the component instance's shadow tree.

Such references simplify a component's access to its own elements. In exchange, this mixin trades off a one-time cost of querying all elements in the shadow tree instead of paying an ongoing cost to query for an element each time the component wants to inspect or manipulate it.

These shadow element references are established the first time you read the $ property. They are not updated if you subsequently modify the shadow tree yourself (to replace one item with another, to add new items with id attributes, etc.).

Type: object

Defined by ShadowTemplateMixin inherited from ReactiveElement

canSelectNext property

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

Type: boolean

Defined by SingleSelectionMixin inherited from SlidingStage

canSelectPrevious property

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

Type: boolean

Defined by SingleSelectionMixin inherited from SlidingStage

defaultState property

The default state for the component. This can be extended by mixins and classes to provide additional default state.

Type: object

Defined by ReactiveMixin inherited from ReactiveElement

itemCalcs(item, index) method

Returns a set of calculations about the given item that can be derived from the component's current state.

The goal of the itemCalcs step is to ensure that all mixins/classes use a consistent definition for facts about an item that can be derived from component state. By default, itemCalcs includes a member index containing the index of the indicated item. Other mixins/classes can extend the result of itemCalcs to include additional facts.

For example, the SingleSelectionMixin tracks selection at the component level through a state member state.selectedIndex. When rendering a specific item, a component generally wants to know, "Is this specific item the one which is selected?". SingleSelectionMixin does this with a defintion for itemCalcs that looks like this:

itemCalcs(item, index) {
  const base = super.itemCalcs ? super.itemCalcs(item, index) : null;
  return Object.assign({}, base, {
    selected: index === this.selectedIndex
  });
}


This ensures that any other aspect of the component that wants to inspect the selected state of a given item uses a consistent definition for selection.

Parameters:
  • item: Elementthe item being considered
  • index: numberthe item's position in the list

Defined by ContentItemsMixin inherited from SlotItemsMixin

items property

The current set of items drawn from the element's current state.

Defined by ContentItemsMixin inherited from SlotItemsMixin

itemUpdates(item, calcs, original) method

Determine what updates should be applied to an item to reflect the current state, using the format defined by the updates helpers.

By default, this returns an empty object. You should override this method (or use mixins that override this method) to indicate what updates should be applied to the given item during rendering.

Example: AriaListMixin uses code similar to the following to have an item's aria-selected attribute reflect its selection state:

itemUpdates(item, calcs, original) {
  const base = super.itemUpdates ? super.itemUpdates(item, calcs, original) : {};
  return merge(base, {
    attributes: {
      'aria-selected': calcs.selected
    },
  });
}


This code fragment is intended for use with SingleSelectionMixin, which provides the calcs.selected member.

Parameters:
  • item: Elementthe item to be updated
  • calcs: objectper-item calculations derived from element state
  • original: objectthe item's original HTML attributes, classes, and style

Returns: object the DOM updates that should be applied to the item

Defined by ContentItemsMixin inherited from SlotItemsMixin

refineState(state) method

Apply changes to a proposed new state for the component to enforce necessary consistency between state members. See Refining state for details.

Parameters:
  • state: objecta proposed new state for the component

Returns: boolean - true if the state is already acceptable as it is

Defined by ReactiveMixin inherited from ReactiveElement

render() method

Render the component to the DOM.

This method does nothing if the state has not changed since the last render call.

This method invokes all internal render methods. It then invoked componentDidMount (for first render) or componentDidUpdate (for subsequent renders).

Defined by ReactiveMixin inherited from ReactiveElement

selected-index-changed event

Raised when the selectedIndex property changes.

Defined by SingleSelectionMixin inherited from SlidingStage

selectedIndex property

The index of the currently-selected item, or -1 if no item is selected.

Type: number

Defined by SingleSelectionMixin inherited from SlidingStage

selectedItem property

The currently-selected item, or null if no item is selected.

Type: Element

Defined by SingleSelectionMixin inherited from SlidingStage

selectFirst() method

Select the first item in the list.

Returns: Boolean True if the selection changed, false if not.

Defined by SingleSelectionMixin inherited from SlidingStage

selectionRequired property

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

Type: boolean

Default: false

Defined by SingleSelectionMixin inherited from SlidingStage

selectionWraps property

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

Type: boolean

Default: false

Defined by SingleSelectionMixin inherited from SlidingStage

selectLast() method

Select the last item in the list.

Returns: Boolean True if the selection changed, false if not.

Defined by SingleSelectionMixin inherited from SlidingStage

selectNext() method

Select the next item in the list.

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

Returns: Boolean True if the selection changed, false if not.

Defined by SingleSelectionMixin inherited from SlidingStage

selectPrevious() method

Select the previous item in the list.

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

Returns: Boolean True if the selection changed, false if not.

Defined by SingleSelectionMixin inherited from SlidingStage

setState(changes) method

Update the component's state by merging the specified changes on top of the existing state. If the component is connected to the document, and the new state has changed, this returns a promise to asynchronously render the component. Otherwise, this returns a resolved promise.

Parameters:
  • changes: objectthe changes to apply to the element's state

Returns: Promise - resolves when the new state has been rendered

Defined by ReactiveMixin inherited from ReactiveElement

shouldComponentUpdate(nextState) method

Return true if the component should update.

The default implementation does a shallow check of property values like React's PureComponent. This seems adequate for most web components. You can override this to always return true (like React's base Component class), or to perform more specific, deeper checks for changes in state.

Parameters:
  • nextState: objectthe proposed new state for the element

Returns: boolean - true if the component should update (rerender)

Defined by ReactiveMixin inherited from ReactiveElement

state property

The component's current state. The returned state object is immutable. To update it, invoke setState.

Type: object

Defined by ReactiveMixin inherited from ReactiveElement

suppressFocusVisibility() method

Temporarily suppress visibility of the keyboard focus until the next keydown event.

This can be useful in components like Menu that actively manage where the focus is in response to mouse hover activity. If the user uses the keyboard to invoke a menu, then changes to using the mouse, it can be distracting to see the focus indicator moving as well. In such situations, the component can invoke this method (e.g., in response to mousemove) to temporarily suppress focus visibility.

Defined by FocusVisibleMixin

symbols.canGoLeft property

Returns true if it's currently possible to go left.

Type: boolean

Defined by DirectionSelectionMixin

symbols.canGoRight property

Returns true if it's currently possible to go right.

Type: boolean

Defined by DirectionSelectionMixin

symbols.goDown() method

Invoked when the user wants to go/navigate down. The default implementation of this method does nothing.

Defined by KeyboardDirectionMixin

symbols.goDown() method

Invokes selectNext to select the next item.

Defined by DirectionSelectionMixin

symbols.goEnd() method

Invoked when the user wants to go/navigate to the end (e.g., of a list). The default implementation of this method does nothing.

Defined by KeyboardDirectionMixin

symbols.goEnd() method

Invokes selectLast to select the next item.

Defined by DirectionSelectionMixin

symbols.goLeft() method

Invoked when the user wants to go/navigate left. The default implementation of this method does nothing.

Defined by KeyboardDirectionMixin

symbols.goLeft() method

Invokes selectPrevious to select the previous item.

If the element has a rightToLeft property and it is true, then this selects the next item.

Defined by DirectionSelectionMixin

symbols.goRight() method

Invokes selectNext to select the next item.

If the element has a rightToLeft property and it is true, then this selects the previous item.

Defined by DirectionSelectionMixin

symbols.goRight() method

Invoked when the user wants to go/navigate right. The default implementation of this method does nothing.

Defined by KeyboardDirectionMixin

symbols.goStart() method

Invokes selectFirst to select the first item.

Defined by DirectionSelectionMixin

symbols.goStart() method

Invoked when the user wants to go/navigate to the start (e.g., of a list). The default implementation of this method does nothing.

Defined by KeyboardDirectionMixin

symbols.goUp() method

Invoked when the user wants to go/navigate up. The default implementation of this method does nothing.

Defined by KeyboardDirectionMixin

symbols.goUp() method

Invokes selectPrevious to select the previous item.

Defined by DirectionSelectionMixin

symbols.keydown() method

See the symbols documentation for details.

Defined by KeyboardMixin

updates property

The attributes and properies that should be applied to the component on render. By default, this is an empty plain object. Your mixin or component can extend this to identify the properties to set on the host element or elements in the shadow subtree.

Type: object

Defined by RenderUpdatesMixin inherited from ReactiveElement