Repository files navigation

Touch enabledjQuery plugin that lets you createbeautiful responsive carousel slider.To get started, check outhttp://owlcarousel.owlgraphic.com.

Please consider that the project is still in beta. The current status of the milestones can be foundhere. If you want to use thelatest development seebuilding.

Download thelatest release and put the required stylesheet at thetop of your markup:

<linkrel="stylesheet"href="owlcarousel/owl.carousel.min.css"/>

Put the script at thebottom of your markup right after jQuery:

<scriptsrc="jquery.min.js"></script><scriptsrc="owlcarousel/owl.carousel.min.js"></script>

Wrap your items (div,a,img,span,li etc.) with a container element (div,ul etc.). Only the classowl-carousel is mandatory to apply proper styles:

<divclass="owl-carousel"><div> Your Content</div><div> Your Content</div><div> Your Content</div><div> Your Content</div><div> Your Content</div><div> Your Content</div><div> Your Content</div></div>

Call theplugin function and your carousel is ready.

$(document).ready(function(){$('.owl-carousel').owlCarousel();});

The documentation, included in this repo in the root directory, is built withAssemble and publicly available athttp://owlcarousel.owlgraphic.com. The documentation may also be run locally.

This package comes withGrunt andBower. The following tasks are available:

• default compiles the CSS and JS into/dist and builds the doc.
• dist compiles the CSS and JS into/dist only.
• watch watches source files and builds them automatically whenever you save.
• test runsJSHint andQUnit tests headlessly inPhantomJS.

To define which plugins are build into the distribution just edit/_config.json to fit your needs.

Theissue tracker is the preferred channel for bug reports, features requests and submitting pull requests.

Please do not use the issue tracker for personal support requests. Stack Overflow (owl-carousel) is a better place to get help.

A bug is ademonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful, so thanks!

Guidelines for bug reports:

1. Use the GitHub issue search — check if the issue has already been reported.

2. Check if the issue has been fixed — try to reproduce it using the latestdevelop branch in the repository.

3. Isolate the problem — ideally create a reduced test case and a live example. ThisJSFiddle and thisJS Bin are helpful templates you can fork or clone.

Example:

Short and descriptive example bug report title

A summary of the issue and the browser/OS environment in which it occurs. If suitable, include the steps required to reproduce the bug.

1. This is the first step
2. This is the second step
3. Further steps, etc.

<url> - a link to the reduced test case

Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.

Good pull requests are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code, porting to a different language), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.

Adhering to the following process is the best way to get your work included in the project:

1. Fork the project, clone your fork, and configure the remotes:

```bashgit clone https://github.com/<your-username>/OwlCarousel2.gitcd OwlCarousel2git remote add upstream https://github.com/OwlFonk/OwlCarousel2.git```

2. If you cloned a while ago, get the latest changes from upstream:

```bashgit checkout developgit pull [--rebase] upstream develop```

3. Create a new topic branch (off the main projectdevelop branch) to contain your feature, change, or fix:

```bashgit checkout -b <topic-branch-name>```

4. Build the distribution before committing to ensure your changes follow the coding standards and all build files are up to date.

```bashgrunt dist```

5. Commit your changes in logical chunks. Please adhere to theseguidelines. Use Git'sinteractive rebase feature to tidy up your commits before making them public.

6. Locally merge (or rebase) the upstream development branch into your topic branch:

```bashgit pull [--rebase] upstream develop```

7. Push your topic branch up to your fork:

```bashgit push origin <topic-branch-name>```

8. Open a Pull Request with a clear title and description against thedevelop branch.

By submitting a patch, you agree to allow the project owner tolicense your work under the terms of theMIT License.

The code and the documentation are released under theMIT License.