maz-ui
Version:
A standalone components library for Vue.Js 3 & Nuxt.Js 3
107 lines (106 loc) • 3.23 kB
TypeScript
import { SVGAttributes } from 'vue';
import { MazColor } from './types';
export interface MazCircularProgressBarProps {
/**
* The percentage value of the progress bar
* @required
*/
percentage: number;
/**
* The size of the progress bar
* @default '10em' (equal 80px for a font-size of 16px)
*/
size?: string;
/**
* Duration of the animation in milliseconds
* @default 1000
*/
duration?: number;
/**
* Delay before the animation starts in milliseconds
* @default 100
*/
delay?: number;
/**
* The color of the progress bar
* @type Color
* @default undefined
*/
color?: MazColor;
/**
* Auto color based on the count (destructive, warning, success)
* @default false
*/
autoColor?: boolean;
/**
* Suffix to display next to the number
*/
prefix?: string;
/**
* Suffix to display next to the number
*/
suffix?: string;
/**
* The stroke-linecap style
* @default 'round'
* @values 'butt', 'round', 'square', 'inherit'
*/
strokeLinecap?: SVGAttributes['stroke-linecap'];
/**
* The stroke width
* @default 6
*/
strokeWidth?: SVGAttributes['width'];
/**
* The stroke color
* Use this prop to override the gradient color
* You can use a color name or a color code
*/
stroke?: SVGAttributes['stroke'];
/**
* The percentage value of the success level
* @description The progress circle will be filled with the success color when the percentage is greater than or equal to this value
* @default 100
*/
successPercentage?: number;
/**
* The percentage value of the warning level
* @description The progress circle will be filled with the warning color when the percentage is greater than or equal to this value
* @default 50
*/
warningPercentage?: number;
/**
* The percentage value of the danger level
* @description The progress circle will be filled with the danger color when the percentage is greater than or equal to this value
* @default 25
*/
dangerPercentage?: number;
/**
* Play the animation only once
* @default true
*/
once?: boolean;
}
declare function __VLS_template(): {
attrs: Partial<{}>;
slots: {
default?(_: {}): any;
prefix?(_: {}): any;
suffix?(_: {}): any;
};
refs: {
circleRef: SVGSVGElement;
};
rootEl: HTMLDivElement;
};
type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
declare const __VLS_component: import('vue').DefineComponent<MazCircularProgressBarProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<MazCircularProgressBarProps> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
circleRef: SVGSVGElement;
}, HTMLDivElement>;
declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
export default _default;
type __VLS_WithTemplateSlots<T, S> = T & {
new (): {
$slots: S;
};
};