ta-dah
v0.0.7
Published
Simple Carousel Library
Downloads
5
Readme
:tada: :carousel_horse: tada
Simple Carousel Library demo
Installing
Setup the html and add either class name or id name in the markup
<div class="carousel">
<ul>
<li><img /></li>
<li><img /></li>
<li><img /></li>
</ul>
</div>
OPTION 1: when using a module bundler like Webpack
$ npm install ta-dah --save-dev
import Tada from 'ta-dah';
new Tada({
selector: ".carousel"
});
OPTION 2: when injecting the minified script into your project.
<script src="tada.min.js"></script>
<script>
const carousel = new Tada({
selector: ".carousel"
});
</script>
We also provide a CDN option from rawgit.com. CDN
Configuration
In this carousel library, there are few options and events.
Settings
| option | desc | default | |-----------------|------|---------| | navigator | can show navigator | false | | pagination | can show pagination | false | | paginationShape | can set two types of shape: circle, bar | circle |
For example,
<script>
const carousel = new Tada({
selector: ".tada-class",
navigator: true,
pagination: true,
paginationShape: bar
});
</script>
Events
| event | desc | |-------|------| | right | the event when clicking right navigator | | left | the event when clicking left navigator |
For example,
<script>
const carousel = new Tada({
selector: ".carousel"
});
carousel.on("right", function(e) {
console.log("right");
});
</script>
Versioning
0.0.5
Special Thanks
@hyeonmi @CoderK
License
MIT License
Copyright (c) 2018 ZAGDANG
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.