https://github.com/grapesjs/components-countdown
Simple countdown component for the GrapesJS Editor
https://github.com/grapesjs/components-countdown
countdown counter grapesjs
Last synced: 6 months ago
JSON representation
Simple countdown component for the GrapesJS Editor
- Host: GitHub
- URL: https://github.com/grapesjs/components-countdown
- Owner: GrapesJS
- License: bsd-3-clause
- Created: 2017-08-02T20:11:48.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-06-06T13:09:55.000Z (over 2 years ago)
- Last Synced: 2025-04-06T18:09:09.459Z (6 months ago)
- Topics: countdown, counter, grapesjs
- Language: TypeScript
- Size: 185 KB
- Stars: 22
- Watchers: 5
- Forks: 38
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GrapesJS Countdown
Simple countdown component for GrapesJS Editor
# [Demo](http://grapesjs.com/demo.html)
## Summary
* Plugin name: `grapesjs-component-countdown`
* Components: `countdown`
* Blocks: `countdown`
## Options
| Option | Description | Default |
|-|-|-
| `id` | The ID used to create the block and component. | `countdown` |
| `label` | The label used for the block and the component. | `Countdown` |
| `block` | Object to extend the default block, eg. `{ label: 'Countdown', category: 'Extra', ... }`. Pass a falsy value to avoid adding the block. | `{}` |
| `props` | Object to extend the default component properties., eg. `{ name: 'Countdown', droppable: false, ... }`. | `{}` |
| `style` | Custom CSS styles for the component. This will replace the default one. | `''` |
| `styleAdditional` | Additional CSS styles for the component. These will be appended to the default one. | `''` |
| `startTime` | Default start time, eg. `2030-01-25 00:00`. | `''` |
| `endText` | Text to show when the countdown is ended. | `'EXPIRED'` |
| `dateInputType` | Date input type, eg. `date`, `datetime-local` | `'date'` |
| `labelDays` | Days label text used in component. | `'days'` |
| `labelHours` | Hours label text used in component. | `'hours'` |
| `labelMinutes` | Minutes label text used in component. | `'minutes'` |
| `labelSeconds` | Seconds label text used in component. | `'seconds'` |
| `classPrefix` | Countdown component class prefix. | `'countdown'` |
## Download
* CDN
* `https://unpkg.com/grapesjs-component-countdown`
* NPM
* `npm i grapesjs-component-countdown`
* GIT
* `git clone https://github.com/artf/grapesjs-component-countdown.git`
## Usage
Directly in the browser
```html
var editor = grapesjs.init({
container : '#gjs',
// ...
plugins: ['grapesjs-component-countdown'],
pluginsOpts: {
'grapesjs-component-countdown': { /* options */ }
}
});
```
Modern javascript
```js
import grapesjs from 'grapesjs';
import pluginCountdown from 'grapesjs-component-countdown';
const editor = grapesjs.init({
container : '#gjs',
// ...
plugins: [pluginCountdown],
pluginsOpts: {
[pluginCountdown]: { /* options */ }
}
// or
plugins: [
editor => pluginCountdown(editor, { /* options */ }),
],
});
```
## Development
Clone the repository
```sh
$ git clone https://github.com/artf/grapesjs-component-countdown.git
$ cd grapesjs-component-countdown
```
Install it
```sh
$ npm i
```
Start the dev server
```sh
$ npm start
```
Build before the commit. This will also increase the patch level version of the package
```sh
$ npm run build
```
## License
BSD 3-Clause