Slideshow

<auro-slideshow> is an HTML custom element for the purpose of displaying a sequence of slides, which can automatically advance through the content or be manually controlled by the user.

The <auro-slideshow> component is a wrapper element. All slides are slotted content and must be direct children of the component. Slides must have assigned width and height properties to display properly.

<auro-slideshow> is a fully customizable component and does not come with any features turned on by default. The features of <auro-slideshow> are turned on by including the proper attributes on the element.

Note: If all the slides can fit on the page at once, the slideshow will not activate.

Properties usage

autoplay and autoScroll are mutually exclusive properties and should not be used together on the same component instance.

Both navigation and pagination can be used together, but at least one must be used to give users a clear way to control the slides manually.

Mobile behavior

On mobile devices, autoScroll and navigation controls are automatically disabled. Users can navigate the slideshow by swiping left or right.

UI development browser support

For the most up to date information on UI development browser support

Install

$ npm i @aurodesignsystem/auro-slideshow

Design Token CSS Custom Property dependency

The use of any Auro custom element has a dependency on the Auro Design Tokens.

Define dependency in project component

Defining the component dependency within each component that is using the <auro-slideshow> component.

import "@aurodesignsystem/auro-slideshow";

Reference component in HTML

  <auro-slideshow>
    <div style="height: 480px">
      <img style="object-fit: cover;" src="https://picsum.photos/1000/480?random=1" alt="Random image 1">
    </div>
    <div style="height: 480px">
      <img style="object-fit: cover;" src="https://picsum.photos/1000/480?random=2" alt="Random image 2">
    </div>
    <div style="height: 480px">
      <img style="object-fit: cover;" src="https://picsum.photos/1000/480?random=3" alt="Random image 3">
    </div>
    <div style="height: 480px">
      <img style="object-fit: cover;" src="https://picsum.photos/1000/480?random=4" alt="Random image 4">
    </div>
    <div style="height: 480px">
      <img style="object-fit: cover;" src="https://picsum.photos/1000/480?random=5" alt="Random image 5">
    </div>    
  </auro-slideshow>

Use CDN

In cases where the project is not able to process JS assets, there are pre-processed assets available for use. Legacy browsers such as IE11 are no longer supported.

<script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-slideshow@latest/+esm"></script>

auro-slideshow use cases

The <auro-slideshow> element should be used in situations where:

• A series of images or content needs to be displayed in a space-saving way
• Autoplaying or autoscrolling functionality is needed
• A current slide indicator is required

API Code Examples

Default auro-slideshow

  <auro-slideshow>
    <div style="height: 480px">
      <img style="object-fit: cover;" src="https://picsum.photos/1000/480?random=1" alt="Random image 1">
    </div>
    <div style="height: 480px">
      <img style="object-fit: cover;" src="https://picsum.photos/1000/480?random=2" alt="Random image 2">
    </div>
    <div style="height: 480px">
      <img style="object-fit: cover;" src="https://picsum.photos/1000/480?random=3" alt="Random image 3">
    </div>
    <div style="height: 480px">
      <img style="object-fit: cover;" src="https://picsum.photos/1000/480?random=4" alt="Random image 4">
    </div>
    <div style="height: 480px">
      <img style="object-fit: cover;" src="https://picsum.photos/1000/480?random=5" alt="Random image 5">
    </div>    
  </auro-slideshow>

Development

In order to develop against this project, if you are not part of the core team, you will be required to fork the project prior to submitting a pull request.

Please be sure to review the contribution guidelines for this project. Please make sure to pay special attention to the conventional commits section of the document.

Start development environment

Once the project has been cloned to your local resource and you have installed all the dependencies you will need to open a shell session to run the dev server.

$ npm run dev

Open localhost:8000

Testing

Automated tests are required for every Auro component. See .\test\auro-slideshow.test.js for the tests for this component. Run npm run test to run the tests and check code coverage. Tests must pass and meet a certain coverage threshold to commit. See the testing documentation for more details.