Skip to content
Documentation
Components
Composite
Countdown

Countdown

The countdown counts down a duration in the browser, either as a clock (CountDownStyleClock) or as a shrinking progress bar (CountDownStyleProgress). When it reaches zero, it invokes the action. Use Done to show it as finished.

Countdown

func view(wnd core.Window) core.View {
    done := core.AutoState[bool](wnd)

    return VStack(
        CountDown(2*time.Hour+15*time.Minute).
            Style(CountDownStyleClock).
            Days(false),
        CountDown(10*time.Minute).
            Style(CountDownStyleProgress).
            Done(done.Get()).
            Action(func() { done.Set(true) }).
            Frame(Frame{Width: L480}),
    ).Alignment(Leading).Gap(L32)
}

Constructors 

func CountDown(duration time.Duration) TCountDown

CountDown creates a new countdown timer initialized with the given duration.

Methods

MethodDescription
Action(action func()) TCountDownAction sets the callback function to be executed when the countdown ends.
Days(show bool) TCountDownDays toggles whether the countdown displays days.
Done(done bool) TCountDownDone marks the countdown as finished, overriding its active state.
Frame(frame Frame) TCountDownFrame sets the layout frame of the countdown, including size and positioning.
Hours(show bool) TCountDownHours toggles whether the countdown displays hours.
Minutes(show bool) TCountDownMinutes toggles whether the countdown displays minutes.
ProgressBackground(background Color) TCountDownProgressBackground sets the background color of the countdown’s progress indicator.
ProgressColor(foreground Color) TCountDownProgressColor sets the foreground color of the countdown’s progress indicator.
Seconds(show bool) TCountDownSeconds toggles whether the countdown displays seconds.
SeparatorColor(color Color) TCountDownSeparatorColor sets the color of separators (e.g., colons) in the countdown display.
Style(style CountDownStyle) TCountDownStyle sets the visual style of the countdown (e.g., text-only or with progress).
TextColor(color Color) TCountDownTextColor sets the color of the countdown text.

Related