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

Display time left until a set date and time
https://github.com/dynamic/silverstripe-elemental-countdown

hacktoberfest silverstripe silverstripe-elemental

Last synced: 5 days ago
JSON representation

Display time left until a set date and time

• Host: GitHub
• URL: https://github.com/dynamic/silverstripe-elemental-countdown
• Owner: dynamic
• License: bsd-3-clause
• Created: 2018-04-24T18:46:53.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-07-06T21:29:46.000Z (over 3 years ago)
• Last Synced: 2024-04-26T16:04:21.031Z (8 months ago)
• Topics: hacktoberfest, silverstripe, silverstripe-elemental
• Language: PHP
• Homepage:
• Size: 91.8 KB
• Stars: 0
• Watchers: 8
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# SilverStripe Elemental Countdown Block

Displays a countdown to a specific date and time.

[![Build Status](https://travis-ci.org/dynamic/silverstripe-elemental-countdown.svg?branch=master)](https://travis-ci.org/dynamic/silverstripe-elemental-countdown)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/dynamic/silverstripe-elemental-countdown/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/dynamic/silverstripe-elemental-countdown/?branch=master)

[![Code Coverage](https://scrutinizer-ci.com/g/dynamic/silverstripe-elemental-countdown/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/dynamic/silverstripe-elemental-countdown/?branch=master)

[![Build Status](https://scrutinizer-ci.com/g/dynamic/silverstripe-elemental-countdown/badges/build.png?b=master)](https://scrutinizer-ci.com/g/dynamic/silverstripe-elemental-countdown/build-status/master)

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

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

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

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

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

## Requirements

* silverstripe/recipe-cms: ^4@dev

* dnadesign/silverstripe-elemental: ^4@dev

## Installation

`composer require dynamic/silverstripe-elemental-countdown`

## Usage

Elemental Countdown Block will add the following Element to your site:

* Countdown (to a date/time specified in the cms)

### Template Notes

When overriding the `templates/Dynamic/Elements/CountDown/Elements/ElementCountDown.ss` file in your own theme, be sure to include the following in your `.countdown` element:

* `data-end="$End $Timezone"`

* `data-elapse="$Elapse"`

example: `
`


The above is used in the initialization of the countdown plugin.

## Screen Shots

#### Front End sample of a Countdown Element

![Front End sample of a Countdown Element](./readme-images/countdown-block-sample.jpg)

#### CMS - Countdown Element Main Tab

![CMS - Countdown Element Main Tab](./readme-images/countdown-block-cms.jpg)

## Getting more elements

See [Elemental modules by Dynamic](https://github.com/dynamic/silverstripe-elemental-blocks#getting-more-elements)

## Configuration

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