README

Provides an animated banner component consisting of multiple images for SilverWare apps.

Contents

• Requirements
• Installation
• Usage
• Issues
• Contribution
• Maintainers
• License

Requirements

• SilverWare

Installation

Installation is via Composer:

$ composer require silverware/banner

Usage

After installation, a BannerComponent will become available for use within your SilverWare templates and layouts. You can add Slide objects as children of the component. The images defined for each slide will be used for the banner images.

Using the Style tab, you may set the dimensions and resize method for slide images. For example, 100px height and scale-height method will result in a banner with all images set to 100px high.

On the Options tab, you may define the number of slides to be displayed (from all available children), and whether to display them in the order defined by the site tree, or at random.

Animation

The BannerComponent also supports smooth scrolling animation (left or right) of the banner. On the Options tab, check the Animate checkbox, then select the animation type and animation duration in seconds.

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.

Maintainers

Colin Tucker	Praxis Interactive

License

BSD-3-Clause © Praxis Interactive