ant-design/components/tag/CheckableTag.tsx
𝑾𝒖𝒙𝒉 0fba5f81a8
docs(tag): Improve document description (#54330)
* docs: update icon property documentation for CheckableTag to reflect version support

* Update components/tag/demo/icon.md

Co-authored-by: afc163 <afc163@gmail.com>
Signed-off-by: 𝑾𝒖𝒙𝒉 <wxh16144@qq.com>

* chore: update

---------

Signed-off-by: 𝑾𝒖𝒙𝒉 <wxh16144@qq.com>
Co-authored-by: afc163 <afc163@gmail.com>
2025-07-09 10:24:21 +08:00

75 lines
1.7 KiB
TypeScript

import * as React from 'react';
import classNames from 'classnames';
import { ConfigContext } from '../config-provider';
import useStyle from './style';
export interface CheckableTagProps {
prefixCls?: string;
className?: string;
style?: React.CSSProperties;
/**
* It is an absolute controlled component and has no uncontrolled mode.
*
* .zh-cn 该组件为完全受控组件,不支持非受控用法。
*/
checked: boolean;
children?: React.ReactNode;
/**
* @since 5.27.0
*/
icon?: React.ReactNode;
onChange?: (checked: boolean) => void;
onClick?: (e: React.MouseEvent<HTMLSpanElement, MouseEvent>) => void;
}
const CheckableTag = React.forwardRef<HTMLSpanElement, CheckableTagProps>((props, ref) => {
const {
prefixCls: customizePrefixCls,
style,
className,
checked,
children,
icon,
onChange,
onClick,
...restProps
} = props;
const { getPrefixCls, tag } = React.useContext(ConfigContext);
const handleClick = (e: React.MouseEvent<HTMLSpanElement, MouseEvent>) => {
onChange?.(!checked);
onClick?.(e);
};
const prefixCls = getPrefixCls('tag', customizePrefixCls);
// Style
const [wrapCSSVar, hashId, cssVarCls] = useStyle(prefixCls);
const cls = classNames(
prefixCls,
`${prefixCls}-checkable`,
{
[`${prefixCls}-checkable-checked`]: checked,
},
tag?.className,
className,
hashId,
cssVarCls,
);
return wrapCSSVar(
<span
{...restProps}
ref={ref}
style={{ ...style, ...tag?.style }}
className={cls}
onClick={handleClick}
>
{icon}
<span>{children}</span>
</span>,
);
});
export default CheckableTag;