ant-design/components/_util/index.zh-CN.md
二货爱吃白萝卜 bd995468aa
chore: fix GetRef for some case (#47983)
* chore: fix GetRef for some case

* test: add type test

* docs: add util doc

* fix: en

* chore: add logo
2024-03-21 15:55:40 +08:00

1.2 KiB

category title subtitle cover coverDark demo group
Components Util 工具类 https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*rRDlT7ST8DUAAAAAAAAAAAAADrJ8AQ/original https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*rRDlT7ST8DUAAAAAAAAAAAAADrJ8AQ/original
cols
2
title order
其他 99

工具类用于辅助开发,提供一些常用的工具方法。

GetRef

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

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

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

GetProps

获取组件的 props 属性定义:

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

type CheckboxGroupType = GetProps<typeof Checkbox.Group>;

GetProp

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

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

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