Package io.kvision.progress

Bootstrap progress bar component.

Types

Bounds

data class Bounds<T>(val min: T, val max: T)

Generic progress bounds.

ContentGenerator

fun interface ContentGenerator<T>

Generic interface for progress content generator.

FormatFractionContentGenerator

class FormatFractionContentGenerator(numberFormat: <ERROR CLASS> = numberFormat { style = "percent" }) : ContentGenerator<Number>

Uses a Intl.NumberFormat to format the fraction of a value within bounds. E.g. if value = 2, bounds=1,10, then the fraction is 0.2 which is formatted using a given numberFormat.

FormatNumberValueContentGenerator

class FormatNumberValueContentGenerator(numberFormat: <ERROR CLASS> = Intl.NumberFormat()) : ContentGenerator<Number>

Uses a Intl.NumberFormat to format a value.

NumberProgressBarTag

class NumberProgressBarTag( progress: Progress<out Number>, initialValue: Number = 0, contentGenerator: ContentGenerator<Number>, bgColor: BsBgColor? = null, className: String? = null, init: NumberProgressBarTag.() -> Unit? = null) : ProgressBarTag<Number>

An implementation of the @see ProgressBarTag, which works with plain old numbers

Progress

class Progress<T>( bounds: Bounds<T>, className: String? = null, init: Progress<T>.() -> Unit? = null)

The Bootstrap progress

ProgressBarTag

abstract class ProgressBarTag<T>(className: String? = null, bgColor: BsBgColor? = null)

A base class for the progress bar tag. This class only exposes utility methods in order to set the typical attributes used by the bootstrap progress bar in a type-safe manner.

Functions

fraction

fun Bounds<out Number>.fraction(value: Double): Double

Calculate fraction for the given value and bounds.

progress

fun <T> <ERROR CLASS>.progress( bounds: Bounds<T>, className: String? = null, init: Progress<T>.() -> Unit? = null): Progress<T>

fun <ERROR CLASS>.progress( min: Number = 0, max: Number = 100, className: String? = null, init: Progress<Number>.() -> Unit? = null): Progress<Number>

DSL builder extension function.

progressNumeric

fun Progress<out Number>.progressNumeric( initialValue: Number = 0, contentGenerator: ContentGenerator<Number> = ContentGenerator { _, _, _ -> }, bgColor: BsBgColor? = null, className: String? = null, init: NumberProgressBarTag.() -> Unit? = null): <ERROR CLASS>