Skip to content

Commit

Permalink
Merge branch 'release/0.3'
Browse files Browse the repository at this point in the history
  • Loading branch information
Vipul Kapoor committed Apr 25, 2019
2 parents e1ac46e + 667251a commit f842c52
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
# partialViewSlider
An extremely lightweight (8kb minified) jQuery slider that shows part of adjacent slides to the left and right.
An extremely lightweight (9kb minified) jQuery slider that shows part of adjacent slides to the left and right.

## Features
* Lightweight and Fast
* Responsive
* Touch ready
* Multiple modes (Partial View, Perspective, Regular)
* Adjustable center and side widths
* [NEW] Added option to display multiple items

## Getting Started
Include the required files
```
<link rel="stylesheet" type="text/css" href="dist/partialviewslider.min.css">
<link rel="stylesheet" type="text/css" href="dist/partialViewSlider.min.css">
<script src="src/jquery-3.3.1.min.js"></script>
<script src="dist/partialviewslider.min.js"></script>
<script src="dist/partialViewSlider.min.js"></script>
```
Add some html
```
Expand Down Expand Up @@ -54,6 +55,7 @@ $(document).ready(function(){
| pauseOnHover | boolean | true | Whether autoplay can be paused when slider is hovered |
| keyboard | boolean | true | Whether slider can be controled with keyboard left/right arrow keys |
| perspective | boolean | false | Enable this to make adjoining slides smaller giving a perspective carousel look |
| items | object | {"0": 1}| Show multiple items at once. This is an object of resolutions and number of items above that resolution. For instance: `{"0": 1, "600": 2, "992": 3}` will show one item upto 600px, 2 items above 600px and and 3 items at 992px and above. Partial view is disabled if number of items are more than 1 |
| prevHtml | string | \<i class="material-icons">chevron_left\</i> | Html for previous slide button |
| nextHtml | string | \<i class="material-icons">chevron_right\</i> | Html for next slide button |

Expand Down

0 comments on commit f842c52

Please sign in to comment.