element-plus/types/progress.d.ts

38 lines
1.0 KiB
TypeScript
Raw Normal View History

2020-09-15 19:12:27 +08:00
import { ElementUIComponent } from './component'
export type ProgressType = 'line' | 'circle'
export type ProgressStatus = 'success' | 'exception'
type colorFunc = () => any
/** Progress Component */
export declare class ElProgress extends ElementUIComponent {
/** Percentage, required */
percentage: number
/** The type of progress bar */
type: ProgressType
/** The width of progress bar */
strokeWidth: number
/** Circle progress bar stroke line cap */
strokeLinecap: string
/** Whether to place the percentage inside progress bar, only works when type is 'line' */
textInside: boolean
/** The current status of progress bar */
status: ProgressStatus
/** Background color of progress bar. Overrides `status` prop */
color: string | colorFunc | Array<string | { color: string; percentage: number; }>
/** The canvas width of circle progress bar */
width: number
/** Whether to show percentage */
showText: boolean
/** Template function of the content */
format(percentage: number): string
}