antd
Version:
An enterprise-class UI design language and React components implementation
107 lines (106 loc) • 3.74 kB
JavaScript
"use client";
import * as React from 'react';
import QuestionCircleOutlined from "@ant-design/icons/es/icons/QuestionCircleOutlined";
import { clsx } from 'clsx';
import convertToTooltipProps from '../_util/convertToTooltipProps';
import Col from '../grid/col';
import { useLocale } from '../locale';
import defaultLocale from '../locale/en_US';
import Tooltip from '../tooltip';
import { FormContext } from './context';
const FormItemLabel = ({
prefixCls,
label,
htmlFor,
labelCol,
labelAlign,
colon,
required,
requiredMark,
tooltip,
vertical
}) => {
const [formLocale] = useLocale('Form');
const {
labelAlign: contextLabelAlign,
labelCol: contextLabelCol,
labelWrap,
colon: contextColon,
classNames: contextClassNames,
styles: contextStyles
} = React.useContext(FormContext);
if (!label) {
return null;
}
const mergedLabelCol = labelCol || contextLabelCol || {};
const mergedLabelAlign = labelAlign || contextLabelAlign;
const labelClsBasic = `${prefixCls}-item-label`;
const labelColClassName = clsx(labelClsBasic, mergedLabelAlign === 'left' && `${labelClsBasic}-left`, mergedLabelCol.className, {
[`${labelClsBasic}-wrap`]: !!labelWrap
});
let labelChildren = label;
// Keep label is original where there should have no colon
const computedColon = colon === true || contextColon !== false && colon !== false;
const haveColon = computedColon && !vertical;
// Remove duplicated user input colon
if (haveColon && typeof label === 'string' && label.trim()) {
labelChildren = label.replace(/[:|：]\s*$/, '');
}
// Tooltip
const tooltipProps = convertToTooltipProps(tooltip);
if (tooltipProps) {
const {
icon = /*#__PURE__*/React.createElement(QuestionCircleOutlined, null),
...restTooltipProps
} = tooltipProps;
const tooltipNode = /*#__PURE__*/React.createElement(Tooltip, {
...restTooltipProps
}, /*#__PURE__*/React.cloneElement(icon, {
className: `${prefixCls}-item-tooltip`,
title: '',
onClick: e => {
// Prevent label behavior in tooltip icon
// https://github.com/ant-design/ant-design/issues/46154
e.preventDefault();
},
tabIndex: null
}));
labelChildren = /*#__PURE__*/React.createElement(React.Fragment, null, labelChildren, tooltipNode);
}
// Required Mark
const isOptionalMark = requiredMark === 'optional';
const isRenderMark = typeof requiredMark === 'function';
const hideRequiredMark = requiredMark === false;
if (isRenderMark) {
labelChildren = requiredMark(labelChildren, {
required: !!required
});
} else if (isOptionalMark && !required) {
labelChildren = /*#__PURE__*/React.createElement(React.Fragment, null, labelChildren, /*#__PURE__*/React.createElement("span", {
className: `${prefixCls}-item-optional`,
title: ""
}, formLocale?.optional || defaultLocale.Form?.optional));
}
// https://github.com/ant-design/ant-design/pull/52950#discussion_r1980880316
let markType;
if (hideRequiredMark) {
markType = 'hidden';
} else if (isOptionalMark || isRenderMark) {
markType = 'optional';
}
const labelClassName = clsx(contextClassNames?.label, {
[`${prefixCls}-item-required`]: required,
[`${prefixCls}-item-required-mark-${markType}`]: markType,
[`${prefixCls}-item-no-colon`]: !computedColon
});
return /*#__PURE__*/React.createElement(Col, {
...mergedLabelCol,
className: labelColClassName
}, /*#__PURE__*/React.createElement("label", {
htmlFor: htmlFor,
className: labelClassName,
style: contextStyles?.label,
title: typeof label === 'string' ? label : ''
}, labelChildren));
};
export default FormItemLabel;