silverware / carousel
SilverWare Carousel Module.
Installs: 188
Dependents: 1
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 2
Open Issues: 0
Type:silverstripe-vendormodule
Requires
- php: >=5.6.0
- silverware/silverware: ^1.3
This package is not auto-updated.
Last update: 2024-10-25 14:25:13 UTC
README
Provides a carousel component for use with SilverWare.
Contents
Requirements
Installation
Installation is via Composer:
$ composer require silverware/carousel
Usage
This module provides a CarouselComponent
which can be added to your SilverWare templates or
layouts using the CMS.
Carousel Component
The CarouselComponent
represents a standard Bootstrap carousel. Slides
may added to the carousel by adding either a slide or a list source to the carousel using the CMS.
The dimensions and resize method used for slides is configured using the Style tab of the component. On the Options tab, you can define the slide interval in milliseconds, and whether or not to show the carousel controls and indicators.
Slides
Slides are added as children of the component using the site tree. Each slide may have an image, caption, and a link to either a page within the CMS, or a URL. Slides will appear in the order defined within the site tree.
List Sources
A special type of slide is a "List Source" slide. This type of slide allows you to choose a list source
from within your CMS (e.g. blog, gallery etc.) and render the list items as slides within the carousel.
Each item object must make use of the SilverWare MetaDataExtension
and the ListItem
trait. Only
items which have an image provided via getMetaImage
are shown.
Issues
Please use the GitHub issue tracker for bug reports and feature requests.
Contribution
Your contributions are gladly welcomed to help make this project better. Please see contributing for more information.
Attribution
- Makes use of Bootstrap by the Bootstrap Authors and Twitter, Inc.
Maintainers
License
BSD-3-Clause © Praxis Interactive