Skip to content

Repository files navigation

Countdown Block

Highlight upcoming events with a countdown timer, built for the WordPress block editor.

WordPress PHP License

Using Countdown, you can notify visitors about upcoming events or big days. The plugin lets you create a countdown timer directly inside the Gutenberg block editor.

  • Completely customizable — countdown dates, colors, typography and spacing.
  • Super lightweight — no extra resources, optimized for fast loading and instant live editing.
  • Evergreen timers — recurring, per-visitor countdowns backed by localStorage.

Requirements

Minimum Tested up to
WordPress 6.0 7.0
PHP 7.4 8.5

Installation

Install from the WordPress plugin directory, or grab a release zip and upload it under Plugins → Add New → Upload Plugin.

Development setup

This repository uses git submodules for the shared controls and lib/style-handler packages. Cloning without them will cause a fatal error on activation, because countdown-block.php requires lib/style-handler/style-handler.php at load time.

git clone --recursive git@github.com:EssentialBlocks/countdown-block.git

Already cloned without --recursive? Initialize them after the fact:

git submodule update --init --recursive

Then install dependencies and build:

npm install
npm run build     # production build (minified) — use this before committing dist/
npm start         # development build with watch

Note: dist/ is committed to this repository. Always commit the output of npm run build, never the unminified npm start output.

Branches

Branch Purpose
master Default branch
latest Release integration
dev Active development

Deployment

  • .github/workflows/deploy.yml — deploys to WordPress.org on tag push.
  • .github/workflows/assets.yml — deploys WordPress.org assets on push to release/assets.

WordPress.org banner and icon images live in .wordpress-org/.

Contributors

Built and maintained by WPDeveloper, the team behind Essential Blocks and Essential Addons for Elementor.

Documentation and support

License

GPL-3.0-or-later. See the license text.

Releases

Contributors

Languages