Skip to content

jojoee/fastest-slider-js

Repository files navigation

FastestSlider (fastest-slider-js)

Bower Version Npm Version Release Version Downloads

Another fastest slider

screenshot 1

Install

1: npm

1.1 Install npm
1.2 Install package: `npm install --save fastest-slider-js`

2: bower

2.1 Install npm
2.2 Install bower: `npm install -g bower`
2.3 Install package: `bower install --save fastest-slider-js`

Normal usage

1. Html structure

<div class="wrap normal-slide">
  <div class="title">Normal</div>

  <div class="items">
    <div class="item">1</div>
    <div class="item">2</div>
    <div class="item">3</div>
    <div class="item">4</div>
    <div class="item">5</div>
    <div class="item">6</div>
  </div>

  <div class="pagi">
    <div class="pagi-arrow arrow-prev">&lt;</div>
    <div class="pagi-arrow arrow-next">&gt;</div>
  </div>
</div><!-- .normal-slide -->

2. Javascript

var normal = new FastestSlider({
  // required
  selector: '.normal-slide .items',

  // non-required
  autoSlide: false,
  slideSpeed: 2000,
  isDebug: true,
  prevArrow: '.normal-slide .arrow-prev',
  nextArrow: '.normal-slide .arrow-next',
});

/* default non-required option */
autoSlide: false,
slideSpeed: 2000,
isDebug: false,
prevArrow: '',
nextArrow: '',

Note

Getting Started for dev

  1. Install Node.js
  2. Set path (e.g. cd C:\xampp\htdocs\jojoee.com\fastest-slider-js)
  3. Install global: npm install -g gulp bower browser-sync
  4. Install dependencies: bower install && npm install
  5. Start: gulp to build and gulp watch to dev

TODO

  • Implement JSHint into task runner
  • Complete DocBlockr
  • Unit test
  • Add .min file (uglify)
  • Inject compliled css without refresh (gulpfile.js)
  • Fix Travis CI
  • Support ES6
  • Separate utilities function into another files
  • Add .npmignore
  • Implement ci.testling.com
  • Add E2E testing script by Nightwatch.js
  • Localization

Changelog

1.1.0
- Add 3 public APIs (goToNext, goToPrev, goTo)

1.0.0
- First release