Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ujw0l/carousel.js

Javascript library to create image carousel
https://github.com/ujw0l/carousel.js

carousel image-carousel javascript-library vanilla-js

Last synced: 22 days ago
JSON representation

Javascript library to create image carousel

Awesome Lists containing this project

README

        

Welcome to ctc-carousel-js 👋





Documentation


Maintenance


License: MIT

> Javascript library to create image carousel.
## Usage

```sh
Library lets you create image carousel for one or multiple image gallery
```

## Install

```sh
npm i ctc-carousel-js
```

## Script Tag

```sh
Dowload and include following file:

carousel.js
```

## Options

```sh
new ctcCarousel('selector1,selector2',{autoPlay: true, autoPlayInterval: number, autoPlaySelector: 'selector'},{callBack:function} );

First Parameter : one or multiple selector to apply carousel.

Second Parameter :

autoPlay : boolean, (Optional, set true to activate slide autoplay)
autoPlayInterval : number, (Optional,number for slide autoplay interval in micro seconds default 1000) )
autoPlaySelector : 'selectors', (one or more element to set on autoplay (default all carousels will autoplay)

Third Parameter
callBack : function, (Function to be called when after setting up carousel)

Note 1 : Initialize carousel inside script tag on window onload or footer. (Selector should be wrapper element containing images)
Note 2 : Do not forget to set height and width of wrapper element.

```

## Contributing

Contributions, issues and feature requests are welcome. Feel free to check [issues page](https://github.com/ujw0l/carousel.js/issues) if you want to contribute.

## Author

👤 **ujw0l**

* Twitter 👉 [@bastakotiujwol](https://twitter.com/bastakotiujwol)
* Github 👉 [@ujw0l](https://github.com/ujw0l)

## Show your support

Please ⭐️ this repository if you like it.

## License

Copyright © 2019 [ujw0l](https://github.com/ujw0l).

📜 This project is [MIT](https://github.com/ujw0l/carousel.js/blob/master/LICENSE) licensed.

***
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_