Home

Getting started

Setting up the plugin

The lib directory contains the source files and the build directory, where pre-minified Javascript and CSS files reside. Clone or download the repository to extract these files and import them into your project.

Using the plugin

For details on how to call scrollCarousel() and what your HTML structure should look like, visit the How it works section of the API Documentation

Making and testing changes

The example.html file in the dev directory uses the minified css/js source files in lib/build. If you make changes to the sass or javascript files locally and would like to test them, you will need Gulp 4 installed.

• Run gulp to compile your changes to the build folder.
• Run gulp watch to continuously update the minified files in the build folder any time you make a change.

Bugs

overflow-x: scroll; right padding issue

As documented here. When you want to create space around the carousel items, the padding/margin will not create the space at the end of the overflowed carousel element. I am using the :after pseudoelement fix from the afore-linked article in my example files in this repository.

More to come

Contributing

To come