primevue-mirror/components/progressbar/ProgressBar.d.ts

68 lines
1.5 KiB
TypeScript
Raw Normal View History

2023-03-01 14:12:19 +00:00
/**
*
* ProgressBar is a process status indicator.
*
* [Live Demo](https://www.primevue.org/progressbar)
*
* @module progressbar
*
*/
2022-09-06 12:03:37 +00:00
import { VNode } from 'vue';
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
2023-03-01 14:12:19 +00:00
/**
* Defines valid properties in ProgressBar component.
*/
2022-09-06 12:03:37 +00:00
export interface ProgressBarProps {
/**
* Current value of the progress.
*/
value?: number | undefined;
/**
* Defines the mode of the progress
2023-03-03 08:18:55 +00:00
* @defaultValue 'determinate'
2022-09-06 12:03:37 +00:00
*/
2023-03-01 14:12:19 +00:00
mode?: 'determinate' | 'indeterminate' | undefined;
2022-09-06 12:03:37 +00:00
/**
* Whether to display the progress bar value.
2023-03-01 14:12:19 +00:00
* @defaultValue true
2022-09-06 12:03:37 +00:00
*/
showValue?: boolean | undefined;
}
2023-03-01 14:12:19 +00:00
/**
* Defines valid slots in ProgressBar component.
*/
2022-09-06 12:03:37 +00:00
export interface ProgressBarSlots {
/**
* Custom content slot.
*/
2023-03-01 14:12:19 +00:00
default(): VNode[];
2022-09-06 12:03:37 +00:00
}
2023-03-01 14:12:19 +00:00
/**
* Defines valid emits in ProgressBar component.
*/
export interface ProgressBarEmits {}
2022-09-06 12:03:37 +00:00
2023-03-01 14:12:19 +00:00
/**
* **PrimeVue - ProgressBar**
*
* ProgressBar is a process status indicator._
*
* [Live Demo](https://www.primevue.org/progressbar/)
* --- ---
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
*
* @group Component
*/
2022-09-14 11:26:01 +00:00
declare class ProgressBar extends ClassComponent<ProgressBarProps, ProgressBarSlots, ProgressBarEmits> {}
2022-09-06 12:03:37 +00:00
declare module '@vue/runtime-core' {
interface GlobalComponents {
2022-09-14 11:26:01 +00:00
ProgressBar: GlobalComponentConstructor<ProgressBar>;
2022-09-06 12:03:37 +00:00
}
}
export default ProgressBar;