open-ada-slider v1.0.18

Open ADA Slider

A no-CSS-required slider component designed to comply with the accessibility standards set forth by the ADA. This slider is fully customizable, lightweight, and easy to integrate into any web application or framework.

Example

Run Demo

Usage

In your Javascript file:

import {
  OSlider,
  OSliderNext,
  OSliderPrev,
  OSliderPage,
  OSliderAutoplayControls,
  OSliderPaginationText
} from "open-ada-slider"

customElements.define('o-slider', OSlider)
customElements.define('o-slider-next', OSliderNext, { extends: 'button' })
customElements.define('o-slider-prev', OSliderPrev, { extends: 'button' })
customElements.define('o-slider-page', OSliderPage, { extends: 'button' })
customElements.define('o-slider-autoplay-controls', OSliderAutoplayControls)
customElements.define('o-slider-pagination-text', OSliderPaginationText)

In your HTML:

<h2>Simple Example</h2>
<o-slider id="example-1">
  <div class="slide">Slide 1</div>
  <div class="slide">Slide 2</div>
  <div class="slide">Slide 3</div>
</o-slider>
<button is="o-slider-prev" slider="example-1">Prev</button>
<button is="o-slider-page" slider="example-1" index="0">1</button>
<button is="o-slider-page" slider="example-1" index="1">2</button>
<button is="o-slider-page" slider="example-1" index="2">3</button>
<button is="o-slider-next" slider="example-1">Next</button>
<o-slider-pagination-text slider="example-1"></o-slider-pagination-text>  

<h2>Complex Example</h2>
<o-slider 
  id="example-2"
  slide-speed="1000"
  slides-per-page="3"
  slides-per-page-1024="2"
  slides-per-page-768="1"
  autoplay="true"
  autoplay-speed="12000"
  swipe-threshold="100"
  slide-alignment="stretch"
  adaptive-height="false"
>
  <div class="slide">Slide 1</div>
  /* ... */
  <div class="slide">Slide 12</div>
</o-slider>
<button is="o-slider-prev" slider="example-2">Prev</button>
<button is="o-slider-page" slider="example-2" index="0">1</button>
/* ... */
<button is="o-slider-page" slider="example-2" index="11">12</button>
<button is="o-slider-next" slider="example-2">Next</button>
<o-slider-autoplay-controls slider="example-2">
  <button slot="play">Play</button>
  <button slot="pause">Pause</button>
</o-slider-autoplay-controls>
<o-slider-pagination-text slider="example-2"></o-slider-pagination-text>  

Settings

slide-speed

Description: The speed, in milliseconds, of the slide transition animation.

Type: Int

Default value: 1000

Example: <o-slider id="example" slide-speed="350">

slides-per-page

Description: Determines how many slides per page the slider should display by default

Type: Int

Default value: 1

Example: <o-slider id="example" slides-per-page="3">

slides-per-page-*

Description: A responsive property that controls the number of slides displayed per page based on the screen size. The * should be replaced with a specific number representing the screen size range in pixels.

Type: Int

Default value: null

Example: <o-slider id="example" slides-per-page="2" slides-per-page-768="1">

autoplay

Description: Sets the slider to auto advance without user interaction. Setting this to true is discouraged.

Type: Bool

Default value: false

Example: <o-slider id="example" autoplay="true">

autoplay-speed

Description: The speed, in milliseconds, of the slide transition animation.

Type: Int

Default value: 12000

Example: <o-slider id="example" autoplay="true" autoplay-speed="12000">

swipe-threshold

Description: The minimum swipe distance in px to trigger a page change

Type: Int

Default value: 100

Example: <o-slider id="example" swipe-threshold="100">

slide-alignment

Description: How slides are positioned if they are not all the same side

Type: String

Default value: stretch

Valid values: stretch|top|bottom|center

Example: <o-slider id="example" slide-alignment="center">

adaptive-height

Description: Sets if the slider should resize to fit the tallest visible slide. This field only works if slide-alignment != stretch. Setting this to true is discouraged because it causes layout shifts.

Type: Boolean

Default value: false

Example: <o-slider id="example" slide-alignment="center" adaptive-height="true">

Events

pageUpdated

Description: An event that the slider fires anytime the current page is updated

Type: Event

Example: document.querySelector('o-slider#example').addEventListener('pageUpdated', () => console.log('page updated'))

Public Properties

currentPage

Description: The current active page

Type: Int

Example: document.querySelector('o-slider#example').currentPage

totalPages

Description: The current total pages

Type: Int

Example: document.querySelector('o-slider#example').totalPages

slidesPerPage

Description: The current responsive slides per page

Type: Int

Example: document.querySelector('o-slider#example').slidesPerPage

Public Methods

triggerResize

Description: Trigger the slider to recalculate its size

Example: document.querySelector('o-slider#example').triggerResize()

Dev

# install dependencies
npm install

# serve with hot reload at localhost:1234
npm run serve

Build

npm version {version}
npm publish