Class Carousel

constructor

• new Carousel(el, options?): Carousel

• Creates an instance.

  Parameters

  • el: Element

    is the dom element to control. This should be a container element that holds child elements that will scroll horizontally.

  • options: Options = {}

    are the options to configure this instance.

  Returns Carousel

behavior

el

• get el(): Element

• Returns the dom element reference of the carousel which was passed into the constructor.

  Returns Element

  the controlled dom element

id

• get id(): string

• Returns the id-attribute value of the carousel.

  Returns string

  the id of the controlled dom element

index

• get index(): Index

• Returns the current index of the carousel. The returned index is a list (array) of indexes that are currently visible (depending on each item width).

  Returns Index

  a list of visible indexes
• set index(values): void

• Sets the current index of the carousel. To set an index you need to pass an array with at least one element. When passing more than one, the rest will be ignored.

  Parameters

  • values: Index

    are the upcoming indexes

  Returns void

items

• get items(): HTMLElement[]

• Returns an array of all child dom elements of the carousel.

  Returns HTMLElement[]

  a list of elements (child elements of the root element)

mask

• get mask(): null | Element

• Returns the dom element reference of the mask element that wraps the carousel element.

  Returns null | Element

  the mask dom element

pageIndex

• get pageIndex(): number

• Returns the index of the current page.

  Returns number

  the index of the current page

pages

• get pages(): Pages

• Returns an array of all pages. Each page is a group of indexes that matches a page.

  Returns Pages

  the list of pages and indexes inside each page

destroy

• destroy(): void

• This completely deconstructs the carousel and returns the dom to its initial state.

  Returns void

update

• update(): void

• Enforces an update of all enabled components of the carousel. This is, for example, useful when changing the number of items inside the carousel. This also forwards an update call to all attached features.

  Returns void