UNPKG

1.73 kBTypeScriptView Raw
1import { ComponentInterface } from '../../stencil-public-runtime';
2import { Color } from '../../interface';
3/**
4 * @virtualProp {"ios" | "md"} mode - The mode determines which platform styles to use.
5 *
6 * @part progress - The progress bar that shows the current value when `type` is `"determinate"` and slides back and forth when `type` is `"indeterminate"`.
7 * @part stream - The animated circles that appear while buffering. This only shows when `buffer` is set and `type` is `"determinate"`.
8 * @part track - The track bar behind the progress bar. If the `buffer` property is set and `type` is `"determinate"` the track will be the
9 * width of the `buffer` value.
10 */
11export declare class ProgressBar implements ComponentInterface {
12 /**
13 * The state of the progress bar, based on if the time the process takes is known or not.
14 * Default options are: `"determinate"` (no animation), `"indeterminate"` (animate from left to right).
15 */
16 type: 'determinate' | 'indeterminate';
17 /**
18 * If true, reverse the progress bar direction.
19 */
20 reversed: boolean;
21 /**
22 * The value determines how much of the active bar should display when the
23 * `type` is `"determinate"`.
24 * The value should be between [0, 1].
25 */
26 value: number;
27 /**
28 * If the buffer and value are smaller than 1, the buffer circles will show.
29 * The buffer should be between [0, 1].
30 */
31 buffer: number;
32 /**
33 * The color to use from your application's color palette.
34 * Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
35 * For more information on colors, see [theming](/docs/theming/basics).
36 */
37 color?: Color;
38 render(): any;
39}