1.0.1 • Published 7 years ago

mk-3dcarousel v1.0.1

Weekly downloads
4
License
MIT
Repository
github
Last release
7 years ago

mk-3Dcarousel

This is a responsive 3D Image Carousel created using JQUERY, CSS3.

STEPS TO USE

Install jQuery

  $ npm install --save jquery

Install mk-3Dcarousel

  $ npm install --save mk-3Dcarousel

Include the following in your page:

  • jQuery
  • mk-3dcarousel.js
  • mk-3dcarousel.css
HTML
  <div class="mk-carousel" id="mkCarousel">
  	<img class="active" src="<your-path>/file-name-01.jpg" alt="Some Title">
  	<img src="<your-path>/file-name-02.jpg" alt="Some Title">
  	<!-- image list goes here -->
  </div>
JS
  $(function(){
  	$('#mkCarousel').mkCarousel();
  });
CUSTOMIZE
  $(function(){
  	$('#mkCarousel').mkCarousel({
  		// propertyName: value
  		// custom configuration goes here
  	});
  });
OPTIONS
PropertyDescriptionTypeDefault value
responsiveMakes carousel responsivebooleantrue
breakpointA point from where carousel will handle responsivenessint768
offsetSpacing between carousel images for desktop viewint100
mobileOffsetSpacing between carousel images for mobile viewint50
controlNavsShow control navigation, ex: prev, nextbooleantrue
prevTextChange the text of previous buttonstringPrev
nextTextChange the text of next buttonstringNext
beginAtSet an inital active imageint1
LIVE EXAMPLES
SUPPORT

IE 10+, Firefox 10+, Google Chrome 12+, Safari 9+, Android Browser 3+

NOTE

Images are taken from Google

LICENSE

The MIT License (MIT)

Copyright (c) 2015 Masoom

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.