https://github.com/caiogondim/ken-burns-slideshow
:sparkler: A slideshow in JS with the Ken Burns effect.
https://github.com/caiogondim/ken-burns-slideshow
Last synced: 2 months ago
JSON representation
:sparkler: A slideshow in JS with the Ken Burns effect.
- Host: GitHub
- URL: https://github.com/caiogondim/ken-burns-slideshow
- Owner: caiogondim
- Created: 2015-06-03T21:20:49.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2018-04-03T14:44:26.000Z (about 7 years ago)
- Last Synced: 2025-03-24T21:51:09.958Z (3 months ago)
- Language: JavaScript
- Homepage: http://caiogondim.github.io/ken-burns-slideshow/
- Size: 117 KB
- Stars: 12
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ken-burns-slideshow
A slideshow in JS with the Ken Burns effect.
## Install
```bash
npm install --save ken-burns-slideshow
```
## Usage
Put a list of images on HTML:
```html
```
Start the library
```javascript
var slideshow = new KenBurnsSlideshow({
el: document.querySelector('ul')
})
```
## API
### contructor `new KenburnsSlideshow`
Creates in memory a new `KenBurnsSlideshow`. No side effects.
Properties passed on instantiation time
- `props.el`
- Type: `HTMLElement`
- Required: `true`
- `props.transitionDelay`
- Type: `Number`
- Default: 7000
- `props.cssPrefix`
- Type: `String`
- Default: 'ken-burns-slideshow'
### `init`
Starts the slideshow behaviour.
### `stop`
Stops the slideshow.
---
[caiogondim.com](https://caiogondim.com) ·
GitHub [@caiogondim](https://github.com/caiogondim) ·
Twitter [@caio_gondim](https://twitter.com/caio_gondim)