flipping-cards
v2.1.0
Published
Flipping Cards Carousel
Downloads
8
Readme
flipping-cards
Flipping Cards Carousel
Demo and usage
Usage
For using Flipping Cards Carousel on a web page use linking to the library and the styles:
<link rel="stylesheet" href="/path/to/styles/flipping.css" />
<script src="/path/to/flipping.js"></script>
On the page put the code for the carousel. For example:
<div id="flipping_cards" class="flipping">
<div class="btn-backward"></div>
<div class="cards">
<div>
<h2>Custom text 1</h2>
<img src="images/pic1.jpg"/>
</div>
<div>
<span>Custom text 2</span>
<img src="images/pic2.jpg"/>
</div>
<div>
<b>Custom text 3</b>
<img src="images/pic3.jpg"/>
</div>
...
</div>
<div class="btn-forward"></div>
</div>
Each <div>
item inside the element<div class="cards">
is a card with your custom html content.
Initialization
Initialize the component by calling flipping.init('flipping_cards', configuration)
where the first parameter corresponds to the id
of the html-tag of the carousel.
document.addEventListener("DOMContentLoaded", function () {
var configuration = {
autoFlipMode: false,
autoFlipDelay: 1500,
pauseMouseOver: true,
cardsShadow: true,
buttonShadow: true,
transitionDuration: 700,
rotationMode: "sequential",
sequentialDelay: 600,
cardWidth: 150,
cardHeight: 180,
spacingHorizontal: 15,
spacingVertical: 15,
cardsToShow: 3,
cardsPerRow: 3,
startFromIndex: 1,
buttonBackwardHtml: "◄",
buttonForwardHtml: "►"
};
flipping.init('flipping_cards', configuration);
});
Installation
First, install the package using npm:
npm install flipping-cards --save
Then, require the package and use it like so:
import flipping from "flipping-cards";
import "flipping-cards/dist/css/flipping.css";
Options
autoFlipMode
: [true | false] - start flipping in automatic modeautoFlipDelay
: [ms] - delay before the next set of cards in automatic modecardsShadow
: [true | false] - on/off cards shadowbuttonsShadow
: [true | false] - on/off buttons shadowtransitionDuration
: [ms] - card flip transition durationrotationMode
: [simultaneous | sequential] - simultaneous or sequential modesequentialDelay
: [ms] - sequential delay before neighboring cards flipcardWidth
: [px] - card widthcardHeight
: [px] - card heightspacingHorizontal
: [px] - horizontal cards spacingspacingVertical
: [px] - vertical cards spacingcardsToShow
: [num] - number of cards to showcardsPerRow
: [num] - number of cards per rowstartFromIndex
: [num] - starter set of cardsbuttonBackwardHtml
: [html] - backward button html codebuttonForwardHtml
: [html] - forward button html code
Supports:
- Forward / backward flip
- Number of cards per row or column
- Custom items sizes
- Custom animation delays
- Simultaneous and sequential rotation mode
- Automatic flip mode
Browser Support:
- Google Chrome 36+
- Mozilla Firefox 16+
- Internet Explorer 10+
- Apple Safari 9+
- Opera 23+
Demo
To run demo locally:
$ git clone https://github.com/mad48/flipping-cards.git
Then open .../flipping-cards/demo/index.html as local file in your browser.