contributors
Available since 5.13.0.
Get the ref property definition of the component, which is very useful for components that are not directly exposed or child components.
import { Select } from 'antd';import type { GetRef } from 'antd';type SelectRefType = GetRef<typeof Select>; // BaseSelectRef
Get the props property definition of the component:
import { Checkbox } from 'antd';import type { GetProps } from 'antd';type CheckboxGroupType = GetProps<typeof Checkbox.Group>;
Also supports getting the property definition of Context:
import type { GetProps } from 'antd';interface InternalContextProps {name: string;}const Context = React.createContext<InternalContextProps>({ name: 'Ant Design' });type ContextType = GetProps<typeof Context>; // InternalContextProps
Get the single props or context property definition of the component. It has encapsulated NonNullable, so you don't have to worry about it being empty:
import { Select } from 'antd';import type { GetProp, SelectProps } from 'antd';// Both of these can worktype SelectOptionType1 = GetProp<SelectProps, 'options'>[number];type SelectOptionType2 = GetProp<typeof Select, 'options'>[number];type ContextOptionType = GetProp<typeof Context, 'name'>;
Also supports getting the return type of a function property through the third parameter 'Return':
import type { GetProp } from 'antd';interface Props {func?: (value: number) => string;configOrFunc?: { configA?: string } | (() => { anotherB?: string });}type OnChangeReturn = GetProp<Props, 'func', 'Return'>; // stringtype ClassNamesReturn = GetProp<Props, 'configOrFunc', 'Return'>; // { anotherB?: string }