ant-design/components/progress/progress.tsx
LonelySnowman 5098e6e209
feat: progress add inside and bottom text position (#48157)
* feat: progress add inside and bottom text position

* feat: change progress percent position api

* fix: change to follow coding standards

* docs: reset i18n zh file

* fix: change to follow coding standards

* fix: change to follow coding standards

* docs: reset i18n file

* fix: change to follow coding standards

* docs: reset i18n file

* feat: progress inner text get brighten color

* feat: update progress snapshots

* fix: progress bottom layout center

* feat: update steps snapshots

* feat: update progress snapshots

* feat: update config provider snapshots

* feat: progress inner text add negate color

* feat: update progress snapshots

* feat: progress inner text add light bg color

* feat: progress inner text add light bg color

* feat: change progress percentPosition api

* feat: change progress component test

* feat: update progress line component snapshot

* feat: progress component outer start layout text adapt

* feat: progress line change to flex layout

* feat: update progress snapshots

* feat: update progress line style

* feat: update progress line style

* fix: progress line reset height use inline block

* fix: change progress is line type

* fix: change progress is line type

* fix: delete progress outer styles

* fix: change progress line type layout

* fix: progress add outer style

* feat: update progress snapshots

* fix: change progress text bright color

* fix: optimized code volume

* fix: progress delete after style on inner layout

* fix: update progress test file

---------

Co-authored-by: lijianan <574980606@qq.com>
Co-authored-by: afc163 <afc163@gmail.com>
2024-05-10 10:22:32 +08:00

274 lines
8.6 KiB
TypeScript

import * as React from 'react';
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 classNames from 'classnames';
import omit from 'rc-util/lib/omit';
import { devUseWarning } from '../_util/warning';
import type { ConfigConsumerProps } from '../config-provider';
import { ConfigContext } from '../config-provider';
import Circle from './Circle';
import Line from './Line';
import Steps from './Steps';
import useStyle from './style';
import { getSize, getSuccessPercent, validProgress } from './utils';
import { TinyColor } from '@ctrl/tinycolor';
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<string, string>;
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;
/** @deprecated Use `percent` instead */
progress?: number;
strokeColor?: string;
}
export type ProgressAriaProps = Pick<React.AriaAttributes, 'aria-label' | 'aria-labelledby'>;
export interface ProgressProps extends ProgressAriaProps {
prefixCls?: string;
className?: string;
rootClassName?: string;
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;
trailColor?: 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 };
/** @deprecated Use `success` instead */
successPercent?: number;
percentPosition?: PercentPositionType;
children?: React.ReactNode;
}
const Progress = React.forwardRef<HTMLDivElement, ProgressProps>((props, ref) => {
const {
prefixCls: customizePrefixCls,
className,
rootClassName,
steps,
strokeColor,
percent = 0,
size = 'default',
showInfo = true,
type = 'line',
status,
format,
style,
percentPosition = {},
...restProps
} = props;
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 TinyColor(color).isLight();
}
return false;
}, [strokeColor]);
const percentNumber = React.useMemo<number>(() => {
const successPercent = getSuccessPercent(props);
return parseInt(
successPercent !== undefined ? (successPercent ?? 0)?.toString() : (percent ?? 0)?.toString(),
10,
);
}, [percent, props.success, props.successPercent]);
const progressStatus = React.useMemo<(typeof ProgressStatuses)[number]>(() => {
if (!ProgressStatuses.includes(status!) && percentNumber >= 100) {
return 'success';
}
return status || 'normal';
}, [status, percentNumber]);
const {
getPrefixCls,
direction,
progress: progressStyle,
} = React.useContext<ConfigConsumerProps>(ConfigContext);
const prefixCls = getPrefixCls('progress', customizePrefixCls);
const [wrapCSSVar, hashId, cssVarCls] = useStyle(prefixCls);
const isLineType = type === 'line';
const isPureLineType = isLineType && !steps;
const progressInfo = React.useMemo<React.ReactNode>(() => {
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 ? <CloseCircleFilled /> : <CloseOutlined />;
} else if (progressStatus === 'success') {
text = isLineType ? <CheckCircleFilled /> : <CheckOutlined />;
}
return (
<span
className={classNames(`${prefixCls}-text`, {
[`${prefixCls}-text-bright`]: isBrightInnerColor,
[`${prefixCls}-text-${infoAlign}`]: isPureLineType,
[`${prefixCls}-text-${infoPosition}`]: isPureLineType,
})}
title={typeof text === 'string' ? text : undefined}
>
{text}
</span>
);
}, [showInfo, percent, percentNumber, progressStatus, type, prefixCls, format]);
if (process.env.NODE_ENV !== 'production') {
const warning = devUseWarning('Progress');
warning.deprecated(!('successPercent' in props), 'successPercent', 'success.percent');
warning.deprecated(!('width' in props), 'width', 'size');
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.',
);
}
}
if (props.success && 'progress' in props.success) {
warning.deprecated(false, 'success.progress', 'success.percent');
}
}
let progress: React.ReactNode;
// Render progress shape
if (type === 'line') {
progress = steps ? (
<Steps
{...props}
strokeColor={strokeColorNotGradient}
prefixCls={prefixCls}
steps={typeof steps === 'object' ? steps.count : steps}
>
{progressInfo}
</Steps>
) : (
<Line
{...props}
strokeColor={strokeColorNotArray}
prefixCls={prefixCls}
direction={direction}
percentPosition={{
align: infoAlign,
type: infoPosition,
}}
>
{progressInfo}
</Line>
);
} else if (type === 'circle' || type === 'dashboard') {
progress = (
<Circle
{...props}
strokeColor={strokeColorNotArray}
prefixCls={prefixCls}
progressStatus={progressStatus}
>
{progressInfo}
</Circle>
);
}
const classString = classNames(
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',
},
progressStyle?.className,
className,
rootClassName,
hashId,
cssVarCls,
);
return wrapCSSVar(
<div
ref={ref}
style={{ ...progressStyle?.style, ...style }}
className={classString}
role="progressbar"
aria-valuenow={percentNumber}
{...omit(restProps, [
'trailColor',
'strokeWidth',
'width',
'gapDegree',
'gapPosition',
'strokeLinecap',
'success',
'successPercent',
])}
>
{progress}
</div>,
);
});
if (process.env.NODE_ENV !== 'production') {
Progress.displayName = 'Progress';
}
export default Progress;