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

Progress bar component.

Usage: (def my-progress (progress-bar :width 40))

;; Update progress (0.0 to 1.0): (set-progress my-progress 0.5)

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

bar-styles clj

Predefined progress bar styles.

complete? clj

(complete? bar)

Check if progress is complete (100%).

decrement clj

(decrement bar)

(decrement bar amount)

Decrement progress by amount (default 0.01).

increment clj

(increment bar)

(increment bar amount)

Increment progress by amount (default 0.01).

percent clj

(percent bar)

Get current progress as 0.0-1.0.

percent-int clj

(percent-int bar)

Get current progress as 0-100 integer.

progress-bar clj

(progress-bar &
              {:keys [width percent bar-style show-percent full-style
                      empty-style percent-style id]
               :or {width 40
                    percent 0.0
                    bar-style :default
                    show-percent false
                    id (rand-int 1000000)}})

Create a progress bar component.

Options: :width - Total width in characters (default 40) :percent - Initial progress 0.0-1.0 (default 0) :bar-style - Keyword from bar-styles or custom map (default :default) :show-percent - Show percentage text (default false) :full-style - Style for filled portion :empty-style - Style for empty portion :percent-style - Style for percentage text :id - Unique ID

progress-init clj

(progress-init bar)

Initialize progress bar, returns [bar cmd].

progress-update clj

(progress-update bar _msg)

Update progress bar state. Progress bars are typically updated directly via set-progress rather than through messages. Returns [bar nil].

progress-view clj

(progress-view bar)

Render the progress bar to a string.

reset clj

(reset bar)

Reset progress to 0.

set-progress clj

(set-progress bar p)

Set progress (0.0 to 1.0).

set-progress-int clj

(set-progress-int bar p)

Set progress as 0-100 integer.