import * as React from 'react'; import { FastColor } from '@ant-design/fast-color'; import CheckCircleFilled from '@ant-design/icons/CheckCircleFilled'; import CheckOutlined from '@ant-design/icons/CheckOutlined'; import CloseCircleFilled from '@ant-design/icons/CloseCircleFilled'; import CloseOutlined from '@ant-design/icons/CloseOutlined'; import omit from '@rc-component/util/lib/omit'; import cls from 'classnames'; import useMergeSemantic from '../_util/hooks/useMergeSemantic'; import { devUseWarning } from '../_util/warning'; import { useComponentConfig } from '../config-provider/context'; import Circle from './Circle'; import Line from './Line'; import Steps from './Steps'; import useStyle from './style'; import { getSize, getSuccessPercent, validProgress } from './utils'; export type SemanticName = 'root' | 'body' | 'rail' | 'track' | 'indicator'; export const ProgressTypes = ['line', 'circle', 'dashboard'] as const; export type ProgressType = (typeof ProgressTypes)[number]; const ProgressStatuses = ['normal', 'exception', 'active', 'success'] as const; export type ProgressSize = 'default' | 'small'; export type StringGradients = Record; type FromToGradients = { from: string; to: string }; export type ProgressGradient = { direction?: string } & (StringGradients | FromToGradients); export interface PercentPositionType { align?: 'start' | 'center' | 'end'; type?: 'inner' | 'outer'; } export interface SuccessProps { percent?: number; strokeColor?: string; } export type ProgressAriaProps = Pick; export interface ProgressProps extends ProgressAriaProps { prefixCls?: string; className?: string; rootClassName?: string; classNames?: Partial>; styles?: Partial>; type?: ProgressType; percent?: number; format?: (percent?: number, successPercent?: number) => React.ReactNode; status?: (typeof ProgressStatuses)[number]; showInfo?: boolean; strokeWidth?: number; strokeLinecap?: 'butt' | 'square' | 'round'; strokeColor?: string | string[] | ProgressGradient; /** @deprecated Please use `railColor` instead */ trailColor?: string; railColor?: string; /** @deprecated Use `size` instead */ width?: number; success?: SuccessProps; style?: React.CSSProperties; gapDegree?: number; gapPosition?: 'top' | 'bottom' | 'left' | 'right'; size?: number | [number | string, number] | ProgressSize | { width?: number; height?: number }; steps?: number | { count: number; gap: number }; percentPosition?: PercentPositionType; children?: React.ReactNode; rounding?: (step: number) => number; } const Progress = React.forwardRef((props, ref) => { const { prefixCls: customizePrefixCls, className, rootClassName, classNames, styles, steps, strokeColor, percent = 0, size = 'default', showInfo = true, type = 'line', status, format, style, percentPosition = {}, ...restProps } = props; // ========================= MISC ========================= const { align: infoAlign = 'end', type: infoPosition = 'outer' } = percentPosition; const strokeColorNotArray = Array.isArray(strokeColor) ? strokeColor[0] : strokeColor; const strokeColorNotGradient = typeof strokeColor === 'string' || Array.isArray(strokeColor) ? strokeColor : undefined; const strokeColorIsBright = React.useMemo(() => { if (strokeColorNotArray) { const color = typeof strokeColorNotArray === 'string' ? strokeColorNotArray : Object.values(strokeColorNotArray)[0]; return new FastColor(color).isLight(); } return false; }, [strokeColor]); const percentNumber = React.useMemo(() => { const successPercent = getSuccessPercent(props); return parseInt( successPercent !== undefined ? (successPercent ?? 0)?.toString() : (percent ?? 0)?.toString(), 10, ); }, [percent, props.success]); const progressStatus = React.useMemo<(typeof ProgressStatuses)[number]>(() => { if (!ProgressStatuses.includes(status!) && percentNumber >= 100) { return 'success'; } return status || 'normal'; }, [status, percentNumber]); // ======================= Context ======================== const { getPrefixCls, direction, className: contextClassName, style: contextStyle, classNames: contextClassNames, styles: contextStyles, } = useComponentConfig('progress'); const prefixCls = getPrefixCls('progress', customizePrefixCls); const [hashId, cssVarCls] = useStyle(prefixCls); // ======================== Styles ======================== const [mergedClassNames, mergedStyles] = useMergeSemantic( [contextClassNames, classNames], [contextStyles, styles], ); // ========================= Info ========================= const isLineType = type === 'line'; const isPureLineType = isLineType && !steps; const progressInfo = React.useMemo(() => { if (!showInfo) { return null; } const successPercent = getSuccessPercent(props); let text: React.ReactNode; const textFormatter = format || ((number) => `${number}%`); const isBrightInnerColor = isLineType && strokeColorIsBright && infoPosition === 'inner'; if ( infoPosition === 'inner' || format || (progressStatus !== 'exception' && progressStatus !== 'success') ) { text = textFormatter(validProgress(percent), validProgress(successPercent)); } else if (progressStatus === 'exception') { text = isLineType ? : ; } else if (progressStatus === 'success') { text = isLineType ? : ; } return ( {text} ); }, [showInfo, percent, percentNumber, progressStatus, type, prefixCls, format]); if (process.env.NODE_ENV !== 'production') { const warning = devUseWarning('Progress'); warning.deprecated(!('width' in props), 'width', 'size'); warning.deprecated(!props.trailColor, 'trailColor', 'railColor'); if (type === 'circle' || type === 'dashboard') { if (Array.isArray(size)) { warning( false, 'usage', 'Type "circle" and "dashboard" do not accept array as `size`, please use number or preset size instead.', ); } else if (typeof size === 'object') { warning( false, 'usage', 'Type "circle" and "dashboard" do not accept object as `size`, please use number or preset size instead.', ); } } } // ======================== Render ======================== const sharedProps = { ...props, classNames: mergedClassNames, styles: mergedStyles, }; let progress: React.ReactNode; // Render progress shape if (type === 'line') { progress = steps ? ( {progressInfo} ) : ( {progressInfo} ); } else if (type === 'circle' || type === 'dashboard') { progress = ( {progressInfo} ); } const classString = cls( prefixCls, `${prefixCls}-status-${progressStatus}`, { [`${prefixCls}-${(type === 'dashboard' && 'circle') || type}`]: type !== 'line', [`${prefixCls}-inline-circle`]: type === 'circle' && getSize(size, 'circle')[0] <= 20, [`${prefixCls}-line`]: isPureLineType, [`${prefixCls}-line-align-${infoAlign}`]: isPureLineType, [`${prefixCls}-line-position-${infoPosition}`]: isPureLineType, [`${prefixCls}-steps`]: steps, [`${prefixCls}-show-info`]: showInfo, [`${prefixCls}-${size}`]: typeof size === 'string', [`${prefixCls}-rtl`]: direction === 'rtl', }, contextClassName, className, rootClassName, mergedClassNames.root, hashId, cssVarCls, ); return (
{progress}
); }); if (process.env.NODE_ENV !== 'production') { Progress.displayName = 'Progress'; } export default Progress;