mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-29 11:58:31 +08:00
197 lines
5.1 KiB
TypeScript
197 lines
5.1 KiB
TypeScript
import * as React from 'react';
|
|
import classNames from 'classnames';
|
|
import omit from 'rc-util/lib/omit';
|
|
import { debounce } from 'throttle-debounce';
|
|
|
|
import { cloneElement } from '../_util/reactNode';
|
|
import { devUseWarning } from '../_util/warning';
|
|
import type { ConfigConsumerProps } from '../config-provider';
|
|
import { ConfigContext } from '../config-provider';
|
|
import useStyle from './style/index';
|
|
|
|
const SpinSizes = ['small', 'default', 'large'] as const;
|
|
export type SpinSize = (typeof SpinSizes)[number];
|
|
export type SpinIndicator = React.ReactElement<HTMLElement>;
|
|
|
|
export interface SpinProps {
|
|
prefixCls?: string;
|
|
className?: string;
|
|
rootClassName?: string;
|
|
spinning?: boolean;
|
|
style?: React.CSSProperties;
|
|
size?: SpinSize;
|
|
tip?: React.ReactNode;
|
|
delay?: number;
|
|
wrapperClassName?: string;
|
|
indicator?: SpinIndicator;
|
|
children?: React.ReactNode;
|
|
fullscreen?: boolean;
|
|
}
|
|
|
|
export type SpinType = React.FC<SpinProps> & {
|
|
setDefaultIndicator: (indicator: React.ReactNode) => void;
|
|
};
|
|
|
|
// Render indicator
|
|
let defaultIndicator: React.ReactNode = null;
|
|
|
|
function renderIndicator(prefixCls: string, props: SpinProps): React.ReactNode {
|
|
const { indicator } = props;
|
|
const dotClassName = `${prefixCls}-dot`;
|
|
|
|
// should not be render default indicator when indicator value is null
|
|
if (indicator === null) {
|
|
return null;
|
|
}
|
|
|
|
if (React.isValidElement(indicator)) {
|
|
return cloneElement(indicator, {
|
|
className: classNames(indicator.props.className, dotClassName),
|
|
});
|
|
}
|
|
|
|
if (React.isValidElement(defaultIndicator)) {
|
|
return cloneElement(defaultIndicator, {
|
|
className: classNames(defaultIndicator.props.className, dotClassName),
|
|
});
|
|
}
|
|
|
|
return (
|
|
<span className={classNames(dotClassName, `${prefixCls}-dot-spin`)}>
|
|
<i className={`${prefixCls}-dot-item`} key={1} />
|
|
<i className={`${prefixCls}-dot-item`} key={2} />
|
|
<i className={`${prefixCls}-dot-item`} key={3} />
|
|
<i className={`${prefixCls}-dot-item`} key={4} />
|
|
</span>
|
|
);
|
|
}
|
|
|
|
function shouldDelay(spinning?: boolean, delay?: number): boolean {
|
|
return !!spinning && !!delay && !isNaN(Number(delay));
|
|
}
|
|
|
|
const Spin: SpinType = (props) => {
|
|
const {
|
|
prefixCls: customizePrefixCls,
|
|
spinning: customSpinning = true,
|
|
delay = 0,
|
|
className,
|
|
rootClassName,
|
|
size = 'default',
|
|
tip,
|
|
wrapperClassName,
|
|
style,
|
|
children,
|
|
fullscreen = false,
|
|
...restProps
|
|
} = props;
|
|
|
|
const { getPrefixCls } = React.useContext(ConfigContext);
|
|
|
|
const prefixCls = getPrefixCls('spin', customizePrefixCls);
|
|
|
|
const [wrapCSSVar, hashId, cssVarCls] = useStyle(prefixCls);
|
|
|
|
const [spinning, setSpinning] = React.useState<boolean>(
|
|
() => customSpinning && !shouldDelay(customSpinning, delay),
|
|
);
|
|
|
|
React.useEffect(() => {
|
|
if (customSpinning) {
|
|
const showSpinning = debounce(delay, () => {
|
|
setSpinning(true);
|
|
});
|
|
showSpinning();
|
|
return () => {
|
|
showSpinning?.cancel?.();
|
|
};
|
|
}
|
|
|
|
setSpinning(false);
|
|
}, [delay, customSpinning]);
|
|
|
|
const isNestedPattern = React.useMemo<boolean>(
|
|
() => typeof children !== 'undefined' && !fullscreen,
|
|
[children, fullscreen],
|
|
);
|
|
|
|
if (process.env.NODE_ENV !== 'production') {
|
|
const warning = devUseWarning('Spin');
|
|
|
|
warning(
|
|
!tip || isNestedPattern || fullscreen,
|
|
'usage',
|
|
'`tip` only work in nest or fullscreen pattern.',
|
|
);
|
|
}
|
|
|
|
const { direction, spin } = React.useContext<ConfigConsumerProps>(ConfigContext);
|
|
|
|
const spinClassName = classNames(
|
|
prefixCls,
|
|
spin?.className,
|
|
{
|
|
[`${prefixCls}-sm`]: size === 'small',
|
|
[`${prefixCls}-lg`]: size === 'large',
|
|
[`${prefixCls}-spinning`]: spinning,
|
|
[`${prefixCls}-show-text`]: !!tip,
|
|
[`${prefixCls}-fullscreen`]: fullscreen,
|
|
[`${prefixCls}-fullscreen-show`]: fullscreen && spinning,
|
|
[`${prefixCls}-rtl`]: direction === 'rtl',
|
|
},
|
|
className,
|
|
rootClassName,
|
|
hashId,
|
|
cssVarCls,
|
|
);
|
|
|
|
const containerClassName = classNames(`${prefixCls}-container`, {
|
|
[`${prefixCls}-blur`]: spinning,
|
|
});
|
|
|
|
// fix https://fb.me/react-unknown-prop
|
|
const divProps = omit(restProps, ['indicator']);
|
|
|
|
const mergedStyle: React.CSSProperties = { ...spin?.style, ...style };
|
|
|
|
const spinElement: React.ReactNode = (
|
|
<div
|
|
{...divProps}
|
|
style={mergedStyle}
|
|
className={spinClassName}
|
|
aria-live="polite"
|
|
aria-busy={spinning}
|
|
>
|
|
{renderIndicator(prefixCls, props)}
|
|
{tip && (isNestedPattern || fullscreen) ? (
|
|
<div className={`${prefixCls}-text`}>{tip}</div>
|
|
) : null}
|
|
</div>
|
|
);
|
|
|
|
if (isNestedPattern) {
|
|
return wrapCSSVar(
|
|
<div
|
|
{...divProps}
|
|
className={classNames(`${prefixCls}-nested-loading`, wrapperClassName, hashId, cssVarCls)}
|
|
>
|
|
{spinning && <div key="loading">{spinElement}</div>}
|
|
<div className={containerClassName} key="container">
|
|
{children}
|
|
</div>
|
|
</div>,
|
|
);
|
|
}
|
|
return wrapCSSVar(spinElement);
|
|
};
|
|
|
|
Spin.setDefaultIndicator = (indicator: React.ReactNode) => {
|
|
defaultIndicator = indicator;
|
|
};
|
|
|
|
if (process.env.NODE_ENV !== 'production') {
|
|
Spin.displayName = 'Spin';
|
|
}
|
|
|
|
export default Spin;
|