Skip to content

Latest commit

 

History

History
227 lines (163 loc) · 7.04 KB

README.md

File metadata and controls

227 lines (163 loc) · 7.04 KB

Infinite Swipe Build Status

Infinite Swipe is simple swipe library that can use for both desktop and mobile devices.

How it works

Place target at stage that shows UI. If target has N pages, target should be N times than stage.

How Infinite Swipe Works

bower install infinite-swipe

Very simple example

Load swipe.min.js, swipe.min.css first. Please note that the jQuery library include before swipe.min.js.

<link rel="stylesheet" href="path/to/swipe.min.css">
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
<script src="path/to/swipe.min.js"></script>

Prepare HTML codes like belows. You can specify your own class name than stage or target.

<div class="stage">
  <ul class="target">
    <li><img alt="" src="https://goonoo.github.io/infinite-swipe/sample/img/1.png" width="300" height="300"></li>
    <li><img alt="" src="https://goonoo.github.io/infinite-swipe/sample/img/3.png" width="300" height="300"></li>
    <li><img alt="" src="https://goonoo.github.io/infinite-swipe/sample/img/5.png" width="300" height="300"></li>
  </ul>
</div>

Defines the initial state of stage and target in CSS codes.

ul, li { /* reset for default ui, li selector */
  margin: 0;
  padding: 0;
  list-style: none;
}
.stage {
  width: 300px;
  height: 300px;
  overflow: hidden;
}
.target {
  width: 900px;
}
.target li {
  float: left;
}

Run swipe function via javascript code.

$('.stage').infiniteSwipe({
  $target: $('.target'),
  total: 3 // total 3 pages
});

Check the results with above codes? You can check swipe function with touch devices. If you uses no touch devices(with mouse, and so on), check prev, next buttons example instead.

Run very simple example

Infinite Swipe

With infinite option, you can create an infinite swipe.

$('.stage').infiniteSwipe({
  $target: $('.target'),
  total: 3,
  infinite: true
});

Infinite Swipe Demo

Prev, Next Buttons

Add markup used to prev / next buttons and specify that with the jQuery element, each $prev, $next option, you can make previous, next button functions.

<div class="stage">
  <ul class="target">
    <li><img alt="" src="https://goonoo.github.io/infinite-swipe/sample/img/1.png" width="300" height="300"></li>
    <li><img alt="" src="https://goonoo.github.io/infinite-swipe/sample/img/3.png" width="300" height="300"></li>
    <li><img alt="" src="https://goonoo.github.io/infinite-swipe/sample/img/5.png" width="300" height="300"></li>
  </ul>
  <div class="prev"></div>
  <div class="next"></div>
</div>

Add $prev, $next options to javascript codes.

$('.stage').infiniteSwipe({
  $target: $('.target'),
  total: 3,
  $prev: $('.prev'),
  $next: $('.next')
});

The following is a sample CSS code for Prev, Next buttons. If you do not specify an infinite option, the class disabled is added to the prev button at first page, and the next page button at last page.

.prev{cursor:pointer;position:absolute;top:350px;left:100px;width:47px;height:25px;background:url(http://goonoo.github.io/infinite-swipe/images/prev.png) no-repeat 0 0;}
.prev.disabled{cursor:default;opacity:.3}
.next{cursor:pointer;position:absolute;top:350px;right:100px;width:47px;height:25px;background:url(http://goonoo.github.io/infinite-swipe/images/next.png) no-repeat 0 0;}
.next.disabled{cursor:default;opacity:.3}

Prev, Next Buttons Demo

With infinite option, prev, next buttons also works as infinite swipe.

$('.stage').infiniteSwipe({
  $target: $('.target'),
  total: 3,
  $prev: $('.prev'),
  $next: $('.next'),
  infinite: true
});

Prev, Next Buttons + infinite option Demo

Show current page

When you add markup to display the current page number and specify the jQuery Element as $curr options, you can make the element as the current page indicator.

<div class="stage">
  <ul class="target">
    <li><img alt="" src="https://goonoo.github.io/infinite-swipe/sample/img/1.png" width="300" height="300"></li>
    <li><img alt="" src="https://goonoo.github.io/infinite-swipe/sample/img/3.png" width="300" height="300"></li>
    <li><img alt="" src="https://goonoo.github.io/infinite-swipe/sample/img/5.png" width="300" height="300"></li>
  </ul>
  <div class="prev"></div>
  <div class="pages">
    <strong class="curr">1</strong>
    /
    <span class="total">3</span>
  </div>
  <div class="next"></div>
</div>

Add $curr option to javascript codes.

$('.stage').infiniteSwipe({
  $target: $('.target'),
  total: 3,
  $prev: $('.prev'),
  $next: $('.next'),
  $curr: $('.curr')
});

Below is CSS code example for current page.

.pages {position:absolute;top:350px;left:100px;width:100px;text-align:center;}
.curr {color:red}

Prev, Next Buttons + current page option Demo

Responsive Swipe

Infinite swipe basically support responsive design!

check Responsive swipe example.

Options

Options for Infinite Swipe.

  • $target_wrap: (Optional) set content wrapper element as jQuery element. (set target_wrap element let swiping performance better)
  • $target: (Required) set content element as jQuery element.
  • total: (Required) Set total page count.
  • $prev: set previous button as jQuery Element.
  • $next: set next button as jQuery Element.
  • infinite: set boolean to use infinite scroll or not. (default: false)
  • $curr: set element to display current page number as jQuery Element.
  • transition_ms: set swipe transition speed as milliseconds. (default: 300)
  • animation_type: set animation type (default: 'slide') ['fadeIn', 'slide', 'none']
  • onPage: event that fires when page changed. Pass page number with first argument.
  • $autoswipe_pause_el: jQuery Element that pause autoswipe when user mouseenter or focus in (default: stage element)

Methods

swipe_total event: change total page count

$('.stage').trigger('swipe_total', 5);

swipe_page event: change current page. ignore if presented page is larger then total page count.

$('.stage').trigger('swipe_page', 1);

destroy: destroy method for infinite swipe instance. this remove css classes and unregister events for infinite swipe.

$('.stage').infiniteSwipe('destroy');

Live Example