@opensig/opendesign
Version:
90 lines (89 loc) • 2.61 kB
TypeScript
import { ExtractPropTypes, PropType } from 'vue';
export declare const ProgressVariantTypes: readonly ["line", "circle"];
export type ProgressVariantT = (typeof ProgressVariantTypes)[number];
export declare const ProgressSizeTypes: readonly ["medium", "small"];
export type ProgressSizeT = (typeof ProgressSizeTypes)[number];
export declare const ProgressColorTypes: readonly ["primary", "success", "warning", "danger"];
export type ProgressColorT = (typeof ProgressColorTypes)[number];
export declare const progressProps: {
/**
* @zh-CN 进度条类型
* @en-US Progress bar type.
* @default 'line'
*/
variant: {
type: PropType<ProgressVariantT>;
default: string;
};
/**
* @zh-CN 进度条百分比
* @en-US Progress bar percentage.
* @default 0
* @validator (val: number): boolean => val >= 0 && val <= 100
*/
percentage: {
type: NumberConstructor;
default: number;
validator: (val: number) => boolean;
};
/**
* @zh-CN 进度条线宽
* @en-US Width of the progress bar.
*/
strokeWidth: {
type: NumberConstructor;
};
/**
* @zh-CN 进度条尺寸
* @en-US Progress bar size.
* @default 'medium'
*/
size: {
type: PropType<ProgressSizeT>;
default: string;
};
/**
* @zh-CN 进度条颜色
* @en-US Progress bar color.
* @default 'primary'
*/
color: {
type: PropType<ProgressColorT>;
default: string;
};
/**
* @zh-CN 进度条轨道宽度,当为环形进度条时,仅支持Number
* @en-US The width of the progress bar track, when it is a circular progress bar, only supports Number.
*/
trackWidth: {
type: (NumberConstructor | StringConstructor)[];
};
/**
* @zh-CN 格式化文字
* @en-US Formatted text.
* @default (percentage: number) => `${percentage}%`
*/
format: {
type: PropType<(percentage: number) => string>;
default: (percentage: number) => string;
};
/**
* @zh-CN 是否展示文字
* @en-US Whether to display text.
* @default true
*/
showLabel: {
type: BooleanConstructor;
default: boolean;
};
/**
* @zh-CN 线形进度条,文字是否在进度条内部
* @en-US Linear progress bar. Is the text inside the progress bar.
* @default false
*/
labelInside: {
type: BooleanConstructor;
default: boolean;
};
};
export type ProgressPropsT = ExtractPropTypes<typeof progressProps>;