README.md

Luna Carousel

Lightweight carousel.

Demo

https://luna.liriliri.io/?path=/story/carousel

Install

Add the following script and style to your page.

<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/luna-carousel/luna-carousel.css" />
<script src="//cdn.jsdelivr.net/npm/luna-carousel/luna-carousel.js"></script>

You can also get it on npm.

npm install luna-carousel --save

import 'luna-carousel/luna-carousel.css'
import LunaCarousel from 'luna-carousel'

Usage

const container = document.getElementById('container')
const carousel = new LunaCarousel(container, { interval: 5000 })
carousel.append('<div style="background:#e73c5e;">ITEM 1</div>')

Configuration

• interval(number): Time between automatically cycling.

Api

append(content: string | HTMLElement): void

Append item.

clear(): void

Clear all items.

cycle(): void

Cycle through the carousel items.

getActiveIdx(): number

Get current index, starting from 0, -1 means no items.

insert(pos: number, content: string | HTMLElement): void

Insert item at given position.

next(): void

Slide to the next item.

pause(): void

Stop cycling.

prev(): void

Slide to the previous item.

slideTo(idx: number): void

Slide to the item at given index.