element3/types/progress.d.ts

A Component Library for Vue3

import { ElementUIComponent } from './component'

export type ProgressType = 'line' | 'circle' | 'dashboard'
export type ProgressStatus = 'success' | 'warning' | 'exception'
export type ProgressLinecap = 'butt' | 'round' | 'square'
export type FnPercentToString = (percentage: number) => string

/** Progress Component */
export const ElProgress: IProgress
interface IProgress 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: ProgressLinecap

  /** 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
    | FnPercentToString
    | 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: FnPercentToString
}