SlidingPages

Simple carousel with no visible UI controls
Mountain lake Terraced farm Winter trees Forest river Red panda
Demo: You can navigate sliding pages with touch/mouse/keyboard/trackpad

Overview

A typical carousel with a sliding effect. The user can move between items with touch, the mouse, the keyboard, or a 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.

See also

Carousel
Carousel with a sliding effect and navigation controls
Modes
Shows a single panel at a time
SlidingStage
Slides between selected items on a horizontal axis

API

Ancestry: SlidingPages → SlidingStageReactiveElement → HTMLElement

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

$ property

A convenient shortcut for looking up an element by ID 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. The $ function is simply a shorthand for getElementById, so this.$.foo is the same as this.shadowRoot.getElementById('foo').

Type: object

Defined by ShadowTemplateMixin

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

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

defaultState property

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

Type: State

Defined by ReactiveMixin

items property

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

Type: Array.|null

Defined by ContentItemsMixin

items-changed event

Raised when the items property changes.

Defined by ContentItemsMixin

render() method

Render pending component changes 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

selected-index-changed event

Raised when the selectedIndex property changes.

Defined by SingleSelectionMixin

selectedIndex property

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

Type: number

Defined by SingleSelectionMixin

selectedItem property

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

Type: Element

Defined by SingleSelectionMixin

selectFirst() method

Select the first item in the list.

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

Defined by SingleSelectionMixin

selectionRequired property

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

Type: boolean

Default: false

Defined by SingleSelectionMixin

selectionWraps property

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

Type: boolean

Default: false

Defined by SingleSelectionMixin

selectLast() method

Select the last item in the list.

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

Defined by SingleSelectionMixin

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

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

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

state property

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

Type: State

Defined by ReactiveMixin

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.contentSlot] property

Defined by SlotContentMixin

[symbols.goDown]() method

Invokes selectNext to select the next item.

Defined by DirectionSelectionMixin

[symbols.goEnd]() method

Invokes selectLast to select the next item.

Defined by DirectionSelectionMixin

[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.goStart]() method

Invokes selectFirst to select the first item.

Defined by DirectionSelectionMixin

[symbols.goUp]() method

Invokes selectPrevious to select the previous item.

Defined by DirectionSelectionMixin

[symbols.itemMatchesState](item, state) method

Returns true if the given item should be shown in the indicated state.

Parameters:

  • item: HTMLElement|SVGElement
  • state: PlainObject

Returns: boolean

Defined by ContentItemsMixin

[symbols.keydown]() method

See the symbols documentation for details.

Defined by KeyboardMixin

[symbols.render](changed) method

Internal method for rendering any recent changes in state to the DOM.

The default implementation of this method does nothing. Override this method in your component to update your component's host element and any shadow elements to reflect the component's new state. See the rendering example.

Be sure to call super in your method implementation so that your component's base classes and mixins have a chance to perform their own render work.

Parameters:

  • changed: objectdictionary of flags indicating which state members have changed since the last render

Defined by ReactiveMixin

[symbols.swipeDown]() method

Invokes the symbols.goDown method.

Defined by SwipeDirectionMixin

[symbols.swipeLeft]() method

Invokes the symbols.goRight method.

Defined by SwipeDirectionMixin

[symbols.swipeRight]() method

Invokes the symbols.goLeft method.

Defined by SwipeDirectionMixin

[symbols.swipeTarget] property

Type: HTMLElement

Defined by TouchSwipeMixin

[symbols.swipeUp]() method

Invokes the symbols.goUp method.

Defined by SwipeDirectionMixin