The countdown component provides you with an easy way to display a countdown timer on your site. It makes use of JavaScript and Alpine.js to do the countdown. You can provide any DateTimeInterface object to start the countdown.


While the countdown component works out-of-the-box when you've set the directives, we recommend that you install and compile its JavaScript libraries before you deploy to production:

Basic Usage

In its most basic usage, you use it as a self closing component and pass it a DateTimeInterface instance through its expires attribute:

<x-countdown :expires="$date"/>

This will output the following (inline JS has been omitted):

00 : 00 : 00 : 00

Composing The Content

You can define how the component is rendered by using its slot. Say you don't want the : syntax but display text labels:

<x-countdown :expires="$date">
    <span x-text="timer.days">{{ $component->days() }}</span> days
    <span x-text="timer.hours">{{ $component->hours() }}</span> hours
    <span x-text="timer.minutes">{{ $component->minutes() }}</span> minutes
    <span x-text="timer.seconds">{{ $component->seconds() }}</span> seconds

This will output the following (inline JS has been omitted):

00 days 00 hours 00 minutes 00 seconds

As you can see we're making use of the component's methods to output the initial state of the countdown. We then make use of Alpine's x-text attribute to apply the calculated state depending on the current point in time.

Using the component's slot allows you to go pretty wild with customizing the look and feel. Take a look at its usage in Blade UI Kit's example app.

On this page

© 2024 Dries Vints. Site built with the TALL Stack. Artwork by Caneco.