Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dynamic/silverstripe-elemental-flexslider

Slideshow content block for SilverStripe Elemental
https://github.com/dynamic/silverstripe-elemental-flexslider

hacktoberfest silverstripe silverstripe-elemental

Last synced: 5 days ago
JSON representation

Slideshow content block for SilverStripe Elemental

Awesome Lists containing this project

README

        

# SilverStripe Elemental Flexslider

Slideshow content block for SilverStripe Elemental

![CI](https://github.com/dynamic/silverstripe-elemental-flexslider/workflows/CI/badge.svg)
[![codecov](https://codecov.io/gh/dynamic/silverstripe-elemental-flexslider/branch/master/graph/badge.svg)](https://codecov.io/gh/dynamic/silverstripe-elemental-flexslider)

[![Latest Stable Version](https://poser.pugx.org/dynamic/silverstripe-elemental-flexslider/v/stable)](https://packagist.org/packages/dynamic/silverstripe-elemental-flexslider)
[![Total Downloads](https://poser.pugx.org/dynamic/silverstripe-elemental-flexslider/downloads)](https://packagist.org/packages/dynamic/silverstripe-elemental-flexslider)
[![Latest Unstable Version](https://poser.pugx.org/dynamic/silverstripe-elemental-flexslider/v/unstable)](https://packagist.org/packages/dynamic/silverstripe-elemental-flexslider)
[![License](https://poser.pugx.org/dynamic/silverstripe-elemental-flexslider/license)](https://packagist.org/packages/dynamic/silverstripe-elemental-flexslider)

## Requirements

* dnadesign/silverstripe-elemental: ^4.8
* dynamic/flexslider: ^4.0 || ^5.0

## Installation

`composer require dynamic/silverstripe-elemental-flexslider`

## License

See [License](license.md)

## Example usage

A block to display a Flexslider slideshow on your page. Image, headline, description and link.

## Flexslider Options
* Slide or Fade transitions.
* Animate Automatically - Starts the slideshow on page load.
* Loop Carousel - Makes the slideshow an infinite loop instead of not being able to go next on the last slide or previous on the first slide.
* Show ControlNav - Adds the circle dots as "pagination" links.
* Show DirectionNav - Adds the arrows on the left and right sides of a slideshow for navigating.
* Thumbnail Navigation - Creates thumbnail images below the main slide show. These are also used as navigation elements to each slide.
* Show Carousel Control Navigation - Same as ControlNav above, except for the thumbnails.
* Show Carousel Direction Navigation - Same as DirectionNav above, except for the thumbnails.

## Screen Shots

#### Front End sample of a Slideshow Element
![Front End sample of a Slideshow Element](./readme-images/slideshow-block-sample.jpg)

#### CMS - Slideshow Element Main Tab
![CMS - Slideshow Block Main Tab](./readme-images/slideshow-block-cms.jpg)

#### CMS - Slideshow Element - Slides List
![CMS - Slideshow Element - Slides List](./readme-images/slideshow-block-cms-slides-list.jpg)

#### CMS - Slideshow Element - Slide Add/Edit
![CMS - Slideshow Element - Slide Add/Edit](./readme-images/slideshow-block-cms-slide.jpg)

## Legacy migration

If you have a site using a version of this block older than 1.0.0-beta4, you will need to use the following tool to update the namespace of your records:

See [Dynamic Elemental Blocks Migrator](https://github.com/dynamic/dynamic-elemental-blocks-migrator)

## Getting more elements

See [Elemental modules by Dynamic](https://github.com/dynamic?q=elemental)

## Configuration

See [SilverStripe Elemental Configuration](https://github.com/dnadesign/silverstripe-elemental#configuration)

## Translations

The translations for this project are managed via [Transifex](https://www.transifex.com/dynamicagency/silverstripe-elemental-flexslider/)
and are updated automatically during the release process. To contribute, please head to the link above and get
translating!

## Maintainers

* [Dynamic](http://www.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.