# jrcarousel

> jRCarousel - jQuery Responsive Carousel, lightweight responsive carousel plugin

Latest version **1.0.1** (published 2015-10-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install jrcarousel
pnpm add jrcarousel
yarn add jrcarousel
bun add jrcarousel
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2015-10-27 |
| First published | 2015-10-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+4 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Vinayak Rangnathrao Jadhav |
| Maintainers | vinayakjadhav |
| Keywords | jquery-plugin, ecosystem:jquery, jQuery Resposive Carousel, jRCarousel, Responsive Slider, Carousel, lightweight carousel |

## Links

- npm: https://www.npmjs.com/package/jrcarousel
- Repository: https://github.com/vinayakjadhav/jRCarousel
- Issues: https://github.com/vinayakjadhav/jRCarousel/issues
- npm.io page: https://npm.io/package/jrcarousel

## Dependencies (1)

- [jquery](https://npm.io/package/jquery.md) ^1.9.1

## Alternatives

- [adhdev](https://npm.io/package/adhdev.md) — 11.1K weekly downloads
- [react-slide-button](https://npm.io/package/react-slide-button.md) — 310 weekly downloads
- [better](https://npm.io/package/better.md) — 42 weekly downloads
- [react-native-swipe-image](https://npm.io/package/react-native-swipe-image.md) — 22 weekly downloads
- [nl.fokkezb.pulltorefresh](https://npm.io/package/nl.fokkezb.pulltorefresh.md) — 11 weekly downloads

## Recent versions

- 1.0.1 (latest) — 2015-10-27
- 0.0.1 — 2015-10-27
- 1.0.0 — 2015-10-25

## README

# jRCarousel
**j**Query **R**esponsive **Carousel** - __jRCarousel__ by Vinayak Rangnathrao Jadhav

###### jRCarousel is a jQuery plugin for responsive carousel with modern effects and multiple options.

## Features
- Modern effects
- Fullscreen Carousel
- Tiny plugin (gzipped ~ 1.6kb, uncompressed ~ 4.8kb)
- Infinite scroll
- Multiple slideLayouts to maintain aspect ratio
- Minimal configuration, easy to install
- Useful public API for extending the functionalities
- Large browsers support ( Internet Explorer(9+), Chrome, Firefox, Safari ..)
 

## Installation

npm install jrcarousel

##### Setup images source
```
var slides = [
	{src: 'http://lorempixel.com//1366/768'},
	{src: 'http://lorempixel.com//1366/761'},
	{src: 'http://lorempixel.com//1366/762'},
	{src: 'http://lorempixel.com//1366/763'},
	{src: 'http://lorempixel.com//1366/764'},
	{src: 'http://lorempixel.com//1366/765'},
	{src: 'http://lorempixel.com//1366/766'}
];
```

##### Minimal configuration with defaults
```
$('.jRCarouselGallery').jRCarousel({
					slides: slides
				});
```

##### Configuring all available options
```
$('.jRCarouselGallery').jRCarousel({
 	width: 800, 				/* largest allowed width */
	height: 356, 				/* largest allowed height */
	slides: slides, 			/* array of images source or gets slides by 'slide' class */
	slideLayout : 'contain',  	/* "contain"-fit as per to aspect ratio | "fill"-stretches to fill |  "cover"-overflows but maintains ratio */
	animation: 'scroll', 		/* slide | scroll | fade | zoomInSlide | zoomInScroll */
	animationSpeed: 400,    	/* animation speed in milliseconds */
	animationInterval: 4000,	/* Interval between transitions or per slide show time in milliseconds */
	autoplay: true,         	/* start playing Carousel continuously, pauses when slide is hovered */
	onSlideShow: show,			/* callback when Slide show event occurs */
	navigation: 'circles'		/* circles | squares */
});
```
##### Images source provided in javascript
```
<div class="jRCarouselGallery"></div>
```

##### Images source provided in template by adding class `slide`
```
<div class="jRCarouselGallery">
  <img class="slide" src="http://lorempixel.com//800/351" />
  <img class="slide" src="http://lorempixel.com//800/352" />
  <img class="slide" src="http://lorempixel.com//800/353" />
  <img class="slide" src="http://lorempixel.com//800/354" />
  <img class="slide" src="http://lorempixel.com//800/355" />
</div>
```
## jRCarousel Example
![jRCarousel](https://cloud.githubusercontent.com/assets/7734229/10716647/cf343360-7b65-11e5-9e36-15dc866456a3.png)

## Public API
- ##### showSlide(slideIndex) 	:
		shows the slide specified by the slideIndex by running animation, the slideIndex starts from 0.

- ##### showPreviousSlide()		:
		shows the previous slide from current slide by running animation

- ##### showNextSlide()		:
		shows the slide specified by the slideIndex by running animation

- ##### getSlideByIndex(slideIndex)	:
		returns the slide's jquery object specified by the slideIndex

- ##### getCurrentSlide()		:
		returns the current slide's jquery object

- ###### Usage
```
var myJRCarousel = $('.jRCarouselGallery').jRCarousel({
				slides: slides
});

myJRCarousel.showSlide(0);
myJRCarousel.showPreviousSlide();
myJRCarousel.howNextSlide();
var slide = myJRCarousel.getSlideByIndex(1);
var currentSlide = myJRCarousel.getCurrentSlide();
```
------------------------------------------------------------------------------------------------------------------

---
_Source: https://npm.io/package/jrcarousel · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
