import classNames from 'classnames'; import debounce from 'lodash/debounce'; import omit from 'rc-util/lib/omit'; import * as React from 'react'; import type { ConfigConsumerProps } from '../config-provider'; import { ConfigConsumer, ConfigContext } from '../config-provider'; import { cloneElement, isValidElement } from '../_util/reactNode'; import { tuple } from '../_util/type'; import useStyle from './style/index'; const SpinSizes = tuple('small', 'default', 'large'); export type SpinSize = typeof SpinSizes[number]; export type SpinIndicator = React.ReactElement; export interface SpinProps { prefixCls?: string; className?: string; spinning?: boolean; style?: React.CSSProperties; size?: SpinSize; tip?: React.ReactNode; delay?: number; wrapperClassName?: string; indicator?: SpinIndicator; children?: React.ReactNode; } export interface SpinClassProps extends SpinProps { hashId: string; spinPrefixCls: string; } export type SpinFCType = React.FC & { setDefaultIndicator: (indicator: React.ReactNode) => void; }; // Render indicator let defaultIndicator: React.ReactNode = null; function renderIndicator(prefixCls: string, props: SpinClassProps): 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 (isValidElement(indicator)) { return cloneElement(indicator, { className: classNames(indicator.props.className, dotClassName), }); } if (isValidElement(defaultIndicator)) { return cloneElement(defaultIndicator, { className: classNames(defaultIndicator.props.className, dotClassName), }); } return ( ); } function shouldDelay(spinning?: boolean, delay?: number): boolean { return !!spinning && !!delay && !isNaN(Number(delay)); } const Spin: React.FC = (props) => { const { spinPrefixCls: prefixCls, spinning: customSpinning = true, delay, className, size = 'default', tip, wrapperClassName, style, children, hashId, ...restProps } = props; const [spinning, setSpinning] = React.useState( () => customSpinning && !shouldDelay(customSpinning, delay), ); React.useEffect(() => { const updateSpinning = debounce<() => void>(() => { setSpinning(customSpinning); }, delay); updateSpinning(); return () => { updateSpinning?.cancel?.(); }; }, [delay, customSpinning]); const isNestedPattern = () => typeof children !== 'undefined'; const renderSpin = ({ direction }: ConfigConsumerProps) => { const spinClassName = classNames( prefixCls, { [`${prefixCls}-sm`]: size === 'small', [`${prefixCls}-lg`]: size === 'large', [`${prefixCls}-spinning`]: spinning, [`${prefixCls}-show-text`]: !!tip, [`${prefixCls}-rtl`]: direction === 'rtl', }, className, hashId, ); // fix https://fb.me/react-unknown-prop const divProps = omit(restProps, ['indicator', 'prefixCls']); const spinElement = (
{renderIndicator(prefixCls, props)} {tip ?
{tip}
: null}
); if (isNestedPattern()) { const containerClassName = classNames(`${prefixCls}-container`, { [`${prefixCls}-blur`]: spinning, }); return (
{spinning &&
{spinElement}
}
{children}
); } return spinElement; }; return {renderSpin}; }; const SpinFC: SpinFCType = (props) => { const { prefixCls: customizePrefixCls } = props; const { getPrefixCls } = React.useContext(ConfigContext); const spinPrefixCls = getPrefixCls('spin', customizePrefixCls); const [wrapSSR, hashId] = useStyle(spinPrefixCls); const spinClassProps: SpinClassProps = { ...props, spinPrefixCls, hashId, }; return wrapSSR(); }; SpinFC.setDefaultIndicator = (indicator: React.ReactNode) => { defaultIndicator = indicator; }; if (process.env.NODE_ENV !== 'production') { SpinFC.displayName = 'Spin'; } export default SpinFC;