Options
All
  • Public
  • Public/Protected
  • All
Menu

Carousel

Example

<section id="slide">
  <ul>
    <li>slide 1</li>
    <li>slide 2</li>
    <li>slide 3</li>
  <ul>
</section>
const slide = new Carousel(document.getElementById('slide'), {
  selectors: {
    item: 'li' // by default
  },
  speed: 500, // by default
  threshold: .4, // by default
  resistance: .4, // by default
  delay: 4000 // by default
  auto: true,
  index: 1,
});

// triggered before slide
slide.on('slide', (current, next) => {})

// triggered after slide
slide.on('slideChange', (current, previous) => {})

Hierarchy

  • EventEmitter
    • Carousel

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

host

host: HTMLElement

Methods

destroy

  • destroy(): void
  • Destroy instance, remove all listeners

    Returns void

next

  • next(): Promise<boolean>

off

  • off(type: string, handler: function): void
  • Remove an event handler for the given type.

    Parameters

    • type: string

      Type of event to unregister handler from, or "*"

    • handler: function

      Handler function to remove

        • (event?: any): void
        • Parameters

          • Optional event: any

          Returns void

    Returns void

on

  • on(type: string, handler: function): void
  • Register an event handler for the given type.

    Parameters

    • type: string

      Type of event to listen for, or "*" for all events

    • handler: function

      Function to call in response to given event

        • (event?: any): void
        • Parameters

          • Optional event: any

          Returns void

    Returns void

prev

  • prev(): Promise<boolean>

setup

  • setup(): void

slide

  • slide(index: number): Promise<boolean>
  • Slide to item

    Parameters

    • index: number

    Returns Promise<boolean>

start

  • start(): void

stop

  • stop(): void

Static config

Generated using TypeDoc