ant-design/components/button/button.tsx

276 lines
7.1 KiB
TypeScript
Raw Normal View History

import * as React from 'react';
2018-08-07 21:07:52 +08:00
import * as PropTypes from 'prop-types';
import classNames from 'classnames';
import { polyfill } from 'react-lifecycles-compat';
import Wave from '../_util/wave';
import Icon from '../icon';
import Group from './button-group';
import { tuple } from '../_util/type';
2016-12-19 15:19:15 +08:00
2016-03-15 14:10:25 +08:00
const rxTwoCNChar = /^[\u4e00-\u9fa5]{2}$/;
2015-09-27 16:30:35 +08:00
const isTwoCNChar = rxTwoCNChar.test.bind(rxTwoCNChar);
function isString(str: any) {
2015-09-27 16:30:35 +08:00
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.
2018-12-07 16:17:45 +08:00
if (
typeof child !== 'string' &&
typeof child !== 'number' &&
isString(child.type) &&
isTwoCNChar(child.props.children)
) {
return React.cloneElement(child, {}, child.props.children.split('').join(SPACE));
2015-09-27 16:30:35 +08:00
}
if (typeof child === 'string') {
2016-04-12 11:56:14 +08:00
if (isTwoCNChar(child)) {
child = child.split('').join(SPACE);
2016-04-12 11:56:14 +08:00
}
return <span>{child}</span>;
}
2015-09-27 16:30:35 +08:00
return child;
}
const ButtonTypes = tuple('default', 'primary', 'ghost', 'dashed', 'danger');
export type ButtonType = (typeof ButtonTypes)[number];
const ButtonShapes = tuple('circle', 'circle-outline');
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];
2016-07-14 13:29:50 +08:00
2018-05-18 18:22:33 +08:00
export interface BaseButtonProps {
2016-07-14 13:29:50 +08:00
type?: ButtonType;
icon?: string;
shape?: ButtonShape;
size?: ButtonSize;
loading?: boolean | { delay?: number };
2016-07-14 13:29:50 +08:00
prefixCls?: string;
className?: string;
ghost?: boolean;
block?: boolean;
children?: React.ReactNode;
2016-07-14 13:29:50 +08:00
}
2018-06-14 10:53:14 +08:00
export type AnchorButtonProps = {
href: string;
target?: string;
onClick?: React.MouseEventHandler<HTMLAnchorElement>;
2018-12-07 16:17:45 +08:00
} & BaseButtonProps &
React.AnchorHTMLAttributes<HTMLAnchorElement>;
2018-06-14 10:53:14 +08:00
export type NativeButtonProps = {
htmlType?: ButtonHTMLType;
onClick?: React.MouseEventHandler<HTMLButtonElement>;
2018-12-07 16:17:45 +08:00
} & BaseButtonProps &
React.ButtonHTMLAttributes<HTMLButtonElement>;
export type ButtonProps = 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;
2016-07-14 13:29:50 +08:00
static defaultProps = {
2016-04-06 15:50:58 +08:00
prefixCls: 'ant-btn',
2016-04-12 12:17:03 +08:00
loading: false,
ghost: false,
block: false,
2016-07-13 11:14:24 +08:00
};
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.string,
block: PropTypes.bool,
2016-07-13 11:14:24 +08:00
};
2018-10-25 12:57:31 +08:00
static getDerivedStateFromProps(nextProps: ButtonProps, prevState: ButtonState) {
if (nextProps.loading instanceof Boolean) {
return {loading: nextProps.loading}
}
return null;
}
private delayTimeout: number;
2018-10-30 16:08:55 +08:00
private buttonNode: HTMLElement | null;
constructor(props: ButtonProps) {
super(props);
this.state = {
loading: props.loading,
hasTwoCNChar: false,
};
}
componentDidMount() {
this.fixTwoCNChar();
}
componentDidUpdate(prevProps: ButtonProps, _prevState: ButtonState) {
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 === this.props.loading) {
return;
} else {
this.setState({loading});
}
}
2016-07-14 13:29:50 +08:00
2016-05-28 15:31:39 +08:00
componentWillUnmount() {
if (this.delayTimeout) {
clearTimeout(this.delayTimeout);
}
2016-05-28 15:31:39 +08:00
}
2018-10-30 16:08:55 +08:00
saveButtonRef = (node: HTMLElement | null) => {
this.buttonNode = node;
2018-12-07 16:17:45 +08:00
};
2018-10-30 16:08:55 +08:00
fixTwoCNChar() {
// Fix for HOC usage like <FormatMessage />
2018-10-30 16:08:55 +08:00
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,
});
}
}
2018-06-14 10:53:14 +08:00
handleClick: React.MouseEventHandler<HTMLButtonElement | HTMLAnchorElement> = e => {
const { loading } = this.state;
const { onClick } = this.props;
if (!!loading) {
return;
}
2016-10-24 12:04:26 +08:00
if (onClick) {
2018-06-14 10:53:14 +08:00
(onClick as React.MouseEventHandler<HTMLButtonElement | HTMLAnchorElement>)(e);
2016-10-24 12:04:26 +08:00
}
2018-12-07 16:17:45 +08:00
};
isNeedInserted() {
const { icon, children } = this.props;
return React.Children.count(children) === 1 && !icon;
}
2015-09-27 16:30:35 +08:00
render() {
const {
2018-12-07 16:17:45 +08:00
type,
shape,
size,
className,
children,
icon,
prefixCls,
ghost,
loading: _loadingProp,
block,
...rest
} = this.props;
2015-09-27 16:30:35 +08:00
const { loading, hasTwoCNChar } = this.state;
// large => lg
// small => sm
let sizeCls = '';
switch (size) {
case 'large':
sizeCls = 'lg';
break;
case 'small':
sizeCls = 'sm';
default:
break;
}
const classes = classNames(prefixCls, className, {
2016-04-06 15:50:58 +08:00
[`${prefixCls}-${type}`]: type,
[`${prefixCls}-${shape}`]: shape,
[`${prefixCls}-${sizeCls}`]: sizeCls,
2018-12-20 17:34:30 +08:00
[`${prefixCls}-icon-only`]: !children && children !== 0 && icon,
2016-04-12 12:17:03 +08:00
[`${prefixCls}-loading`]: loading,
[`${prefixCls}-background-ghost`]: ghost,
[`${prefixCls}-two-chinese-chars`]: hasTwoCNChar,
[`${prefixCls}-block`]: block,
});
2015-09-27 16:30:35 +08:00
2016-04-12 12:17:03 +08:00
const iconType = loading ? 'loading' : icon;
2016-12-26 19:46:01 +08:00
const iconNode = iconType ? <Icon type={iconType} /> : null;
2018-12-07 16:17:45 +08:00
const kids =
children || children === 0
? React.Children.map(children, child => insertSpace(child, this.isNeedInserted()))
: null;
const linkButtonRestProps = rest as AnchorButtonProps;
if (linkButtonRestProps.href !== undefined) {
2018-06-14 10:53:14 +08:00
return (
<a
{...linkButtonRestProps}
2018-06-14 10:53:14 +08:00
className={classes}
onClick={this.handleClick}
2018-10-30 16:08:55 +08:00
ref={this.saveButtonRef}
2018-06-14 10:53:14 +08:00
>
2018-12-07 16:17:45 +08:00
{iconNode}
{kids}
2018-06-14 10:53:14 +08:00
</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;
return (
<Wave>
<button
2018-12-07 16:17:45 +08:00
{...otherProps as NativeButtonProps}
type={htmlType || 'button'}
className={classes}
onClick={this.handleClick}
ref={this.saveButtonRef}
>
2018-12-07 16:17:45 +08:00
{iconNode}
{kids}
</button>
</Wave>
);
2015-09-27 16:30:35 +08:00
}
}
polyfill(Button);
export default Button;