@qsxy/element-plus-react 1.0.0-next.2 → 1.0.0-next.3

package/dist/ColorPicker/Predefine.d.ts

@@ -8,5 +8,12 @@ interface Props {
 export interface PredefineRef {
     update: () => void;
 }
+/**
+ * @author	Parker
+ * @CreateTime	2022/5/14 19:24:19
+ * @LastEditor	Parker
+ * @ModifyTime	2025/2/22 19:59:12
+ * @Description	Element Plus 颜色选择器组件魔改过来的，源代码见：https://github.com/element-plus/element-plus
+ */
 declare const Predefine: React.ForwardRefExoticComponent<Props & React.RefAttributes<PredefineRef>>;
 export default Predefine;

package/dist/ColorPicker/SvPanel.d.ts

@@ -7,5 +7,12 @@ interface Props {
 export interface SvPanelRef {
     update: () => void;
 }
+/**
+ * @author	Parker
+ * @CreateTime	2022/5/14 16:16:37
+ * @LastEditor	Parker
+ * @ModifyTime	2022/11/20 11:54:52
+ * @Description	Element Plus 颜色选择器组件魔改过来的，源代码见：https://github.com/element-plus/element-plus
+ */
 declare const SvPanel: React.ForwardRefExoticComponent<Props & React.RefAttributes<SvPanelRef>>;
 export default SvPanel;

package/dist/ColorPicker/typings.d.ts

@@ -1,13 +1,22 @@
 import { PopperOptions } from '../Popper';
 import { AnimationEventProps, BaseProps, NativeProps, TypeAttributes } from '../types/common';
 export interface ColorPickerProps extends BaseProps, NativeProps, AnimationEventProps, PopperOptions {
+    /** 绑定值（可控模式） */
     value?: string;
+    /** 默认值 */
     defaultValue?: string;
+    /** 是否禁用 */
     disabled?: boolean;
+    /** 尺寸 */
     size?: TypeAttributes.Size;
+    /** 是否支持透明度选择 */
     showAlpha?: boolean;
+    /** 颜色的格式 */
     colorFormat?: 'hsl' | 'hsv' | 'hex' | 'rgb';
+    /** 预定义颜色 */
     predefine?: string[];
+    /** 当绑定值变化时触发 */
     onChange?: (value?: string) => void;
+    /** 面板中当前显示的颜色发生改变时触发 */
     activeChange?: (value?: string) => void;
 }

package/dist/ConfigProvider/ConfigProvider.d.ts

@@ -1,9 +1,14 @@
 /// <reference types="react" />
 export interface ConfigProviderProps {
+    /** 对按钮进行配置 */
     button?: {
+        /** 自动在两个中文字符之间插入空格 */
         autoInsertSpace?: boolean;
     };
+    /** 对消息进行配置 */
+    /** 对数字输入框进行配置 */
     inputNumber?: {
+        /** 控制按钮位置 */
         controlsPositionRight?: boolean;
         max?: number;
         min?: number;

package/dist/DatePicker/typings.d.ts

@@ -12,84 +12,153 @@ export type DatePickerRef = {
     setVisible: (value: boolean) => void;
 };
 export interface DatePickerProps extends Omit<FormControlBaseProps, 'name' | 'value' | 'defaultValue' | 'onChange'>, BaseProps, NativeProps, AnimationEventProps, Omit<React.AllHTMLAttributes<HTMLInputElement>, 'value' | 'defaultValue' | 'size' | 'prefix' | 'type' | 'onInput' | 'onChange' | 'className' | 'style' | 'readOnly' | 'disabled' | 'children'> {
+    /** 等价于原生 name 属性 */
     name?: string;
+    /** 选中项绑定值 */
     value?: string;
+    /** 默认值 */
     defaultValue?: string;
+    /** 只读 */
     readonly?: boolean;
+    /** 必输项*/
     required?: boolean;
+    /** 是否显示清除按钮 */
     clearable?: boolean;
+    /** 非范围选择时的占位内容 */
     placeholder?: string;
+    /** 是否展示“今天”按钮 */
     showToday?: boolean;
+    /** 显示类型 */
     type?: DateType;
+    /** 显示在输入框中的格式 */
     format?: string;
+    /** 可选，绑定值的格式。 不指定则绑定值为 Date 对象 */
     valueFormat?: string;
+    /** 设置ISO周数，其中1为星期一，7为星期日 */
     isoWeek?: boolean;
+    /** 表单校验错误提示 */
     error?: boolean;
+    /** 表单校验警告提示 */
     warning?: boolean;
+    /** 输入框前置内容，只对 type="text" 有效 */
     prepend?: React.ReactElement<any> | string | number;
+    /** 输入框后置内容，只对 type="text" 有效 */
     append?: React.ReactElement | string | number;
+    /** 是否纯文本模式，即无边框 */
     plain?: boolean;
     size?: TypeAttributes.Size;
+    /** 一个用来判断该日期是否被禁用的函数，接受一个 Date 对象作为参数。 应该返回一个 Boolean 值。 */
     disabledDate?: (time: Date) => boolean;
     shortcuts?: Shortcuts[];
+    /** 是否追加到body下 */
     appendToBody?: boolean;
+    /** 点击确定按钮的回调 */
     onOk?: () => void;
     onChange?: (value: string | Date | number, event?: Event) => void;
+    /** 格式化 */
     formatter?: (value: Dayjs, text: number) => React.ReactElement;
 }
 export interface DatePickerRangeProps extends Omit<FormControlBaseProps, 'name' | 'value' | 'defaultValue' | 'onChange'>, BaseProps, AnimationEventProps, NativeProps {
+    /** 等价于原生 name 属性 */
     name?: [string, string];
+    /** 选中项绑定值 */
     value?: [string, string];
+    /** 默认值 */
     defaultValue?: [string, string];
+    /** 只读 */
     readOnly?: boolean;
+    /** 禁用 */
     disabled?: boolean;
+    /** 是否显示清除按钮 */
     clearable?: boolean;
+    /** 范围选择时开始日期的占位内容 */
     startPlaceholder?: string;
+    /** 范围选择时结束日期的占位内容 */
     endPlaceholder?: string;
+    /** 显示类型 */
     type?: DateRangeType;
+    /** 显示在输入框中的格式 */
     format?: string;
+    /** 可选，绑定值的格式。 不指定则绑定值为 Date 对象 */
     valueFormat?: string;
+    /** 选择范围时的分隔符 */
     rangeSeparator?: string;
+    /** 在范围选择器里取消两个日期面板之间的联动 */
     unlinkPanels?: boolean;
+    /** 设置ISO周数，其中1为星期一，7为星期日 */
     isoWeek?: boolean;
+    /** 表单校验错误提示 */
     error?: boolean;
+    /** 表单校验警告提示 */
     warning?: boolean;
+    /** 输入框前置内容，只对 type="text" 有效 */
     prepend?: React.ReactElement<any> | string | number;
+    /** 输入框后置内容，只对 type="text" 有效 */
     append?: React.ReactElement | string | number;
+    /** 点击确定按钮的回调 */
     onOk?: () => void;
+    /** 一个用来判断该日期是否被禁用的函数，接受一个 Date 对象作为参数。 应该返回一个 Boolean 值。 */
     disabledDate?: (time: Date) => boolean;
     onChange?: (value: [string, string] | [Date, Date] | [number, number], event?: Event) => void;
+    /** 格式化 */
     formatter?: (value: Dayjs, text: number) => React.ReactElement;
 }
 export interface AllDatePickerProps extends Omit<FormControlBaseProps, 'name' | 'value' | 'defaultValue' | 'onChange'>, BaseProps, NativeProps, AnimationEventProps, Omit<React.AllHTMLAttributes<HTMLInputElement>, 'name' | 'value' | 'defaultValue' | 'size' | 'prefix' | 'type' | 'onInput' | 'onChange' | 'className' | 'style' | 'readOnly' | 'disabled' | 'children'> {
+    /** 等价于原生 name 属性 */
     name?: string | [string, string];
+    /** 选中项绑定值 */
     value?: string | Date | number | [string, string] | [Date, Date] | [number, number];
+    /** 默认值 */
     defaultValue?: string | Date | number | [string, string] | [Date, Date] | [number, number];
+    /** 只读 */
     readonly?: boolean;
+    /** 必输项*/
     required?: boolean;
+    /** 是否显示清除按钮 */
     clearable?: boolean;
+    /** 非范围选择时的占位内容 */
     placeholder?: string;
+    /** 是否展示“今天”按钮 */
     showToday?: boolean;
+    /** 显示类型 */
     type?: DateType | DateRangeType;
+    /** 显示在输入框中的格式 */
     format?: string;
+    /** 可选，绑定值的格式。 不指定则绑定值为 Date 对象 */
     valueFormat?: string;
+    /** 设置ISO周数，其中1为星期一，7为星期日 */
     isoWeek?: boolean;
+    /** 表单校验错误提示 */
     error?: boolean;
+    /** 表单校验警告提示 */
     warning?: boolean;
+    /** 输入框前置内容，只对 type="text" 有效 */
     prepend?: React.ReactElement<any> | string | number;
+    /** 输入框后置内容，只对 type="text" 有效 */
     append?: React.ReactElement | string | number;
+    /** 是否纯文本模式，即无边框 */
     plain?: boolean;
     size?: TypeAttributes.Size;
+    /** 一个用来判断该日期是否被禁用的函数，接受一个 Date 对象作为参数。 应该返回一个 Boolean 值。 */
     disabledDate?: (time: Date) => boolean;
     shortcuts?: Shortcuts[];
+    /** 是否追加到body下 */
     appendToBody?: boolean;
+    /** 点击确定按钮的回调 */
     onOk?: () => void;
     onChange?: (value: string | Date | number | [string, string] | [Date, Date] | [number, number], event?: Event) => void;
+    /** 格式化 */
     formatter?: (value: Dayjs, text: number) => React.ReactElement;
+    /** 只读 */
     readOnly?: boolean;
+    /** 禁用 */
     disabled?: boolean;
+    /** 范围选择时开始日期的占位内容 */
     startPlaceholder?: string;
+    /** 范围选择时结束日期的占位内容 */
     endPlaceholder?: string;
+    /** 选择范围时的分隔符 */
     rangeSeparator?: string;
+    /** 在范围选择器里取消两个日期面板之间的联动 */
     unlinkPanels?: boolean;
 }

package/dist/DateTimePicker/typings.d.ts

@@ -4,6 +4,7 @@ import { PopperOptionRef } from '../Popper';
 export type DateTimePickerRef = {
     inputInstance?: InputRef;
     popperInstRef: PopperOptionRef;
+    /** �Ƿ�׷�ӵ�body�� */
     appendToBody?: boolean;
     getValue: () => string;
     setValue: (value: string) => void;

package/dist/Descriptions/DescriptionsContext.d.ts

@@ -1,6 +1,8 @@
 /// <reference types="react" />
 interface DescriptionsContextProps {
+    /** 排列的方向 */
     direction?: 'vertical' | 'horizontal';
+    /** 是否带有边框 */
     border?: boolean;
 }
 export declare const DescriptionsContext: import("react").Context<DescriptionsContextProps>;

package/dist/Descriptions/typings.d.ts

@@ -1,19 +1,32 @@
 import React from 'react';
 import { BaseProps, NativeProps, TypeAttributes } from '../types/common';
 export interface DescriptionsProps extends BaseProps<React.ReactElement<DescriptionsItemProps> | React.ReactElement<DescriptionsItemProps>[]>, NativeProps<'--el-descriptions-table-border' | '--el-descriptions-item-bordered-label-background'> {
+    /** 是否带有边框 */
     border?: boolean;
+    /** 一行 Descriptions Item 的数量 */
     column?: number;
+    /** 排列的方向 */
     direction?: 'vertical' | 'horizontal';
+    /** 列表的尺寸 */
     size?: TypeAttributes.Size;
+    /** 标题文本，显示在左上方 */
     title?: string | React.ReactElement<any>;
+    /** 操作区文本，显示在右上方 */
     extra?: string | React.ReactElement<any>;
 }
 export interface DescriptionsItemProps extends BaseProps, NativeProps {
+    /** 标签文本 */
     label?: string | React.ReactElement<any>;
+    /** 列的数量 */
     span?: number;
+    /** 列的宽度，不同行相同列的宽度按最大值设定（如无 border ，宽度包含标签与内容） */
     width?: number | string;
+    /** 列的最小宽度，与 width 的区别是 width 是固定的，minWidth 会把剩余宽度按比例分配给设置了 minWidth 的列（如无 border，宽度包含标签与内容） */
     minWidth?: number | string;
+    /** 列的内容对齐方式（如无 border，对标签和内容均生效） */
     align?: 'left' | 'center' | 'right';
+    /** 列的标签对齐方式，若不设置该项，则使用内容的对齐方式（如无 border，请使用 align 参数） */
     labelAlign?: 'left' | 'center' | 'right';
+    /** 列标题自定义类名 */
     labelClassName?: string;
 }

package/dist/Dialog/DialogContext.d.ts

@@ -1,13 +1,21 @@
 /// <reference types="react" />
 interface DialogContentProps {
+    /** 当设置为 true，Dialog 打开时会显示背景，点击背景会关闭 Dialog，如果不想关闭 Dialog，可以设置为 'static' */
     backdrop: boolean | 'static';
     setVisible: (visible: boolean) => void;
+    /** 隐藏时的回调函数 */
     doClose: () => void;
+    /** 是否可控 */
     isControlled: boolean;
+    /** 是否让 Dialog 的 header 和 footer 部分居中排列 */
     center: boolean;
+    /** body 内容过长时自动设置高度 */
     overflow: boolean;
+    /** 是否加载成功 */
     mounted?: boolean;
+    /** 是否有标题 */
     haveTitle: boolean;
+    /** 是否有按钮组 */
     haveFooter: boolean;
 }
 export declare const DialogContext: import("react").Context<DialogContentProps>;

package/dist/Dialog/typings.d.ts

@@ -2,47 +2,83 @@ import React from 'react';
 import { TransitionProps } from '../Transition';
 import { AnimationEventProps, BaseProps, NativeProps } from '../types/common';
 export interface DialogProps extends AnimationEventProps, BaseProps, NativeProps, TransitionProps {
+    /** 是否显示模态框（可控） */
     visible?: boolean;
+    /** 默认是否显示模态框 */
     defaultVisible?: boolean;
+    /** 是否需要遮罩层 */
     modal?: boolean;
+    /** 遮罩的自定义类名 */
     className?: string;
+    /** 是否可以通过点击 modal 关闭 Dialog */
     closeOnClickModal?: boolean;
+    /** 应用于 backdrop DOM 节点的 css class */
     backdropClassName?: string;
+    /** 对话框的宽度，默认值为 50% */
     width?: string | number;
+    /** header 部分的自定义 class 名 */
     headerClass?: string;
+    /** Dialog 对话框 Dialog 的标题， 也可通过ElDialog.header传入 */
     title?: string | React.ReactElement;
+    /** 当设置为 true, 显示关闭按钮 */
     showClose?: boolean;
+    /** 标题是否有边框 */
     border?: boolean;
+    /** dialog CSS 中的 margin-top 值，默认为 15vh */
     top?: string;
+    /** 是否让 Dialog 的 header 和 footer 部分居中排列 */
     center?: boolean;
+    /** 是否水平垂直对齐对话框 */
     alignCenter?: boolean;
+    /** 为 Dialog 启用可拖拽功能 */
     draggable?: boolean;
+    /** 拖动范围可以超出可视区 */
     overflow?: boolean;
+    /** 是否为全屏 Dialog */
     fullscreen?: boolean;
+    /** 是否在 Dialog 出现时将 body 滚动锁定 */
     lockScroll?: boolean;
+    /** 是否可以通过按下 ESC 关闭 Dialog */
+    /** 和原生的 CSS 的 z-index 相同，改变 z 轴的顺序 */
     zIndex?: number;
+    /** Dialog 打开的回调 */
     onOpen?: () => void;
+    /** Dialog 打开动画结束时的回调 */
     onOpened?: () => void;
+    /** Dialog 关闭的回调 */
     onClose?: () => void;
+    /** Dialog 关闭动画结束时的回调 */
     onClosed?: () => void;
+    /** 关闭弹窗函数 */
     close?: () => void;
+    /** 关闭前的回调，会暂停 Dialog 的关闭. 回调函数内执行 done 参数方法的时候才是真正关闭对话框的时候. */
     beforeClose?: DialogBeforeCloseFn;
 }
 type DoneFn = (cancel?: boolean) => void;
 export type DialogBeforeCloseFn = (done: DoneFn) => void;
 export interface DialogHeaderProps extends BaseProps {
+    /** header 部分的自定义 class 名 */
     headerClass?: string;
+    /** 当设置为 true, 显示关闭按钮 */
     showClose?: boolean;
+    /** 标题是否有边框 */
     border?: boolean;
+    /** 组件 CSS 类的前缀 */
     classPrefix?: string;
+    /** 隐藏时的回调函数 */
+    /** 自定义标题内联样式 */
     titleStyle?: React.CSSProperties;
 }
 export interface DialogBodyProps extends BaseProps, NativeProps {
+    /** 组件 CSS 类的前缀 */
     classPrefix?: string;
+    /** 内容区域padding */
     padding?: string | number;
 }
 export interface DialogFooterProps extends BaseProps, NativeProps {
+    /** 组件 CSS 类的前缀 */
     classPrefix?: string;
+    /** 内容位置 */
     position?: 'left' | 'center' | 'right';
 }
 export {};

package/dist/Divider/Divider.d.ts

@@ -1,9 +1,13 @@
 import React from 'react';
 import { BaseProps, NativeProps } from '../types/common';
 export interface DividerProps extends BaseProps, NativeProps<'--el-divider-text-bg-color' | '--el-divider-border-color' | '--el-divider-margin' | '--el-divider-tip-bg-color' | '--el-border-style'> {
+    /** 设置分割线方向 */
     direction?: 'horizontal' | 'vertical';
+    /** 设置分隔符样式 */
     borderStyle?: string;
+    /** 自定义文本样式 */
     textStyle?: React.CSSProperties;
+    /** 设置分割线文案的位置 */
     contentPosition?: 'left' | 'right' | 'center';
 }
 declare const _default: React.NamedExoticComponent<DividerProps>;

package/dist/Drawer/DrawerContext.d.ts

@@ -1,9 +1,19 @@
 /// <reference types="react" />
 interface DrawerContentProps {
+    /** 当设置为 true，Drawer 打开时会显示背景，点击背景会关闭 Drawer，如果不想关闭 Drawer，可以设置为 'static' */
     backdrop: boolean | 'static';
     setVisible: (visible: boolean) => void;
+    /** 隐藏时的回调函数 */
     onClose: () => void;
+    /** 是否可控 */
     isControlled: boolean;
 }
+/**
+ * @author	Parker
+ * @CreateTime	2022/3/20下午3:10:40
+ * @LastEditor	Parker
+ * @ModifyTime	2022/5/3 22:55:13
+ * @Description 模态框上下文
+ */
 export declare const DrawerContext: import("react").Context<DrawerContentProps>;
 export {};

package/dist/Drawer/typings.d.ts

@@ -1,26 +1,42 @@
 import React from 'react';
 import { AnimationEventProps, BaseProps, NativeProps } from '../types/common';
 export interface DrawerProps extends AnimationEventProps, BaseProps, NativeProps {
+    /** 是否显示抽屉（可控） */
     visible?: boolean;
+    /** 默认是否显示抽屉 */
     defaultVisible?: boolean;
+    /** 当设置为 true，Drawer 打开时会显示背景，点击背景会关闭 Drawer，如果不想关闭 Drawer，可以设置为 'static' */
     backdrop?: boolean | 'static';
+    /** 应用于 backdrop DOM 节点的 css class */
     backdropClassName?: string;
+    /** 设置 Drawer 尺寸 */
     size?: 'full' | 'large' | 'md' | 'small' | 'xs';
+    /** 设置 Drawer 显示的位置 */
     placement?: 'top' | 'bottom' | 'right' | 'left';
+    /** 显示时的回调函数 */
     onOpen?: () => void;
+    /** 隐藏时的回调函数 */
     onClose?: () => void;
 }
 export interface DrawerHeaderProps extends BaseProps, NativeProps {
+    /** 当设置为 true, 显示关闭按钮 */
     closeButton?: boolean;
+    /** 标题是否有边框 */
     border?: boolean;
+    /** 组件 CSS 类的前缀 */
     classPrefix?: string;
+    /** 隐藏时的回调函数 */
     onClose?: () => void;
+    /** 自定义标题内联样式 */
     titleStyle?: React.CSSProperties;
 }
 export interface DrawerBodyProps extends BaseProps, NativeProps {
+    /** 组件 CSS 类的前缀 */
     classPrefix?: string;
+    /** 内容区域padding */
     padding?: string | number;
 }
 export interface DrawerFooterProps extends BaseProps, NativeProps {
+    /** 组件 CSS 类的前缀 */
     classPrefix?: string;
 }

package/dist/Dropdown/DropdownContext.d.ts

@@ -1,6 +1,8 @@
 /// <reference types="react" />
 interface DropdownContextProps {
+    /** 是否在点击菜单项后隐藏菜单 */
     hideOnClick: boolean;
+    /** 点击菜单项触发的事件回调 */
     onClick: (command: string | number | object) => void;
 }
 export declare const DropdownContext: import("react").Context<DropdownContextProps>;

package/dist/Dropdown/typings.d.ts

@@ -2,26 +2,41 @@ import React from 'react';
 import { PopperOptions } from '../Popper';
 import { TransitionProps } from '../Transition';
 import { AnimationEventProps, BaseProps, NativeProps } from '../types/common';
+/** Dropdown 属性 */
 export interface DropdownProps extends BaseProps, NativeProps, PopperOptions, AnimationEventProps, TransitionProps {
     menu: React.ReactElement<DropdownMenuProps>;
+    /** 触发下拉的行为 */
     trigger?: 'hover' | 'click' | 'contextmenu';
+    /** 是否在点击菜单项后隐藏菜单 */
     hideOnClick?: boolean;
+    /** 展开下拉菜单的延时，仅在 trigger 为 hover 时有效 */
     showTimeout?: number;
+    /** 收起下拉菜单的延时（仅在 trigger 为 hover 时有效） */
     hideTimeout?: number;
+    /** 状态是否可见 */
     visible?: boolean;
+    /** 初始值 */
     defaultVisible?: boolean;
+    /** 是否禁用 */
     disabled?: boolean;
     onMouseEnter?: (e?: React.MouseEvent<any>) => void;
     onMouseLeave?: (e?: React.MouseEvent<any>) => void;
+    /** 点击菜单项触发的事件回调 */
     onClick?: (command: string | number | object) => void;
+    /** 下拉框出现/隐藏时触发: 出现则为 true，隐藏则为 false */
     visiblechange?: (visible: boolean) => void;
 }
 export interface DropdownMenuProps extends BaseProps, NativeProps {
     classPrefix?: string;
 }
+/** Dropdown-Item 属性 */
 export interface DropdownItemProps extends BaseProps, NativeProps {
+    /** 派发到command回调函数的指令参数 */
     command?: string | number | object;
+    /** 是否禁用*/
     disabled?: boolean;
+    /** 是否显示分隔符 */
     divided?: boolean;
+    /** 是否为激活状态 */
     active?: boolean;
 }

package/dist/Form/FormItem.d.ts

@@ -9,14 +9,22 @@ interface ChildProps {
 }
 export interface InternalFieldProps<Values = any> extends Omit<FormItemProps<Values>, 'children'> {
     children?: ComponentChildren | ((control: ChildProps, meta: Meta, form: FormInstance<Values>) => React.ReactElement);
+    /**
+     * Set up `dependencies` field.
+     * When dependencies field update and current field is touched,
+     * will trigger validate rules and render.
+     */
     dependencies?: NamePath[];
     getValueFromEvent?: (...args: EventArgs) => StoreValue;
+    /** 字段名，支持数组 */
     name?: InternalNamePath;
     normalize?: (value: StoreValue, prevValue: StoreValue, allValues: Store) => StoreValue;
+    /** 校验规则，设置字段的校验逻辑。点击此处查看示例 */
     rules?: Rule[];
     shouldUpdate?: ShouldUpdate<Values>;
     trigger?: string;
     validateTrigger?: string | string[] | false;
+    /** 当某一规则校验不通过时，是否停止剩下的规则的校验。设置 parallel 时会并行校验 */
     validateFirst?: boolean | 'parallel';
     valuePropName?: string;
     getValueProps?: (value: StoreValue) => Record<string, unknown>;
@@ -27,8 +35,12 @@ export interface InternalFieldProps<Values = any> extends Omit<FormItemProps<Val
         destroy?: boolean;
     }) => void;
     preserve?: boolean;
+    /** @private Passed by Form.List props. Do not use since it will break by path check. */
     isListField?: boolean;
+    /** @private Passed by Form.List props. Do not use since it will break by path check. */
     isList?: boolean;
+    /** @private Pass context as prop instead of context api
+     *  since class component can not get context in constructor */
     fieldContext?: InternalFormInstance;
 }
 export interface FieldProps<Values = any> extends Omit<InternalFieldProps<Values>, 'name' | 'fieldContext'> {