README

A block to implement dynamic/silverstripe-carousel, a simple carousel for Silverstripe in Bootstrap

Requirements

• PHP ^8.3
• SilverStripe ^6
• dnadesign/silverstripe-elemental: ^6
• dynamic/silverstripe-carousel: ^3

Installation

composer require dynamic/silverstripe-elemental-carousel

Features

• Carousel Block: An Elemental block for image carousels
• Slide Management: Add, reorder, and manage carousel slides in the CMS
• Flexible Configuration: Control transitions, autoplay, intervals, controls, and indicators
• Bootstrap 5 Support: Default templates optimized for Bootstrap 5
• Content Integration: Add rich-text content alongside carousel slides

License

See License

Usage

An Elemental block to display an image with a title, caption and link. The image can be a single image or a carousel of images.

Template Notes

The default template assumes you are using Bootstrap 5, and requires no additional javascript. If you are not using Bootstrap, you can use a custom template and include your own javascript.

Getting more elements

See Elemental modules by Dynamic

Configuration

See SilverStripe Elemental Configuration

Upgrading from version 2

SilverStripe Elemental Carousel 3.0 is compatible with SilverStripe 6. Key changes:

• Updated to SilverStripe CMS 6
• Requires PHP 8.3 or higher
• Updated to Elemental 6 and Carousel 3
• No breaking changes to the API or templates

Maintainers

• Dynamic (dev@dynamicagency.com)

Bugtracker

Bugs are tracked in the issues section of this repository. Before submitting an issue please read over existing issues to ensure yours is unique.

If the issue does look like a new bug:

• Create a new issue
• Describe the steps required to reproduce your issue, and the expected outcome. Unit tests, screenshots and screencasts can help here.
• Describe your environment as detailed as possible: SilverStripe version, Browser, PHP version, Operating System, any installed SilverStripe modules.

Please report security issues to the module maintainers directly. Please don't file security issues in the bugtracker.

Development and contribution

If you would like to make contributions to the module please ensure you raise a pull request and discuss with the module maintainers.