mirror of
https://gitee.com/ant-design/ant-design.git
synced 2024-12-15 01:11:26 +08:00
8b19102b0d
* feat: support wave effect * docs: more info * test: add test case * docs: update demo * test: coverage
158 lines
4.2 KiB
TypeScript
158 lines
4.2 KiB
TypeScript
'use client';
|
|
|
|
import CloseOutlined from '@ant-design/icons/CloseOutlined';
|
|
import classNames from 'classnames';
|
|
import * as React from 'react';
|
|
import type { PresetColorType, PresetStatusColorType } from '../_util/colors';
|
|
import { isPresetColor, isPresetStatusColor } from '../_util/colors';
|
|
import useClosable from '../_util/hooks/useClosable';
|
|
import type { LiteralUnion } from '../_util/type';
|
|
import warning from '../_util/warning';
|
|
import Wave from '../_util/wave';
|
|
import { ConfigContext } from '../config-provider';
|
|
import CheckableTag from './CheckableTag';
|
|
import useStyle from './style';
|
|
|
|
export type { CheckableTagProps } from './CheckableTag';
|
|
|
|
export interface TagProps extends React.HTMLAttributes<HTMLSpanElement> {
|
|
prefixCls?: string;
|
|
className?: string;
|
|
rootClassName?: string;
|
|
color?: LiteralUnion<PresetColorType | PresetStatusColorType>;
|
|
closable?: boolean;
|
|
/** Advised to use closeIcon instead. */
|
|
closeIcon?: boolean | React.ReactNode;
|
|
/** @deprecated `visible` will be removed in next major version. */
|
|
visible?: boolean;
|
|
onClose?: (e: React.MouseEvent<HTMLElement>) => void;
|
|
style?: React.CSSProperties;
|
|
icon?: React.ReactNode;
|
|
bordered?: boolean;
|
|
}
|
|
|
|
export interface TagType
|
|
extends React.ForwardRefExoticComponent<TagProps & React.RefAttributes<HTMLElement>> {
|
|
CheckableTag: typeof CheckableTag;
|
|
}
|
|
|
|
const InternalTag: React.ForwardRefRenderFunction<HTMLSpanElement, TagProps> = (tagProps, ref) => {
|
|
const {
|
|
prefixCls: customizePrefixCls,
|
|
className,
|
|
rootClassName,
|
|
style,
|
|
children,
|
|
icon,
|
|
color,
|
|
onClose,
|
|
closeIcon,
|
|
closable,
|
|
bordered = true,
|
|
...props
|
|
} = tagProps;
|
|
const { getPrefixCls, direction, tag } = React.useContext(ConfigContext);
|
|
const [visible, setVisible] = React.useState(true);
|
|
|
|
// Warning for deprecated usage
|
|
if (process.env.NODE_ENV !== 'production') {
|
|
warning(
|
|
!('visible' in props),
|
|
'Tag',
|
|
'`visible` is deprecated, please use `visible && <Tag />` instead.',
|
|
);
|
|
}
|
|
|
|
React.useEffect(() => {
|
|
if ('visible' in props) {
|
|
setVisible(props.visible!);
|
|
}
|
|
}, [props.visible]);
|
|
|
|
const isInternalColor = isPresetColor(color) || isPresetStatusColor(color);
|
|
|
|
const tagStyle: React.CSSProperties = {
|
|
backgroundColor: color && !isInternalColor ? color : undefined,
|
|
...tag?.style,
|
|
...style,
|
|
};
|
|
|
|
const prefixCls = getPrefixCls('tag', customizePrefixCls);
|
|
// Style
|
|
const [wrapSSR, hashId] = useStyle(prefixCls);
|
|
|
|
const tagClassName = classNames(
|
|
prefixCls,
|
|
tag?.className,
|
|
{
|
|
[`${prefixCls}-${color}`]: isInternalColor,
|
|
[`${prefixCls}-has-color`]: color && !isInternalColor,
|
|
[`${prefixCls}-hidden`]: !visible,
|
|
[`${prefixCls}-rtl`]: direction === 'rtl',
|
|
[`${prefixCls}-borderless`]: !bordered,
|
|
},
|
|
className,
|
|
rootClassName,
|
|
hashId,
|
|
);
|
|
|
|
const handleCloseClick = (e: React.MouseEvent<HTMLElement>) => {
|
|
e.stopPropagation();
|
|
onClose?.(e);
|
|
|
|
if (e.defaultPrevented) {
|
|
return;
|
|
}
|
|
setVisible(false);
|
|
};
|
|
|
|
const [, mergedCloseIcon] = useClosable(
|
|
closable,
|
|
closeIcon,
|
|
(iconNode: React.ReactNode) =>
|
|
iconNode === null ? (
|
|
<CloseOutlined className={`${prefixCls}-close-icon`} onClick={handleCloseClick} />
|
|
) : (
|
|
<span className={`${prefixCls}-close-icon`} onClick={handleCloseClick}>
|
|
{iconNode}
|
|
</span>
|
|
),
|
|
null,
|
|
false,
|
|
);
|
|
|
|
const isNeedWave =
|
|
typeof props.onClick === 'function' ||
|
|
(children && (children as React.ReactElement<any>).type === 'a');
|
|
|
|
const iconNode: React.ReactNode = icon || null;
|
|
|
|
const kids: React.ReactNode = iconNode ? (
|
|
<>
|
|
{iconNode}
|
|
{children && <span>{children}</span>}
|
|
</>
|
|
) : (
|
|
children
|
|
);
|
|
|
|
const tagNode: React.ReactNode = (
|
|
<span {...props} ref={ref} className={tagClassName} style={tagStyle}>
|
|
{kids}
|
|
{mergedCloseIcon}
|
|
</span>
|
|
);
|
|
|
|
return wrapSSR(isNeedWave ? <Wave component="Tag">{tagNode}</Wave> : tagNode);
|
|
};
|
|
|
|
const Tag = React.forwardRef<HTMLSpanElement, TagProps>(InternalTag) as TagType;
|
|
|
|
if (process.env.NODE_ENV !== 'production') {
|
|
Tag.displayName = 'Tag';
|
|
}
|
|
|
|
Tag.CheckableTag = CheckableTag;
|
|
|
|
export default Tag;
|