@claromentis/design-system
Version:
Claromentis Design System Component Library
80 lines (79 loc) • 1.68 kB
TypeScript
import { ValueType, CssClassMap } from '../../interfaces';
export declare class ProgressBar {
/**
* The host element.
*/
el: HTMLElement;
/**
* The minimum value.
*/
minimum: number;
/**
* The current value. if no minium and maximum are specified
* the value is out of 100
*/
current: number;
/**
* The maximum value
*/
maximum: number;
/**
* The colour of the progress bar - this colour must be represented as a HEX, RGB or HSL code in order for the contrasting to be computed
*/
barcolour: string;
/**
* percentage of Progress completed
*/
percentageComplete: number;
/**
* percentage of Progress remaining
*/
percentageRemaining: number;
/**
* If 'true' the progress text is shown
*/
showprogresstext: boolean;
/**
* If 'true' the remaining progress text is shown
*/
showremainingtext: boolean;
/**
* If 'true' the remaining progress bar is shown
*/
hideremainingprogress: boolean;
/**
* The progress unit
*/
unit: string;
/**
* Show value as percentage or unit
*/
showvalueas: ValueType;
/**
* If 'true' the progress unit is shown
*/
showunit: boolean;
/**
* The progress bar width (in px)
*/
width: string;
/**
* The progress bar height
*/
height: string;
private progressText;
private remainingText;
private calcPercentageComplete;
private buildProgressText;
private buildRemainingText;
componentDidLoad(): void;
componentWillLoad(): void;
componentWillUpdate(): void;
/**
* Get the map of CSS classes for the button.
*
* @return CssClassMap
*/
getClassMap(): CssClassMap;
render(): any;
}