@ownclouders/design-system
Version:
ownCloud Design System is based on VueDesign Systems and is used to design ownCloud UI components
40 lines (39 loc) • 1.65 kB
TypeScript
/**
* OcProgress Component
*
* A progress bar component that visually represents the completion status of a task or process.
*
* @component
* @name OcProgress
* @status ready
* @release 1.0.0
*
* @props
* @prop {number} [value=0] - The current progress value.
* @prop {number} [max] - The maximum value for the progress bar. If not provided, the progress bar will not display a percentage.
* @prop {'default' | 'small'} [size='default'] - The size of the progress bar. Can be 'default' or 'small'.
* @prop {'primary' | 'passive' | 'success' | 'warning' | 'danger'} [variation='primary'] - The visual variation of the progress bar.
* @prop {boolean} [indeterminate=false] - If true, the progress bar will display an indeterminate animation.
* @example
* <!-- Default progress bar -->
* <OcProgress :value="50" :max="100" />
*
* <!-- Small progress bar -->
* <OcProgress :value="30" :max="100" size="small" />
*
* <!-- Indeterminate progress bar -->
* <OcProgress indeterminate />
*
* <!-- Progress bar with variation -->
* <OcProgress :value="70" :max="100" variation="success" />
*
*/
interface Props {
value?: number;
max?: number;
size?: 'default' | 'small';
variation?: 'primary' | 'passive' | 'success' | 'warning' | 'danger';
indeterminate?: boolean;
}
declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, HTMLDivElement>;
export default _default;