@ownclouders/design-system
Version:
ownCloud Design System is based on VueDesign Systems and is used to design ownCloud UI components
32 lines (31 loc) • 1.28 kB
TypeScript
/**
* @component OcProgressPie
* @description Displays progress in a pie chart format.
*
* @props {number} [progress=0] - Current value of the progress. Must be between 0 and `max`.
* @props {number} [max=100] - Maximum value of the progress.
* @props {boolean} [showLabel=false] - Determines if the progress label should be displayed.
*
* @computed {number} _fill - The calculated percentage of the progress.
* @computed {string} _label - The label to display, formatted as either a percentage or a fraction.
*
* @example
* <!-- Basic usage -->
* <oc-progress-pie :progress="33" />
*
* <!-- With label -->
* <oc-progress-pie :progress="33" show-label />
*
* <!-- Custom max value -->
* <oc-progress-pie :progress="2" :max="4" />
*
* <!-- Custom max value with label -->
* <oc-progress-pie :progress="4" :max="6" show-label />
*/
interface Props {
progress?: number;
max?: number;
showLabel?: 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;