charm.components.timer — de.timokramer/charm.clj 0.1.42

Countdown timer component.

Usage: (def my-timer (timer :timeout 60000)) ; 60 seconds

;; In update function: (timer-update my-timer msg)

;; In view function: (timer-view my-timer)

for-timer? clj

(for-timer? tmr msg)

Check if a message is for this timer.

interval clj

(interval tmr)

Get tick interval in milliseconds.

reset clj

(reset tmr initial-timeout)

Reset timer to initial timeout, returns [timer cmd].

running? clj

(running? tmr)

Check if timer is running.

set-interval clj

(set-interval tmr ms)

Set the tick interval in milliseconds.

set-timeout clj

(set-timeout tmr ms)

Set the timeout in milliseconds.

start clj

(start tmr)

Start the timer, returns [timer cmd].

start-stop-msg clj

(start-stop-msg timer-id running?)

Create a start/stop message.

stop clj

(stop tmr)

Stop the timer.

tick-msg clj

(tick-msg timer-id tag)

Create a timer tick message.

tick-msg? clj

(tick-msg? msg)

Check if a message is a timer tick.

timed-out? clj

(timed-out? tmr)

Check if timer has timed out.

timeout clj

(timeout tmr)

Get remaining timeout in milliseconds.

timeout-msg clj

(timeout-msg timer-id)

Create a timer timeout message.

timeout-msg? clj

(timeout-msg? msg)

Check if a message is a timer timeout.

timer clj

(timer &
       {:keys [timeout interval running style id]
        :or {timeout 0 interval 1000 running true id (rand-int 1000000)}})

Create a timer component.

Options: :timeout - Time in milliseconds (default 0, counts up if 0) :interval - Tick interval in milliseconds (default 1000) :running - Start running (default true) :style - Style for timer display :id - Unique ID

timer-init clj

(timer-init tmr)

Initialize the timer, returns [timer cmd]. Call this to start the timer.

timer-update clj

(timer-update tmr msg)

Update timer state based on a message. Returns [new-timer cmd] or [timer nil] if message not handled.

timer-view clj

(timer-view tmr)

Render the timer to a string.

toggle clj

(toggle tmr)

Toggle timer running state, returns [timer cmd].