Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/chrisburnell/event-countdown

A Web Component to display an event countdown.
https://github.com/chrisburnell/event-countdown

countdown custom-element custom-elements customelement customelements javascript web-component web-components webcomponent webcomponents

Last synced: 3 days ago
JSON representation

A Web Component to display an event countdown.

Awesome Lists containing this project

README

        

# `event-countdown`

A Web Component to display an event countdown.

**[Demo](https://chrisburnell.github.io/event-countdown/demo.html)** | **[Further reading](https://chrisburnell.com/event-countdown/)**

## Usage

### General usage example

```html

My event starts on .
```

### With end point

```html

My event ends on .
```

### Both start and end points

```html

My event starts on and ends on .
```

### Annual events

```html

My event starts on .
```

### Update frequency

```html

My event starts on .

My event starts on .
```

### Specific division

```html

My event starts on .
```

### Maximum division

```html

My event starts on .
```

### Numeric format

```html

My event starts on .

My event starts on .
```

### Style format

```html

My event starts on .

My event starts on .

My event starts on .
```

## Installation

You have a few options (choose one of these):

1. Install via [npm](https://www.npmjs.com/package/@chrisburnell/event-countdown): `npm install @chrisburnell/event-countdown`
1. [Download the source manually from GitHub](https://github.com/chrisburnell/event-countdown/releases) into your project.
1. Skip this step and use the script directly via a 3rd party CDN (not recommended for production use)

## Usage

Make sure you include the `` in your project (choose one of these):

```html
<!-- Host yourself -->
<script type="module" src="event-countdown.js">
```

```html

```

```html

```

## Credit

With thanks to the following people:

- [David Darnes](https://darn.es) for creating this [Web Component repo template](https://github.com/daviddarnes/component-template)