Skip to content
This repository has been archived by the owner on Jul 1, 2023. It is now read-only.

AlekseyLeshko/testimonial.js

Repository files navigation

GitHub version Build Status Build Status Dependency Status devDependency Status Code Climate Test Coverage Coverage Status NPM version Bower version NPM NPM

<iframe src="//benschwarz.github.io/bower-badges/embed.html?pkgname=testimonial" width="160" height="32" allowtransparency="true" frameborder="0" scrolling="0"></iframe> > JS testimonial slider with AJAX!

Site with examples

Install

with npm

npm i -D testimonial

with bower

bower install testimonial --save-dev

Usage

Slider simple use

var testimonial = new Testimonial('#testimonial-slider');

Slider with custom options

var options = {
    width: 645,
    timeout: 7000,
    autostart: true,
    slideCount: 3
};
var testimonial = new Testimonial('#testimonial-slider', options);

Slider API

var slideObj = {...};
var testimonial = new Testimonial('#testimonial-slider');
testimonial.stop();
testimonial.start();
testimonial.next();
testimonial.add(slideObj);

Slider with ajax slide load

function getSlide() {
  var slide = getRandomSlide();
  return slide;
};
var options = {
    width: 645,
    timeout: 7000,
    autostart: true,
    slideCount: 3,
    getSlide: getSlide
};

var testimonial = new Testimonial('#testimonial-slider', options);

Structure of the slide

  • author
    • name
    • url
    • avatar(url)
  • company
    • name
    • url
  • quote

Options

  • width, type: Number, default: 700
  • slideCount, type: Number, default: 3
  • timeout, type: Number, default: 7000
  • autostart, type: Boolean, default: true
  • getSlide, type: Function, default: undefined

Build project

make

License

Copyright (c) 2014 Aleksey Leshko Licensed under the The MIT License (MIT)

Bitdeli Badge