Skip to content

Timer

widgetsdisplay

Timer: counts down from a duration to zero

Installation

$ bunx termuijs add timer

Copies the source into src/components/timer/ and installs @termuijs/core, @termuijs/widgets.

Usage

ts
import { Timer } from '@termuijs/widgets'
ts
new Timer(options: TimerOptions, style: Partial<Style> = {})

API Reference

Timer

PropTypeRequiredDescription
durationnumberrequiredDuration to count down from in milliseconds
intervalnumberoptionalTick interval in milliseconds
#display#timer