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

A block to display a group of promo objects - a small card with an image, headline, short description, and link.
https://github.com/dynamic/silverstripe-elemental-promos

hacktoberfest silverstripe silverstripe-elemental

Last synced: 6 months ago
JSON representation

A block to display a group of promo objects - a small card with an image, headline, short description, and link.

• Host: GitHub
• URL: https://github.com/dynamic/silverstripe-elemental-promos
• Owner: dynamic
• License: bsd-3-clause
• Created: 2018-05-08T02:55:54.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2023-11-14T06:38:46.000Z (over 1 year ago)
• Last Synced: 2024-03-15T11:04:41.404Z (over 1 year ago)
• Topics: hacktoberfest, silverstripe, silverstripe-elemental
• Language: PHP
• Homepage:
• Size: 2.65 MB
• Stars: 0
• Watchers: 8
• Forks: 6
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: code-of-conduct.md

Awesome Lists containing this project

README

        
# Silverstripe Elemental Promos

A block to display a group of promos - a small card with an image, headline, short desciption, and link.

[![CI](https://github.com/dynamic/silverstripe-elemental-promos/actions/workflows/ci.yml/badge.svg)](https://github.com/dynamic/silverstripe-elemental-promos/actions/workflows/ci.yml)

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

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

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

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

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

## Requirements

* dnadesign/silverstripe-elemental: ^5

* dynamic/silverstripe-elemental-baseobject: ^5

* jonom/focuspoint: ^5

## Installation

`composer require dynamic/silverstripe-elemental-promos`

## License

See [License](LICENSE.md)

## Usage

A content block to display a group of promos - a small card with an image, headline, short desciption, and link. Typically this will display 3 to 4 promos per row depending on layout restrictions.

### Template Notes

The default templates are based off [Bootstrap 5](https://getbootstrap.com/) classes/styling

## Screen Shots

#### Default Template of a Promos Element

![Default Template of a Promos Element](./docs/en/_images/promos-block-sample.png)

#### CMS - Promos Main Tab

![CMS - Promos Block Main Tab](./docs/en/_images/promos-block-cms.png)

#### CMS - Promos Block - Promo Edit

![CMS - Promos Block - Promos Edit](./docs/en/_images/promos-block-cms-promo-edit.png)

## Upgrading from version 4

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

## 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-promos/)

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.