mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-24 19:19:57 +08:00
314 lines
8.6 KiB
TypeScript
314 lines
8.6 KiB
TypeScript
/* eslint-disable react/button-has-type */
|
|
import * as React from 'react';
|
|
import * as PropTypes from 'prop-types';
|
|
import classNames from 'classnames';
|
|
import { Loading } from '@ant-design/icons';
|
|
import { polyfill } from 'react-lifecycles-compat';
|
|
import omit from 'omit.js';
|
|
|
|
import Group from './button-group';
|
|
import { ConfigConsumer, ConfigConsumerProps } from '../config-provider';
|
|
import Wave from '../_util/wave';
|
|
import { Omit, tuple } from '../_util/type';
|
|
|
|
const rxTwoCNChar = /^[\u4e00-\u9fa5]{2}$/;
|
|
const isTwoCNChar = rxTwoCNChar.test.bind(rxTwoCNChar);
|
|
function isString(str: any) {
|
|
return typeof str === 'string';
|
|
}
|
|
|
|
// Insert one space between two chinese characters automatically.
|
|
function insertSpace(child: React.ReactChild, needInserted: boolean) {
|
|
// Check the child if is undefined or null.
|
|
if (child == null) {
|
|
return;
|
|
}
|
|
const SPACE = needInserted ? ' ' : '';
|
|
// strictNullChecks oops.
|
|
if (
|
|
typeof child !== 'string' &&
|
|
typeof child !== 'number' &&
|
|
isString(child.type) &&
|
|
isTwoCNChar(child.props.children)
|
|
) {
|
|
return React.cloneElement(child, {}, child.props.children.split('').join(SPACE));
|
|
}
|
|
if (typeof child === 'string') {
|
|
if (isTwoCNChar(child)) {
|
|
child = child.split('').join(SPACE);
|
|
}
|
|
return <span>{child}</span>;
|
|
}
|
|
return child;
|
|
}
|
|
|
|
function spaceChildren(children: React.ReactNode, needInserted: boolean) {
|
|
let isPrevChildPure: boolean = false;
|
|
const childList: React.ReactNode[] = [];
|
|
React.Children.forEach(children, child => {
|
|
const type = typeof child;
|
|
const isCurrentChildPure = type === 'string' || type === 'number';
|
|
if (isPrevChildPure && isCurrentChildPure) {
|
|
const lastIndex = childList.length - 1;
|
|
const lastChild = childList[lastIndex];
|
|
childList[lastIndex] = `${lastChild}${child}`;
|
|
} else {
|
|
childList.push(child);
|
|
}
|
|
|
|
isPrevChildPure = isCurrentChildPure;
|
|
});
|
|
|
|
// Pass to React.Children.map to auto fill key
|
|
return React.Children.map(childList, child =>
|
|
insertSpace(child as React.ReactChild, needInserted),
|
|
);
|
|
}
|
|
|
|
const ButtonTypes = tuple('default', 'primary', 'ghost', 'dashed', 'danger', 'link', 'danger-link');
|
|
export type ButtonType = typeof ButtonTypes[number];
|
|
const ButtonShapes = tuple('circle', 'circle-outline', 'round');
|
|
export type ButtonShape = typeof ButtonShapes[number];
|
|
const ButtonSizes = tuple('large', 'default', 'small');
|
|
export type ButtonSize = typeof ButtonSizes[number];
|
|
const ButtonHTMLTypes = tuple('submit', 'button', 'reset');
|
|
export type ButtonHTMLType = typeof ButtonHTMLTypes[number];
|
|
|
|
export interface BaseButtonProps {
|
|
type?: ButtonType;
|
|
icon?: React.ReactNode;
|
|
shape?: ButtonShape;
|
|
size?: ButtonSize;
|
|
loading?: boolean | { delay?: number };
|
|
prefixCls?: string;
|
|
className?: string;
|
|
ghost?: boolean;
|
|
block?: boolean;
|
|
children?: React.ReactNode;
|
|
}
|
|
|
|
// Typescript will make optional not optional if use Pick with union.
|
|
// Should change to `AnchorButtonProps | NativeButtonProps` and `any` to `HTMLAnchorElement | HTMLButtonElement` if it fixed.
|
|
// ref: https://github.com/ant-design/ant-design/issues/15930
|
|
export type AnchorButtonProps = {
|
|
href: string;
|
|
target?: string;
|
|
onClick?: React.MouseEventHandler<HTMLElement>;
|
|
} & BaseButtonProps &
|
|
Omit<React.AnchorHTMLAttributes<any>, 'type' | 'onClick'>;
|
|
|
|
export type NativeButtonProps = {
|
|
htmlType?: ButtonHTMLType;
|
|
onClick?: React.MouseEventHandler<HTMLElement>;
|
|
} & BaseButtonProps &
|
|
Omit<React.ButtonHTMLAttributes<any>, 'type' | 'onClick'>;
|
|
|
|
export type ButtonProps = Partial<AnchorButtonProps & NativeButtonProps>;
|
|
|
|
interface ButtonState {
|
|
loading?: boolean | { delay?: number };
|
|
hasTwoCNChar: boolean;
|
|
}
|
|
|
|
class Button extends React.Component<ButtonProps, ButtonState> {
|
|
static Group: typeof Group;
|
|
|
|
static __ANT_BUTTON = true;
|
|
|
|
static defaultProps = {
|
|
loading: false,
|
|
ghost: false,
|
|
block: false,
|
|
htmlType: 'button',
|
|
};
|
|
|
|
static propTypes = {
|
|
type: PropTypes.string,
|
|
shape: PropTypes.oneOf(ButtonShapes),
|
|
size: PropTypes.oneOf(ButtonSizes),
|
|
htmlType: PropTypes.oneOf(ButtonHTMLTypes),
|
|
onClick: PropTypes.func,
|
|
loading: PropTypes.oneOfType([PropTypes.bool, PropTypes.object]),
|
|
className: PropTypes.string,
|
|
icon: PropTypes.node,
|
|
block: PropTypes.bool,
|
|
title: PropTypes.string,
|
|
};
|
|
|
|
private delayTimeout: number;
|
|
|
|
private buttonNode: HTMLElement | null;
|
|
|
|
constructor(props: ButtonProps) {
|
|
super(props);
|
|
this.state = {
|
|
loading: props.loading,
|
|
hasTwoCNChar: false,
|
|
};
|
|
}
|
|
|
|
componentDidMount() {
|
|
this.fixTwoCNChar();
|
|
}
|
|
|
|
componentDidUpdate(prevProps: ButtonProps) {
|
|
this.fixTwoCNChar();
|
|
|
|
if (prevProps.loading && typeof prevProps.loading !== 'boolean') {
|
|
clearTimeout(this.delayTimeout);
|
|
}
|
|
|
|
const { loading } = this.props;
|
|
if (loading && typeof loading !== 'boolean' && loading.delay) {
|
|
this.delayTimeout = window.setTimeout(() => {
|
|
this.setState({ loading });
|
|
}, loading.delay);
|
|
} else if (prevProps.loading !== loading) {
|
|
// eslint-disable-next-line react/no-did-update-set-state
|
|
this.setState({ loading });
|
|
}
|
|
}
|
|
|
|
componentWillUnmount() {
|
|
if (this.delayTimeout) {
|
|
clearTimeout(this.delayTimeout);
|
|
}
|
|
}
|
|
|
|
saveButtonRef = (node: HTMLElement | null) => {
|
|
this.buttonNode = node;
|
|
};
|
|
|
|
handleClick: React.MouseEventHandler<HTMLButtonElement | HTMLAnchorElement> = e => {
|
|
const { loading } = this.state;
|
|
const { onClick } = this.props;
|
|
if (loading) {
|
|
return;
|
|
}
|
|
if (onClick) {
|
|
(onClick as React.MouseEventHandler<HTMLButtonElement | HTMLAnchorElement>)(e);
|
|
}
|
|
};
|
|
|
|
fixTwoCNChar() {
|
|
// Fix for HOC usage like <FormatMessage />
|
|
if (!this.buttonNode) {
|
|
return;
|
|
}
|
|
const buttonText = this.buttonNode.textContent || this.buttonNode.innerText;
|
|
if (this.isNeedInserted() && isTwoCNChar(buttonText)) {
|
|
if (!this.state.hasTwoCNChar) {
|
|
this.setState({
|
|
hasTwoCNChar: true,
|
|
});
|
|
}
|
|
} else if (this.state.hasTwoCNChar) {
|
|
this.setState({
|
|
hasTwoCNChar: false,
|
|
});
|
|
}
|
|
}
|
|
|
|
isNeedInserted() {
|
|
const { icon, children, type } = this.props;
|
|
return React.Children.count(children) === 1 && !icon && type !== 'link';
|
|
}
|
|
|
|
renderButton = ({ getPrefixCls, autoInsertSpaceInButton }: ConfigConsumerProps) => {
|
|
const {
|
|
prefixCls: customizePrefixCls,
|
|
type,
|
|
shape,
|
|
size,
|
|
className,
|
|
children,
|
|
icon,
|
|
ghost,
|
|
block,
|
|
...rest
|
|
} = this.props;
|
|
const { loading, hasTwoCNChar } = this.state;
|
|
|
|
const prefixCls = getPrefixCls('btn', customizePrefixCls);
|
|
const autoInsertSpace = autoInsertSpaceInButton !== false;
|
|
|
|
// large => lg
|
|
// small => sm
|
|
let sizeCls = '';
|
|
switch (size) {
|
|
case 'large':
|
|
sizeCls = 'lg';
|
|
break;
|
|
case 'small':
|
|
sizeCls = 'sm';
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
|
|
const iconType = loading ? 'loading' : icon;
|
|
|
|
const classes = classNames(prefixCls, className, {
|
|
[`${prefixCls}-${type}`]: type,
|
|
[`${prefixCls}-${shape}`]: shape,
|
|
[`${prefixCls}-${sizeCls}`]: sizeCls,
|
|
[`${prefixCls}-icon-only`]: !children && children !== 0 && iconType,
|
|
[`${prefixCls}-loading`]: !!loading,
|
|
[`${prefixCls}-background-ghost`]: ghost,
|
|
[`${prefixCls}-two-chinese-chars`]: hasTwoCNChar && autoInsertSpace,
|
|
[`${prefixCls}-block`]: block,
|
|
});
|
|
|
|
const iconNode = loading ? <Loading /> : icon || null;
|
|
const kids =
|
|
children || children === 0
|
|
? spaceChildren(children, this.isNeedInserted() && autoInsertSpace)
|
|
: null;
|
|
|
|
const linkButtonRestProps = omit(rest as AnchorButtonProps, ['htmlType', 'loading']);
|
|
if (linkButtonRestProps.href !== undefined) {
|
|
return (
|
|
<a
|
|
{...linkButtonRestProps}
|
|
className={classes}
|
|
onClick={this.handleClick}
|
|
ref={this.saveButtonRef}
|
|
>
|
|
{iconNode}
|
|
{kids}
|
|
</a>
|
|
);
|
|
}
|
|
|
|
// React does not recognize the `htmlType` prop on a DOM element. Here we pick it out of `rest`.
|
|
const { htmlType, ...otherProps } = rest as NativeButtonProps;
|
|
|
|
const buttonNode = (
|
|
<button
|
|
{...(omit(otherProps, ['loading']) as NativeButtonProps)}
|
|
type={htmlType}
|
|
className={classes}
|
|
onClick={this.handleClick}
|
|
ref={this.saveButtonRef}
|
|
>
|
|
{iconNode}
|
|
{kids}
|
|
</button>
|
|
);
|
|
|
|
if (type === 'link' || type === 'danger-link') {
|
|
return buttonNode;
|
|
}
|
|
|
|
return <Wave>{buttonNode}</Wave>;
|
|
};
|
|
|
|
render() {
|
|
return <ConfigConsumer>{this.renderButton}</ConfigConsumer>;
|
|
}
|
|
}
|
|
|
|
polyfill(Button);
|
|
|
|
export default Button;
|