2015-11-24 20:03:57 +08:00
|
|
|
import classNames from 'classnames';
|
2019-01-04 23:35:01 +08:00
|
|
|
import debounce from 'lodash/debounce';
|
2022-06-22 14:57:09 +08:00
|
|
|
import omit from 'rc-util/lib/omit';
|
|
|
|
import * as React from 'react';
|
2022-05-07 14:31:54 +08:00
|
|
|
import type { ConfigConsumerProps } from '../config-provider';
|
|
|
|
import { ConfigConsumer, ConfigContext } from '../config-provider';
|
2022-06-22 14:57:09 +08:00
|
|
|
import { cloneElement, isValidElement } from '../_util/reactNode';
|
2018-12-22 21:21:42 +08:00
|
|
|
import { tuple } from '../_util/type';
|
2015-10-31 02:00:03 +08:00
|
|
|
|
2018-12-22 21:21:42 +08:00
|
|
|
const SpinSizes = tuple('small', 'default', 'large');
|
2019-11-27 09:40:47 +08:00
|
|
|
export type SpinSize = typeof SpinSizes[number];
|
2019-06-16 20:51:47 +08:00
|
|
|
export type SpinIndicator = React.ReactElement<HTMLElement>;
|
2018-02-14 12:30:31 +08:00
|
|
|
|
2016-08-10 09:46:56 +08:00
|
|
|
export interface SpinProps {
|
|
|
|
prefixCls?: string;
|
|
|
|
className?: string;
|
|
|
|
spinning?: boolean;
|
2017-11-22 14:46:40 +08:00
|
|
|
style?: React.CSSProperties;
|
2018-04-16 10:58:17 +08:00
|
|
|
size?: SpinSize;
|
2021-11-05 18:44:49 +08:00
|
|
|
tip?: React.ReactNode;
|
2017-01-01 01:13:34 +08:00
|
|
|
delay?: number;
|
2017-03-21 17:12:43 +08:00
|
|
|
wrapperClassName?: string;
|
2018-02-14 12:30:31 +08:00
|
|
|
indicator?: SpinIndicator;
|
2022-04-08 22:55:42 +08:00
|
|
|
children?: React.ReactNode;
|
2016-08-10 09:46:56 +08:00
|
|
|
}
|
|
|
|
|
2022-04-20 12:13:11 +08:00
|
|
|
export interface SpinClassProps extends SpinProps {
|
|
|
|
spinPrefixCls: string;
|
|
|
|
}
|
|
|
|
|
|
|
|
export type SpinFCType = React.FC<SpinProps> & {
|
|
|
|
setDefaultIndicator: (indicator: React.ReactNode) => void;
|
|
|
|
};
|
|
|
|
|
2017-11-21 14:53:25 +08:00
|
|
|
export interface SpinState {
|
|
|
|
spinning?: boolean;
|
|
|
|
notCssAnimationSupported?: boolean;
|
|
|
|
}
|
|
|
|
|
2018-06-06 19:32:30 +08:00
|
|
|
// Render indicator
|
|
|
|
let defaultIndicator: React.ReactNode = null;
|
|
|
|
|
2022-04-20 12:13:11 +08:00
|
|
|
function renderIndicator(prefixCls: string, props: SpinClassProps): React.ReactNode {
|
2018-12-05 19:12:18 +08:00
|
|
|
const { indicator } = props;
|
2018-06-06 19:32:30 +08:00
|
|
|
const dotClassName = `${prefixCls}-dot`;
|
2019-11-27 09:40:47 +08:00
|
|
|
|
|
|
|
// should not be render default indicator when indicator value is null
|
|
|
|
if (indicator === null) {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
2020-05-14 20:54:49 +08:00
|
|
|
if (isValidElement(indicator)) {
|
|
|
|
return cloneElement(indicator, {
|
2019-06-16 20:51:47 +08:00
|
|
|
className: classNames(indicator.props.className, dotClassName),
|
2018-06-06 19:32:30 +08:00
|
|
|
});
|
|
|
|
}
|
|
|
|
|
2020-05-14 20:54:49 +08:00
|
|
|
if (isValidElement(defaultIndicator)) {
|
|
|
|
return cloneElement(defaultIndicator as SpinIndicator, {
|
2018-06-06 19:32:30 +08:00
|
|
|
className: classNames((defaultIndicator as SpinIndicator).props.className, dotClassName),
|
|
|
|
});
|
|
|
|
}
|
|
|
|
|
|
|
|
return (
|
|
|
|
<span className={classNames(dotClassName, `${prefixCls}-dot-spin`)}>
|
2019-03-28 12:20:12 +08:00
|
|
|
<i className={`${prefixCls}-dot-item`} />
|
|
|
|
<i className={`${prefixCls}-dot-item`} />
|
|
|
|
<i className={`${prefixCls}-dot-item`} />
|
|
|
|
<i className={`${prefixCls}-dot-item`} />
|
2018-12-07 20:02:01 +08:00
|
|
|
</span>
|
2018-06-06 19:32:30 +08:00
|
|
|
);
|
|
|
|
}
|
|
|
|
|
2018-09-08 22:43:39 +08:00
|
|
|
function shouldDelay(spinning?: boolean, delay?: number): boolean {
|
|
|
|
return !!spinning && !!delay && !isNaN(Number(delay));
|
|
|
|
}
|
|
|
|
|
2022-04-20 12:13:11 +08:00
|
|
|
class Spin extends React.Component<SpinClassProps, SpinState> {
|
2016-03-29 14:01:10 +08:00
|
|
|
static defaultProps = {
|
2016-04-14 15:26:55 +08:00
|
|
|
spinning: true,
|
2018-04-16 10:58:17 +08:00
|
|
|
size: 'default' as SpinSize,
|
2017-03-21 17:12:43 +08:00
|
|
|
wrapperClassName: '',
|
2016-07-13 11:14:24 +08:00
|
|
|
};
|
2016-03-29 14:01:10 +08:00
|
|
|
|
2019-01-07 10:25:23 +08:00
|
|
|
originalUpdateSpinning: () => void;
|
|
|
|
|
2022-04-20 12:13:11 +08:00
|
|
|
constructor(props: SpinClassProps) {
|
2016-05-09 10:49:14 +08:00
|
|
|
super(props);
|
2018-09-08 22:43:39 +08:00
|
|
|
|
|
|
|
const { spinning, delay } = props;
|
2019-01-04 23:51:07 +08:00
|
|
|
const shouldBeDelayed = shouldDelay(spinning, delay);
|
2016-05-09 10:49:14 +08:00
|
|
|
this.state = {
|
2019-01-04 23:51:07 +08:00
|
|
|
spinning: spinning && !shouldBeDelayed,
|
2016-05-09 10:49:14 +08:00
|
|
|
};
|
2019-01-07 10:25:23 +08:00
|
|
|
this.originalUpdateSpinning = this.updateSpinning;
|
|
|
|
this.debouncifyUpdateSpinning(props);
|
2016-05-09 10:49:14 +08:00
|
|
|
}
|
2016-05-20 14:26:44 +08:00
|
|
|
|
2019-01-04 23:35:01 +08:00
|
|
|
componentDidMount() {
|
|
|
|
this.updateSpinning();
|
|
|
|
}
|
2017-01-01 01:13:34 +08:00
|
|
|
|
2019-01-04 23:35:01 +08:00
|
|
|
componentDidUpdate() {
|
2019-01-07 10:25:23 +08:00
|
|
|
this.debouncifyUpdateSpinning();
|
2019-01-04 23:35:01 +08:00
|
|
|
this.updateSpinning();
|
2016-05-09 10:49:14 +08:00
|
|
|
}
|
2018-02-14 12:30:31 +08:00
|
|
|
|
2019-08-05 18:38:10 +08:00
|
|
|
componentWillUnmount() {
|
|
|
|
this.cancelExistingSpin();
|
|
|
|
}
|
|
|
|
|
2022-04-20 12:13:11 +08:00
|
|
|
debouncifyUpdateSpinning = (props?: SpinClassProps) => {
|
2019-01-07 10:25:23 +08:00
|
|
|
const { delay } = props || this.props;
|
|
|
|
if (delay) {
|
2019-04-15 14:30:04 +08:00
|
|
|
this.cancelExistingSpin();
|
2019-01-07 10:25:23 +08:00
|
|
|
this.updateSpinning = debounce(this.originalUpdateSpinning, delay);
|
|
|
|
}
|
2019-01-26 11:55:53 +08:00
|
|
|
};
|
2019-01-07 10:25:23 +08:00
|
|
|
|
2019-01-04 23:35:01 +08:00
|
|
|
updateSpinning = () => {
|
2018-10-09 00:02:03 +08:00
|
|
|
const { spinning } = this.props;
|
2019-01-04 23:35:01 +08:00
|
|
|
const { spinning: currentSpinning } = this.state;
|
|
|
|
if (currentSpinning !== spinning) {
|
2018-10-09 00:02:03 +08:00
|
|
|
this.setState({ spinning });
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2019-08-05 18:38:10 +08:00
|
|
|
cancelExistingSpin() {
|
|
|
|
const { updateSpinning } = this;
|
|
|
|
if (updateSpinning && (updateSpinning as any).cancel) {
|
|
|
|
(updateSpinning as any).cancel();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
isNestedPattern() {
|
2020-11-18 11:59:29 +08:00
|
|
|
return !!(this.props && typeof this.props.children !== 'undefined');
|
2019-08-05 18:38:10 +08:00
|
|
|
}
|
|
|
|
|
2022-04-20 12:13:11 +08:00
|
|
|
renderSpin = ({ direction }: ConfigConsumerProps) => {
|
2018-12-05 19:12:18 +08:00
|
|
|
const {
|
2022-04-20 12:13:11 +08:00
|
|
|
spinPrefixCls: prefixCls,
|
2018-12-07 20:02:01 +08:00
|
|
|
className,
|
|
|
|
size,
|
|
|
|
tip,
|
|
|
|
wrapperClassName,
|
2018-12-18 19:18:08 +08:00
|
|
|
style,
|
2018-12-05 19:12:18 +08:00
|
|
|
...restProps
|
|
|
|
} = this.props;
|
2018-05-22 13:01:28 +08:00
|
|
|
const { spinning } = this.state;
|
2015-10-27 10:34:05 +08:00
|
|
|
|
2018-12-07 20:02:01 +08:00
|
|
|
const spinClassName = classNames(
|
|
|
|
prefixCls,
|
|
|
|
{
|
|
|
|
[`${prefixCls}-sm`]: size === 'small',
|
|
|
|
[`${prefixCls}-lg`]: size === 'large',
|
|
|
|
[`${prefixCls}-spinning`]: spinning,
|
|
|
|
[`${prefixCls}-show-text`]: !!tip,
|
2020-01-02 19:10:16 +08:00
|
|
|
[`${prefixCls}-rtl`]: direction === 'rtl',
|
2018-12-07 20:02:01 +08:00
|
|
|
},
|
|
|
|
className,
|
|
|
|
);
|
2015-10-27 10:10:27 +08:00
|
|
|
|
2016-07-08 10:14:45 +08:00
|
|
|
// fix https://fb.me/react-unknown-prop
|
2022-04-20 12:13:11 +08:00
|
|
|
const divProps = omit(restProps, ['spinning', 'delay', 'indicator', 'prefixCls']);
|
2016-07-08 10:14:45 +08:00
|
|
|
|
2016-03-30 23:02:11 +08:00
|
|
|
const spinElement = (
|
2022-03-11 15:49:33 +08:00
|
|
|
<div
|
|
|
|
{...divProps}
|
|
|
|
style={style}
|
|
|
|
className={spinClassName}
|
|
|
|
aria-live="polite"
|
|
|
|
aria-busy={spinning}
|
|
|
|
>
|
2018-12-05 19:12:18 +08:00
|
|
|
{renderIndicator(prefixCls, this.props)}
|
2016-08-23 16:17:32 +08:00
|
|
|
{tip ? <div className={`${prefixCls}-text`}>{tip}</div> : null}
|
2016-03-30 23:02:11 +08:00
|
|
|
</div>
|
|
|
|
);
|
2015-10-31 02:00:03 +08:00
|
|
|
if (this.isNestedPattern()) {
|
2018-12-17 23:27:24 +08:00
|
|
|
const containerClassName = classNames(`${prefixCls}-container`, {
|
2016-11-07 17:53:12 +08:00
|
|
|
[`${prefixCls}-blur`]: spinning,
|
2016-11-04 13:50:32 +08:00
|
|
|
});
|
2015-10-31 02:00:03 +08:00
|
|
|
return (
|
2018-12-17 23:27:24 +08:00
|
|
|
<div {...divProps} className={classNames(`${prefixCls}-nested-loading`, wrapperClassName)}>
|
2016-11-04 13:50:32 +08:00
|
|
|
{spinning && <div key="loading">{spinElement}</div>}
|
|
|
|
<div className={containerClassName} key="container">
|
2015-10-31 02:00:03 +08:00
|
|
|
{this.props.children}
|
|
|
|
</div>
|
2018-12-17 23:27:24 +08:00
|
|
|
</div>
|
2015-10-31 02:00:03 +08:00
|
|
|
);
|
|
|
|
}
|
2016-01-07 14:21:29 +08:00
|
|
|
return spinElement;
|
2018-12-07 20:02:01 +08:00
|
|
|
};
|
2018-12-05 19:12:18 +08:00
|
|
|
|
|
|
|
render() {
|
2018-12-07 20:02:01 +08:00
|
|
|
return <ConfigConsumer>{this.renderSpin}</ConfigConsumer>;
|
2018-12-05 19:12:18 +08:00
|
|
|
}
|
2016-03-20 20:41:34 +08:00
|
|
|
}
|
2018-06-06 19:32:30 +08:00
|
|
|
|
2022-04-20 12:13:11 +08:00
|
|
|
const SpinFC: SpinFCType = (props: SpinProps) => {
|
|
|
|
const { prefixCls: customizePrefixCls } = props;
|
|
|
|
const { getPrefixCls } = React.useContext(ConfigContext);
|
|
|
|
|
|
|
|
const spinPrefixCls = getPrefixCls('spin', customizePrefixCls);
|
|
|
|
|
|
|
|
const spinClassProps: SpinClassProps = {
|
|
|
|
...props,
|
|
|
|
spinPrefixCls,
|
|
|
|
};
|
|
|
|
return <Spin {...spinClassProps} />;
|
|
|
|
};
|
|
|
|
|
|
|
|
SpinFC.setDefaultIndicator = (indicator: React.ReactNode) => {
|
|
|
|
defaultIndicator = indicator;
|
|
|
|
};
|
|
|
|
|
|
|
|
if (process.env.NODE_ENV !== 'production') {
|
|
|
|
SpinFC.displayName = 'Spin';
|
|
|
|
}
|
|
|
|
|
|
|
|
export default SpinFC;
|