Skip to content

feat(Form): FormItem add tooltip attributes #7014

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 16, 2023
Merged

feat(Form): FormItem add tooltip attributes #7014

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
baa56cf
feat(Form): FormItem add tooltip attributes
Oct 11, 2023
7c6ba70
fix: Delete duplicate types
Oct 12, 2023
3d86c16
fix: Remove excess slots and types
Oct 16, 2023
f2c0ea7
Update FormItemLabel.tsx
tangjinzhou Oct 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion components/form/FormItem.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@ export const formItemProps = () => ({
messageVariables: { type: Object as PropType<Record<string, string>> },
hidden: Boolean,
noStyle: Boolean,
tooltip: String,
});

export type FormItemProps = Partial<ExtractPropTypes<ReturnType<typeof formItemProps>>>;
Expand Down Expand Up @@ -155,6 +156,7 @@ export default defineComponent({
label: any;
extra: any;
default: any;
tooltip: any;
}>,
setup(props, { slots, attrs, expose }) {
warning(props.prop === undefined, `\`prop\` is deprecated. Please use \`name\` instead.`);
Expand Down Expand Up @@ -505,7 +507,8 @@ export default defineComponent({
requiredMark={formContext.requiredMark.value}
prefixCls={prefixCls.value}
onClick={onLabelClick}
label={props.label ?? slots.label?.()}
label={props.label}
v-slots={{ label: slots.label, tooltip: slots.tooltip }}
/>
{/* Input Group */}
<FormItemInput
Expand Down
26 changes: 20 additions & 6 deletions components/form/FormItemLabel.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ import defaultLocale from '../locale/en_US';
import classNames from '../_util/classNames';
import type { VueNode } from '../_util/type';
import type { FunctionalComponent, HTMLAttributes } from 'vue';
import Tooltip from '../tooltip';
import QuestionCircleOutlined from '@ant-design/icons-vue/QuestionCircleOutlined';

export interface FormItemLabelProps {
colon?: boolean;
Expand All @@ -19,6 +21,7 @@ export interface FormItemLabelProps {
required?: boolean;
prefixCls: string;
onClick: Function;
tooltip: string;
}

const FormItemLabel: FunctionalComponent<FormItemLabelProps> = (props, { slots, emit, attrs }) => {
Expand Down Expand Up @@ -59,12 +62,23 @@ const FormItemLabel: FunctionalComponent<FormItemLabelProps> = (props, { slots,
labelChildren = (label as string).replace(/[:|：]\s*$/, '');
}

labelChildren = (
<>
{labelChildren}
{slots.tooltip?.({ class: `${prefixCls}-item-tooltip` })}
</>
);
// Tooltip
if (props.tooltip || slots.tooltip) {
const tooltipNode = (
<span class={`${prefixCls}-item-tooltip`}>
<Tooltip title={props.tooltip}>
<QuestionCircleOutlined />
</Tooltip>
</span>
);

labelChildren = (
<>
{labelChildren}
{slots.tooltip ? slots.tooltip?.({ class: `${prefixCls}-item-tooltip` }) : tooltipNode}
</>
);
}

// Add required mark if optional
if (requiredMark === 'optional' && !required) {
Expand Down
1 change: 1 addition & 0 deletions components/form/index.en-US.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ A form consists of one or more form fields whose type includes input, textarea,
| name | a key of `model`. In the use of validate and resetFields method, the attribute is required | [NamePath](#namepath) | | 2.0.0 |
| required | Whether provided or not, it will be generated by the validation rule. | boolean | false | |
| rules | validation rules of form | object \| array | | |
| tooltip | Config tooltip info | string \| slot | | 4.0.4 |
| validateFirst | Whether stop validate on first rule of error for this field. | boolean | false | |
| validateStatus | The validation status. If not provided, it will be generated by validation rule. options: 'success' 'warning' 'error' 'validating' | string | | |
| validateTrigger | When to validate the value of children node | string \| string\[] | `change` | |
Expand Down
1 change: 1 addition & 0 deletions components/form/index.zh-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*ylFATY6w-ygAAA
| name | 表单域 model 字段，在使用 validate、resetFields 方法的情况下，该属性是必填的 | [NamePath](#namepath) | | |
| required | 是否必填，如不设置，则会根据校验规则自动生成 | boolean | false | |
| rules | 表单验证规则 | object \| array | | |
| tooltip | 配置提示信息 | string \| slot | | 4.0.4 |
| validateFirst | 当某一规则校验不通过时，是否停止剩下的规则的校验。 | boolean | false | 2.0.0 |
| validateStatus | 校验状态，如不设置，则会根据校验规则自动生成，可选：'success' 'warning' 'error' 'validating' | string | | |
| validateTrigger | 设置字段校验的时机 | string \| string\[] | `change` | 2.0.0 |
Expand Down