BatchExplorer/docs/core
David Watrous c04d861b46 Added markdown linting 2021-03-06 10:13:46 -05:00
..
Readme.md Added markdown linting 2021-03-06 10:13:46 -05:00
banner.png Banner documentation (#236) 2017-03-09 16:33:10 -08:00
gauge.png Added a gauge component (#241) 2017-03-14 11:47:58 -07:00

Readme.md

Core controls

Banner

Banner is a box used to notifiy the user something is wrong with their app. It provide some quick fix functionalities

Banner

Example for the image above

<bl-banner fixMessage="Rerun task" [fix]="rerun" type="warning">
    <div [other-fix]="rerunDifferent" fixMessage="Rerun with different attributes"></div>
    <div message>{{exitCodeMessage}}</div>
</bl-banner>
export class MyComponent {

    @autobind()
    public rerun() {
        return of(true); // Do your quickfix here
    }

    @autobind()
    public rerunDifferent() {
        return of(true); // Do your quickfix here
    }
}

Gauge

Gauge is a custom graphical representation that can show a min, max and a value.

Gauge

Example for the image above

<bl-gauge [value]=[109] options="gaugeOptions" size="small">
</bl-gauge>
export class MyComponent {
    public gaugeOptions = {
        min: 0,
        max: 240,
    }
}
Attr Description
size Size can be one of the presets xsmall small medium large or any number.
value value of the gauge
options Options for the gauge. See gauge-config.ts