From 2e4bbb1cb6d8bed29816a3d82b2cd0c7a427112c Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sat, 12 Jul 2014 02:17:42 -0700 Subject: move over all js pages --- docs/_includes/js/carousel.html | 242 ---------------------------------------- 1 file changed, 242 deletions(-) delete mode 100644 docs/_includes/js/carousel.html (limited to 'docs/_includes/js/carousel.html') diff --git a/docs/_includes/js/carousel.html b/docs/_includes/js/carousel.html deleted file mode 100644 index 728356268..000000000 --- a/docs/_includes/js/carousel.html +++ /dev/null @@ -1,242 +0,0 @@ -
-

Carousel carousel.js

- - -

The slideshow below shows a generic plugin and component for cycling through elements like a carousel.

-
- -
-{% highlight html %} - -{% endhighlight %} - - - -

Optional captions

-

Add captions to your slides easily with the .carousel-caption element within any .item. Place just about any optional HTML within there and it will be automatically aligned and formatted.

-
- -
-{% highlight html %} -
- ... -
-

...

-

...

-
-
-{% endhighlight %} - -
-

Accessibility issue

-

The carousel component is generally not compliant with accessibility standards. If you need to be compliant, please consider other options for presenting your content.

-
- - - -

Multiple carousels

-

Carousels require the use of an id on the outermost container (the .carousel) for carousel controls to function properly. When adding multiple carousels, or when changing a carousel's id, be sure to update the relevant controls.

- -

Via data attributes

-

Use data attributes to easily control the position of the carousel. data-slide accepts the keywords prev or next, which alters the slide position relative to its current position. Alternatively, use data-slide-to to pass a raw slide index to the carousel data-slide-to="2", which shifts the slide position to a particular index beginning with 0.

-

The data-ride="carousel" attribute is used to mark a carousel as animating starting at page load. It cannot be used in combination with (redundant and unnecessary) explicit JavaScript initialization of the same carousel.

- -

Via JavaScript

-

Call carousel manually with:

-{% highlight js %} -$('.carousel').carousel() -{% endhighlight %} - -

Options

-

Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-interval="".

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nametypedefaultdescription
intervalnumber5000The amount of time to delay between automatically cycling an item. If false, carousel will not automatically cycle.
pausestring"hover"Pauses the cycling of the carousel on mouseenter and resumes the cycling of the carousel on mouseleave.
wrapbooleantrueWhether the carousel should cycle continuously or have hard stops.
-
- -

Methods

- -

.carousel(options)

-

Initializes the carousel with an optional options object and starts cycling through items.

-{% highlight js %} -$('.carousel').carousel({ - interval: 2000 -}) -{% endhighlight %} - -

.carousel('cycle')

-

Cycles through the carousel items from left to right.

- -

.carousel('pause')

-

Stops the carousel from cycling through items.

- - -

.carousel(number)

-

Cycles the carousel to a particular frame (0 based, similar to an array).

- -

.carousel('prev')

-

Cycles to the previous item.

- -

.carousel('next')

-

Cycles to the next item.

- -

Events

-

Bootstrap's carousel class exposes two events for hooking into carousel functionality.

-

Both events have the following additional properties:

- -
- - - - - - - - - - - - - - - - - -
Event TypeDescription
slide.bs.carouselThis event fires immediately when the slide instance method is invoked.
slid.bs.carouselThis event is fired when the carousel has completed its slide transition.
-
-{% highlight js %} -$('#myCarousel').on('slide.bs.carousel', function () { - // do something… -}) -{% endhighlight %} -
-- cgit v1.2.3