as-countdown v0.1.1

as-countdown

This package provides a custom element <as-countdown /> that counts down to a given date or timestamp. Per default the component displays the remaining days, hours, minutes and seconds. For each of these a label is displayed. The labels default to Days, Hours, Minutes and Seconds. All customizations can be found here.

Usage

<as-countdown
  date="2019-12-24">
</as-countdown>

<as-countdown
  date="1563369146414"
  days-label="Dias"
  hours-label="Horas"
  minutes-label="Minutos"
  seconds-label="Segundos">
</as-countdown>

<as-countdown
  date="1566346414104"
  hide-seconds>
</as-countdown>

<as-countdown
  date="2019-12-31"
  days-label="Days left in 2019"
  hide-hours
  hide-minutes
  hide-seconds>
</as-countdown>

Installing

via script tag

• Put a script tag similar to this <script src='https://unpkg.com/as-countdown@0.0.1/dist/as-countdown.js'></script> in the head of your index.html
• Then you can use the element anywhere in your template, JSX, html etc

via node modules

• Run npm install as-countdown --save
• Put a script tag similar to this <script src='node_modules/as-countdown/dist/as-countdown.js'></script> in the head of your index.html
• Then you can use the element anywhere in your template, JSX, html etc

Find more details on integrations into frameworks here.

Styling

The component does not make any assumptions about stylings and displays the countdown as an inline element. You are free to style it in every way you want. Use these css selectors to apply styles accordingly:

as-countdown { /* root */ }
as-countdown > section { /* sections (days, hours, minutes, seconds) */ }
as-countdown > section > div { /* value for respective section */ }
as-countdown > section > label { /* label for respective section */ }

The done event

When the countdown has finished a done event is being dispatched. You can react to it like this:

const countdownEl = document.querySelector('as-countdown');

countdownEl.addEventListener('done', () => {
  /* Do whatever needs to be done */
});

If you use a JS framework you can use that framework's default event binding syntax. Here's an example for Angular:

<as-countdown
  date="2019-12-24"
  (done)="decorateChristmasTree()">
</as-countdown>

Behaviour

Fallback behaviour: Component shows 0 Days, 0 Hours, 0 Minutes and 0 Seconds.

• The date can be passed in as a timestamp or ISO string. Invalid dates will trigger the fallback behaviour
• Dates in the past will trigger the fallback behaviour