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

Display content in collapsable panels
https://github.com/dynamic/silverstripe-elemental-accordion

hacktoberfest silverstripe silverstripe-elemental

Last synced: 5 days ago
JSON representation

Display content in collapsable panels

• Host: GitHub
• URL: https://github.com/dynamic/silverstripe-elemental-accordion
• Owner: dynamic
• License: bsd-3-clause
• Created: 2018-04-24T02:53:49.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-10-23T16:45:54.000Z (about 1 year ago)
• Last Synced: 2024-04-25T19:02:32.172Z (8 months ago)
• Topics: hacktoberfest, silverstripe, silverstripe-elemental
• Language: PHP
• Homepage:
• Size: 457 KB
• Stars: 0
• Watchers: 8
• Forks: 8
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: code-of-conduct.md

Awesome Lists containing this project

README

        
# SilverStripe Elemental Accordion Block

A block that displays content in collapsable panels.

![CI](https://github.com/dynamic/silverstripe-elemental-accordion/workflows/CI/badge.svg)

[![codecov](https://codecov.io/gh/dynamic/silverstripe-elemental-accordion/branch/master/graph/badge.svg)](https://codecov.io/gh/dynamic/silverstripe-elemental-accordion)

[![Latest Stable Version](https://poser.pugx.org/dynamic/silverstripe-elemental-accordion/v/stable)](https://packagist.org/packages/dynamic/silverstripe-elemental-accordion)

[![Total Downloads](https://poser.pugx.org/dynamic/silverstripe-elemental-accordion/downloads)](https://packagist.org/packages/dynamic/silverstripe-elemental-accordion)

[![Latest Unstable Version](https://poser.pugx.org/dynamic/silverstripe-elemental-accordion/v/unstable)](https://packagist.org/packages/dynamic/silverstripe-elemental-accordion)

[![License](https://poser.pugx.org/dynamic/silverstripe-elemental-accordion/license)](https://packagist.org/packages/dynamic/silverstripe-elemental-accordion)

## Requirements

* dnadesign/silverstripe-elemental: ^5

* dynamic/silverstripe-elemental-baseobject: ^5

* jonom/focuspoint: ^5

* symbiote/silverstripe-gridfieldextensions: ^4

## Installation

`composer require dynamic/silverstripe-elemental-accordion`

## License

See [License](LICENSE.md)

## Upgrading from version 4

This module drops `gorriecoe/silverstripe-linkfield` usage in favor of `silverstripe/linkfield`.

## Usage

A block that allows you to create collapsible content blocks.

### Template Notes

The default templates are based off [Bootstrap 4](https://getbootstrap.com/) cards and collapse. If a theme is not using bootstrap, panel functionality will need to be implemented based on the theme’s UX options or via third party scripts such as jQuery UI.

## Screen Shots

#### Front End sample of an Accordion

![Front End sample of an Accordion](./docs/en/_images/accordion-sample.jpg)

#### CMS - Accordion Main Tab

![Accordion Main Tab](./docs/en/_images/accordion-cms-block.jpg)

#### CMS - Accordion Panel List

![CMS - Accordion Panel List](./docs/en/_images/accordion-cms-list.jpg)

#### CMS - Accordion Panel Edit

![CMS - Accordion Panel Edit](./docs/en/_images/accordion-cms-panel.jpg)

## Getting more elements

See [Elemental modules by Dynamic](https://github.com/orgs/dynamic/repositories?q=elemental&type=all&language=&sort=)

## Configuration

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

## Translations

The translations for this project are managed via [Transifex](https://www.transifex.com/dynamicagency/silverstripe-elemental-accordion/)

and are updated automatically during the release process. To contribute, please head to the link above and get

translating!

## Maintainers

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