ant-design/components/_util/index.zh-CN.md
2024-08-05 12:50:19 +08:00

1.3 KiB

category title subtitle description showImport cover coverDark tag demo group
Components Util 工具类 辅助开发,提供一些常用的工具方法。 false https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*rRDlT7ST8DUAAAAAAAAAAAAADrJ8AQ/original https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*rRDlT7ST8DUAAAAAAAAAAAAADrJ8AQ/original 5.13.0
cols
2
title order
其他 99

5.13.0 版本开始提供这些方法。

GetRef

获取组件的 ref 属性定义,这对于未直接暴露或者子组件的 ref 属性定义非常有用。

import { Select } from 'antd';
import type { GetRef } from 'antd';

type SelectRefType = GetRef<typeof Select>; // BaseSelectRef

GetProps

获取组件的 props 属性定义:

import { Checkbox } from 'antd';
import type { GetProps } from 'antd';

type CheckboxGroupType = GetProps<typeof Checkbox.Group>;

GetProp

获取组件的单个 props 属性定义。它已经将 NonNullable 进行了封装,所以不用再考虑为空的情况:

import { Select } from 'antd';
import type { GetProp, SelectProps } from 'antd';

// 以下两种都可以生效
type SelectOptionType1 = GetProp<SelectProps, 'options'>[number];
type SelectOptionType2 = GetProp<typeof Select, 'options'>[number];