https://github.com/dean-forest-tech/silverstripe-carousel

Basic carousel framework for silverstripe, built on jQuery UI
https://github.com/dean-forest-tech/silverstripe-carousel

Last synced: 2 months ago
JSON representation

Basic carousel framework for silverstripe, built on jQuery UI

• Host: GitHub
• URL: https://github.com/dean-forest-tech/silverstripe-carousel
• Owner: Dean-Forest-Tech
• License: bsd-3-clause
• Created: 2012-10-29T11:29:38.000Z (about 12 years ago)
• Default Branch: 2
• Last Pushed: 2024-11-05T19:38:21.000Z (2 months ago)
• Last Synced: 2024-11-05T20:22:48.856Z (2 months ago)
• Language: PHP
• Size: 101 KB
• Stars: 4
• Watchers: 5
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Silverstripe Carousel Module

============================

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/i-lateral/silverstripe-carousel/badges/quality-score.png?b=2)](https://scrutinizer-ci.com/g/i-lateral/silverstripe-carousel/?branch=2)

[![GitHub license](https://img.shields.io/github/license/i-lateral/silverstripe-carousel.svg)](https://github.com/i-lateral/silverstripe-carousel/blob/2/LICENSE)

Module that adds the ability to generate Carousels/Sliders

to your SilverStripe website.

## Requirements

- SilverStripe Framework: 4.*

- SilverStripe CMS: 4.*

## Installation

Either via composer:

    composer require "i-lateral/silverstripe-carousel"

Or manually by by downloading and adding to:

    [silverstripe-root]/carousel

Then run:

    ./vendor/bin/sake dev/build flush=1

or (from yuor browser):

    http://yoursiteurl.com/dev/build/

## Usage

The following is a quick guide to getting using this module:

### Step 1: Add variable to template

Once installed, you have to add the following template variable to

any templates you require a carousel to appear on:

    $CarouselSlides

### Step 2: Enable carousel on your page

Next, log into the admin interface and edit the page you want to

add a carousel to.

Then click the "Settings" tab, and tick the "show carousel" checkbox.

### Step 4: Setup Carousel

Once this is done you will be able to set the following fields:

- Width and Height settings (this will determine the size of the rendered images)

- Show Controls (this will add next/prev buttons) **NOTE** if you want this to work correctly, you will need to disable hash rewrites in SilverStripe

- Show Indicators (show the blips at the bottom of aa page).

- Interval (how quickly will each slide be displayed).

### Step 5: Add some slides

Once you have finished configuring, you can go back to the "content"

tab and a "carousel" tab should have appeared in the right hand side

of the editing pane.

You can now add slides, attach images and edit their titles.

## Using a different carousel

By default this module uses Bootstrap 4 carousel from a CDN. If you

want to use your own carousel, you will need to copy the

`CarouselSlides` template into your theme and amend the HTML and

Requirements calls