ant-design/components/_util/index.en-US.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 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
Other 99

Utilities are used to assist development and provide some common utility methods.

GetRef

Get the ref property definition of the component, which is very useful for components that are not directly exposed or child components.

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

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

GetProps

Get the props property definition of the component:

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

type CheckboxGroupType = GetProps<typeof Checkbox.Group>;

GetProp

Get the single props property definition of the component. It has encapsulated NonNullable, so you don't have to worry about being empty:

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

// Both of this can work
type SelectOptionType1 = GetProp<SelectProps, 'options'>[number];
type SelectOptionType2 = GetProp<typeof Select, 'options'>[number];