import { computed, defineComponent } from 'vue';
import initDefaultProps from '../_util/props-util/initDefaultProps';
import CloseOutlined from '@ant-design/icons-vue/CloseOutlined';
import CheckOutlined from '@ant-design/icons-vue/CheckOutlined';
import CheckCircleFilled from '@ant-design/icons-vue/CheckCircleFilled';
import CloseCircleFilled from '@ant-design/icons-vue/CloseCircleFilled';
import Line from './Line';
import Circle from './Circle';
import Steps from './Steps';
import { getSize, getSuccessPercent, validProgress } from './utils';
import useConfigInject from '../config-provider/hooks/useConfigInject';
import devWarning from '../vc-util/devWarning';
import { progressProps, progressStatuses } from './props';
import type { VueNode, CustomSlotsType } from '../_util/type';
import useStyle from './style';
export default defineComponent({
compatConfig: { MODE: 3 },
name: 'AProgress',
inheritAttrs: false,
props: initDefaultProps(progressProps(), {
type: 'line',
percent: 0,
showInfo: true,
// null for different theme definition
trailColor: null,
size: 'default',
strokeLinecap: 'round',
}),
slots: Object as CustomSlotsType<{
default?: any;
format?: any;
}>,
setup(props, { slots, attrs }) {
const { prefixCls, direction } = useConfigInject('progress', props);
const [wrapSSR, hashId] = useStyle(prefixCls);
if (process.env.NODE_ENV !== 'production') {
devWarning(
'successPercent' in props,
'Progress',
'`successPercent` is deprecated. Please use `success.percent` instead.',
);
devWarning('width' in props, 'Progress', '`width` is deprecated. Please use `size` instead.');
}
const strokeColorNotArray = computed(() =>
Array.isArray(props.strokeColor) ? props.strokeColor[0] : props.strokeColor,
const percentNumber = computed(() => {
const { percent = 0 } = props;
const successPercent = getSuccessPercent(props);
return parseInt(
successPercent !== undefined ? successPercent.toString() : percent.toString(),
10,
});
const progressStatus = computed(() => {
const { status } = props;
if (!progressStatuses.includes(status) && percentNumber.value >= 100) {
return 'success';
return status || 'normal';
const classString = computed(() => {
const { type, showInfo, size } = props;
const pre = prefixCls.value;
return {
[pre]: true,
[`${pre}-inline-circle`]: type === 'circle' && getSize(size, 'circle').width <= 20,
[`${pre}-${(type === 'dashboard' && 'circle') || type}`]: true,
[`${pre}-status-${progressStatus.value}`]: true,
[`${pre}-show-info`]: showInfo,
[`${pre}-${size}`]: size,
[`${pre}-rtl`]: direction.value === 'rtl',
[hashId.value]: true,
};
const strokeColorNotGradient = computed(() =>
typeof props.strokeColor === 'string' || Array.isArray(props.strokeColor)
? props.strokeColor
: undefined,
const renderProcessInfo = () => {
const { showInfo, format, type, percent, title } = props;
if (!showInfo) return null;
let text: VueNode;
const textFormatter = format || slots?.format || ((val: number) => `${val}%`);
const isLineType = type === 'line';
if (
format ||
slots?.format ||
(progressStatus.value !== 'exception' && progressStatus.value !== 'success')
) {
text = textFormatter(validProgress(percent), validProgress(successPercent));
} else if (progressStatus.value === 'exception') {
text = isLineType ? <CloseCircleFilled /> : <CloseOutlined />;
} else if (progressStatus.value === 'success') {
text = isLineType ? <CheckCircleFilled /> : <CheckOutlined />;
return (
<span
class={`${prefixCls.value}-text`}
title={title === undefined && typeof text === 'string' ? text : undefined}
>
{text}
</span>
return () => {
const { type, steps, title } = props;
const { class: cls, ...restAttrs } = attrs;
const progressInfo = renderProcessInfo();
let progress: VueNode;
// Render progress shape
if (type === 'line') {
progress = steps ? (
<Steps
{...props}
strokeColor={strokeColorNotGradient.value}
prefixCls={prefixCls.value}
steps={steps}
{progressInfo}
</Steps>
) : (
<Line
strokeColor={strokeColorNotArray.value}
direction={direction.value}
</Line>
} else if (type === 'circle' || type === 'dashboard') {
progress = (
<Circle
progressStatus={progressStatus.value}
</Circle>
return wrapSSR(
<div role="progressbar" {...restAttrs} class={[classString.value, cls]} title={title}>
{progress}
</div>,
},