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

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';
-export interface DropdownProps extends BaseProps, NativeProps, PopperOptions, AnimationEventProps, TransitionProps {
+/** Dropdown 属性 */
+export interface DropdownProps extends BaseProps<React.ReactElement>, NativeProps, PopperOptions, AnimationEventProps, Omit<TransitionProps, 'children'> {
     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'> {

package/dist/Form/typings.d.ts

@@ -5,12 +5,15 @@ type BaseFormProps = Omit<React.AllHTMLAttributes<HTMLFormElement>, 'onSubmit' |
 type RenderProps = (values: Store, form: FormInstance) => React.ReactElement;
 export type FormRules = Record<string, Rule[]>;
 export interface FormProps<Values = any> extends BaseFormProps {
+    /** 经 Form.useForm() 创建的 form 控制实例，不提供时会自动创建 */
     form?: FormInstance<Values>;
     children?: RenderProps | ComponentChildren;
     component?: false | string | FC<any> | ComponentClass<any, any>;
     fields?: FieldData[];
+    /** 表单验证规则 */
     rules?: FormRules;
     name?: string;
+    /** 验证提示模板 */
     validateMessages?: ValidateMessages;
     onValuesChange?: Callbacks<Values>['onValuesChange'];
     onFieldsChange?: Callbacks<Values>['onFieldsChange'];
@@ -18,31 +21,55 @@ export interface FormProps<Values = any> extends BaseFormProps {
     onFinishFailed?: Callbacks<Values>['onFinishFailed'];
     validateTrigger?: string | string[] | false;
     preserve?: boolean;
+    /** 配置 Form.Item 的 colon 的默认值。表示是否显示 label 后面的冒号 */
     colon?: boolean;
+    /** 表单默认值，只有初始化以及重置时生效 */
     initialValues?: Store;
+    /** 表单域标签的位置， 如果值为 left 或者 right 时，则需要设置 label-width */
     labelPosition?: 'left' | 'right' | 'top';
+    /** 表单域标签的宽度，例如 '50px'。 作为 Form 直接子元素的 form-item 会继承该值。 支持 auto。 */
     labelWidth?: string | number;
+    /** 行内表单模式 */
     inline?: boolean;
+    /** 是否宽度100% */
     flat?: boolean;
+    /** 每行列数 */
+    /** 是否只读 */
     disabled?: boolean;
+    /** 用于控制该表单内组件的尺寸 */
     size?: TypeAttributes.Size;
     onChange?: (model: any) => void;
     formStyle?: React.CSSProperties;
     className?: string;
 }
 export interface FormItemProps<T> extends BaseProps, NativeProps {
+    /**
+     * 配合 label 属性使用，表示是否显示 label 后面的冒号
+     */
     colon?: boolean;
+    /** label 标签的文本 */
     label?: boolean | string | React.ReactElement;
+    /** 用于控制该表单内组件的尺寸 */
     size?: TypeAttributes.Size;
+    /** 标签的长度，例如 '50px'。 作为 Form 直接子元素的 form-item 会继承该值。 可以使用 auto。 */
     labelWidth?: string | number;
+    /** 必填样式设置。如不设置，则会根据校验规则自动生成 */
     required?: boolean;
+    /** 为 true 时不带样式，作为纯字段控件使用 */
     noStyle?: boolean;
+    /** 校验状态，如不设置，则会根据校验规则自动生成，可选：'success' 'warning' 'error' 'validating' */
     validateStatus?: 'success' | 'warning' | 'error' | 'validating';
+    /** 配置提示信息 */
     help?: string | React.ReactElement;
+    /** 是否标签宽度为0，等用于`labelWidth={0}`，如果同时设置了labelWidth，则此配置无效 */
     pure?: boolean;
+    /** 是否居中 */
     center?: boolean;
+    /** 文本自定义内联样式 */
     labelStyle?: React.CSSProperties;
+    /** 校验失败文本自定义内联样式 */
     errorStyle?: React.CSSProperties;
+    /** 校验警告自定义内联样式 */
     warningStyle?: React.CSSProperties;
 }
 export interface FieldEntity {
@@ -91,6 +118,9 @@ export interface Meta {
 export interface InternalFieldData extends Meta {
     value: StoreValue;
 }
+/**
+ * Used by `setFields` config
+ */
 export interface FieldData extends Partial<Omit<InternalFieldData, 'name'>> {
     name: NamePath;
 }
@@ -115,6 +145,7 @@ interface BaseRule {
     transform?: (value: StoreValue) => StoreValue;
     type?: RuleType;
     whitespace?: boolean;
+    /** Customize rule level `validateTrigger`. Must be subset of Field `validateTrigger` */
     validateTrigger?: string | string[];
     phone?: boolean;
 }
@@ -166,6 +197,10 @@ export interface ValidateOptions {
     label?: string | boolean | React.ReactElement<{}>;
     triggerName?: string;
     validateMessages?: ValidateMessages;
+    /**
+     * Recursive validate. It will validate all the name path that contains the provided one.
+     * e.g. ['a'] will validate ['a'] , ['a', 'b'] and ['a', 1].
+     */
     recursive?: boolean;
 }
 export type InternalValidateFields<Values = any> = (nameList?: NamePath[], options?: ValidateOptions) => Promise<Values>;
@@ -189,6 +224,11 @@ interface SetFieldInfo {
 }
 interface DependenciesUpdateInfo {
     type: 'dependenciesUpdate';
+    /**
+     * Contains all the related `InternalNamePath[]`.
+     * a <- b <- c : change `a`
+     * relatedFields=[a, b, c]
+     */
     relatedFields: InternalNamePath[];
 }
 export type NotifyInfo = ValueUpdateInfo | ValidateFinishInfo | ResetInfo | RemoveInfo | SetFieldInfo | DependenciesUpdateInfo;
@@ -216,6 +256,7 @@ export interface InternalHooks {
     setPreserve: (preserve?: boolean) => void;
     getInitialValue: (namePath: InternalNamePath) => StoreValue;
 }
+/** Only return partial when type is not any */
 type RecursivePartial<T> = T extends object ? {
     [P in keyof T]?: T[P] extends (infer U)[] ? RecursivePartial<U>[] : T[P] extends object ? RecursivePartial<T[P]> : T[P];
 } : any;
@@ -239,15 +280,29 @@ export interface FormInstance<Values = any> {
 }
 export type InternalFormInstance = Omit<FormInstance, 'validateFields'> & {
     validateFields: InternalValidateFields;
+    /**
+     * Passed by field context props
+     */
     prefixName?: InternalNamePath;
     validateTrigger?: string | string[] | false;
+    /**
+     * Form component should register some content into store.
+     * We pass the `HOOK_MARK` as key to avoid user call the function.
+     */
     getInternalHooks: (secret: string) => InternalHooks | null;
+    /** @private Internal usage. Do not use it in your production */
     _init?: boolean;
+    /** 配置 Form.Item 的 colon 的默认值。表示是否显示 label 后面的冒号 */
     colon?: boolean;
+    /** 是否禁用该表单内的所有组件。 如果设置为 true, 它将覆盖内部组件的 disabled 属性 */
     disabled?: boolean;
+    /** 表单域标签的位置， 如果值为 left 或者 right 时，则需要设置 label-width */
     labelPosition?: 'left' | 'right' | 'top';
+    /** 标签宽度，例如 '50px'。 可以使用 auto。 */
     labelWidth?: string | number;
+    /** 用于控制该表单域下组件的默认尺寸 */
     size?: TypeAttributes.Size;
+    /** 表单验证规则 */
     rules?: FormRules;
 };
 export type EventArgs = any[];

package/dist/Form/useForm.d.ts

@@ -26,7 +26,14 @@ export declare class FormStore {
     private scrollToField;
     private getInternalHooks;
     private useSubscribe;
+    /**
+     * Record prev Form unmount fieldEntities which config preserve false.
+     * This need to be refill with initialValues instead of store value.
+     */
     private prevWithoutPreserves;
+    /**
+     * First time `setInitialValues` should update store with initial value
+     */
     private setInitialValues;
     private destroyForm;
     private getInitialValue;
@@ -39,6 +46,10 @@ export declare class FormStore {
     private timeoutId;
     private warningUnhooked;
     private updateStore;
+    /**
+     * Get registered field entities.
+     * @param pure Only return field which has a `name`. Default: false
+     */
     private getFieldEntities;
     private getFieldsMap;
     private getFieldEntitiesForNamePathList;
@@ -51,15 +62,26 @@ export declare class FormStore {
     private isFieldTouched;
     private isFieldsValidating;
     private isFieldValidating;
+    /**
+     * Reset Field with field `initialValue` prop.
+     * Can pass `entities` or `namePathList` or just nothing.
+     */
     private resetWithFieldInitialValue;
     private resetFields;
     private setFields;
     private getFields;
+    /**
+     * This only trigger when a field is on constructor to avoid we get initialValue too late
+     */
     private initEntityValue;
     private isMergedPreserve;
     private registerField;
     private dispatch;
     private notifyObservers;
+    /**
+     * Notify dependencies children with parent update
+     * We need delay to trigger validate in case Field is under render props
+     */
     private triggerDependenciesUpdate;
     private updateValue;
     private setFieldsValue;

package/dist/Form/utils/NameMap.d.ts

@@ -3,6 +3,9 @@ interface KV<T> {
     key: InternalNamePath;
     value: T;
 }
+/**
+ * NameMap like a `Map` but accepts `string[]` as key.
+ */
 declare class NameMap<T> {
     private kvs;
     set(key: InternalNamePath, value: T): void;

package/dist/Form/utils/validateUtil.d.ts

@@ -1,2 +1,6 @@
 import type { InternalNamePath, RuleError, RuleObject, StoreValue, ValidateOptions } from '../typings';
+/**
+ * We use `async-validator` to validate the value.
+ * But only check one value in a time to avoid namePath validate issue.
+ */
 export declare function validateRules(namePath: InternalNamePath, value: StoreValue, rules: RuleObject[], options: ValidateOptions, validateFirst: boolean | 'parallel', messageVariables?: Record<string, string>): Promise<RuleError[]>;

package/dist/Form/utils/valueUtil.d.ts

@@ -1,4 +1,11 @@
 import type { EventArgs, InternalNamePath, NamePath, Store, StoreValue } from '../typings';
+/**
+ * Convert name to internal supported format.
+ * This function should keep since we still thinking if need support like `a.b.c` format.
+ * 'a' => ['a']
+ * 123 => [123]
+ * ['a', 123] => ['a', 123]
+ */
 export declare function getNamePath(path: NamePath | null): InternalNamePath;
 export declare function getValue(store: Store, namePath: InternalNamePath): any;
 export declare function setValue(store: Store, namePath: InternalNamePath, value: StoreValue, removeIfUndefined?: boolean): Store;
@@ -9,6 +16,16 @@ export declare function matchNamePath(namePath: InternalNamePath, changedNamePat
 type SimilarObject = string | number | {};
 export declare function isSimilar(source: SimilarObject, target: SimilarObject): boolean;
 export declare function defaultGetValueFromEvent(valuePropName: string, ...args: EventArgs): any;
+/**
+ * Moves an array item from one position in an array to another.
+ *
+ * Note: This is a pure function so a new array will be returned, instead
+ * of altering the array argument.
+ *
+ * @param array         Array in which to move an item.         (required)
+ * @param moveIndex     The index of the item to move.          (required)
+ * @param toIndex       The index to move item at moveIndex to. (required)
+ */
 export declare function move<T>(array: T[], moveIndex: number, toIndex: number): T[];
 export declare function toNamePathStr(name: NamePath): string;
 export {};

package/dist/Icon/typings.d.ts

@@ -1,12 +1,19 @@
 import React from 'react';
 import { BaseProps, NativeProps } from '../types/common';
 export interface IconProps extends Omit<React.AllHTMLAttributes<HTMLElement>, 'size' | 'style' | 'className' | 'readOnly' | 'disabled' | 'children'>, BaseProps, NativeProps {
+    /** 图标前缀，定义图标字体粗细 */
     prefix?: IconPrefix;
+    /** 图标名称 */
     name: IconName;
+    /** 图标大小 */
     size?: IconSize;
+    /** 图标是否旋转 */
     rotate?: Rotate;
+    /** 图标是否翻转 */
     flip?: Flip;
+    /** 是否动画 */
     spin?: boolean;
+    /** 是否8方向旋转 */
     pulse?: boolean;
 }
 export type SvgIconProps = Omit<IconProps, 'name'>;

package/dist/Input/Input.js

@@ -316,7 +316,7 @@ function InternalInput(props, ref) {
           }
         }
       ))),
-      suffixSlot && /* @__PURE__ */ import_react.default.createElement("span", { ref: suffixRef, key: "suffixSlot", className: (0, import_classnames.default)(e`suffix`, { "r-click": suffixCanClick }), onClick: onClickSuffix }, /* @__PURE__ */ import_react.default.createElement("span", { className: e`suffix-inner` }, suffixSlot))
+      suffixSlot && /* @__PURE__ */ import_react.default.createElement("span", { ref: suffixRef, key: "suffixSlot", className: (0, import_classnames.default)(e`suffix`, { [b("click", false)]: suffixCanClick }), onClick: onClickSuffix }, /* @__PURE__ */ import_react.default.createElement("span", { className: e`suffix-inner` }, suffixSlot))
     );
   }, [
     type,
@@ -342,6 +342,7 @@ function InternalInput(props, ref) {
     maxLength,
     handelClear,
     suffixSlot,
+    b,
     suffixCanClick,
     onClickSuffix,
     showClear,

package/dist/Input/typings.d.ts

@@ -3,11 +3,16 @@ import { BaseProps, FormControlBaseProps, NativeProps, TypeAttributes } from '..
 export type LiteralUnion<T extends U, U> = T | (U & {});
 export type ValueType = React.AllHTMLAttributes<HTMLInputElement>['value'];
 export type BaseInputRef = {
+    /** 获取值 */
     getValue: () => ValueType;
+    /** 设置值 */
     setValue: (value: ValueType) => void;
     onClear: (event?: any) => void;
+    /** 重置值 */
     clear: (event?: any) => void;
+    /** 使 input 组件获得焦点 */
     focus: () => void;
+    /** 使 input 组件失去焦点 */
     blur: () => void;
     showClear?: (value: ValueType) => void;
     hideClear?: () => void;
@@ -21,67 +26,123 @@ export type TextareaRef = {
 } & BaseInputRef;
 export interface InputProps extends FormControlBaseProps<ValueType>, BaseProps, NativeProps, Omit<React.AllHTMLAttributes<HTMLInputElement>, 'defaultValue' | 'size' | 'prefix' | 'type' | 'onInput' | 'onChange' | 'style' | 'children'> {
     size?: TypeAttributes.Size;
+    /** 初始值 */
     defaultValue?: ValueType;
+    /**
+     * text，textarea 和其他原生 input 的 type 值
+     * ref: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#%3Cinput%3E_types */
     type?: LiteralUnion<'color' | 'date' | 'datetime-local' | 'email' | 'file' | 'hidden' | 'image' | 'number' | 'password' | 'range' | 'search' | 'tel' | 'text' | 'time' | 'url' | 'week', string>;
+    /** 输入框头部内容，只对 type="text" 有效 */
     prefix?: React.ReactElement<any> | string | number;
+    /** 输入框尾部内容，只对 type="text" 有效 */
     suffix?: React.ReactElement<any> | string | number;
+    /** 输入框前置内容，只对 type="text" 有效 */
     prepend?: React.ReactElement<any> | string | number;
+    /** 输入框后置内容，只对 type="text" 有效 */
     append?: React.ReactElement | string | number;
+    /** 是否可清空 */
     clearable?: boolean;
+    /** 是否显示切换密码图标 */
     showPassword?: boolean;
+    /** 是否纯文本模式，即无边框 */
     plain?: boolean;
+    /** 表单校验错误提示 */
     error?: boolean;
+    /** 表单校验警告提示 */
     warning?: boolean;
+    /** 输入是否防抖动 */
     debounceInput?: boolean;
+    /** 获取输入建议的防抖延时，单位为毫秒 */
     debounceTime?: number;
+    /** input自定义内联样式 */
     innerStyle?: React.CSSProperties;
+    /** 范围选择时开始输入框的占位内容 */
     startPlaceholder?: string;
+    /** 范围选择时结束输入框的占位内容 */
     endPlaceholder?: string;
+    /** 最大输入长度 */
     maxLength?: number;
+    /** 原生属性，最小输入长度 */
     minLength?: number;
+    /** 是否显示统计字数, 只在 type 为 'text' 或 'textarea' 的时候生效	 */
     showWordLimit?: boolean;
+    /** 是否隐藏值 */
     hiddenValue?: boolean;
+    /** 在点击由 clearable 属性生成的清空按钮时触发 */
     onClear?: (e: MouseEvent) => void;
+    /** 在 Input 值改变时触发 */
     onChange?: (value: ValueType, event?: React.ChangeEvent) => void;
 }
 export interface InputGroupProps extends BaseProps, NativeProps {
+    /** 输入框前置内容，只对 type="text" 有效 */
     prepend?: React.ReactElement<any> | string | number;
+    /** 输入框后置内容，只对 type="text" 有效 */
     append?: React.ReactElement | string | number;
 }
 export interface TextareaProps extends Omit<React.AllHTMLAttributes<HTMLInputElement>, 'defaultValue' | 'size' | 'prefix' | 'type' | 'onInput' | 'onChange' | 'style' | 'children'>, FormControlBaseProps<ValueType>, BaseProps, NativeProps {
+    /** 初始值 */
     defaultValue?: ValueType;
+    /** 表单校验错误提示 */
     error?: boolean;
+    /** 表单校验警告提示 */
     warning?: boolean;
+    /** 是否纯文本模式，即无边框 */
     plain?: boolean;
     rows?: number;
+    /** input自定义内联样式 */
     innerStyle?: React.CSSProperties;
+    /** 最大输入长度 */
     maxLength?: number;
+    /** 原生属性，最小输入长度 */
     minLength?: number;
+    /** 是否显示统计字数, 只在 type 为 'text' 或 'textarea' 的时候生效	 */
     showWordLimit?: boolean;
+    /** 在 Input 值改变时触发 */
     onChange?: (value: ValueType, event?: React.ChangeEvent) => void;
 }
 export type InputRangeValueType = [string | null, string | null] | [number | null, number | null];
 export interface InputRangeProps<T = InputRangeValueType> extends Omit<FormControlBaseProps<T>, 'name' | 'onChange'>, BaseProps, NativeProps {
     name?: [string, string];
     size?: TypeAttributes.Size;
+    /** 只读 */
     readOnly?: boolean;
+    /** 是否激活状态 */
     active?: boolean;
     onClick?: React.MouseEventHandler<HTMLDivElement>;
+    /**
+     * text，textarea 和其他原生 input 的 type 值
+     * ref: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#%3Cinput%3E_types */
     type?: 'text' | 'hidden' | 'number';
+    /** 输入框头部内容，只对 type="text" 有效 */
     prefix?: React.ReactElement<any> | string | number;
+    /** 输入框尾部内容，只对 type="text" 有效 */
     suffix?: React.ReactElement<any> | string | number;
+    /** 输入框前置内容，只对 type="text" 有效 */
     prepend?: React.ReactElement<any> | string | number;
+    /** 输入框后置内容，只对 type="text" 有效 */
     append?: React.ReactElement | string | number;
+    /** 数值精度 */
     precision?: number;
+    /** 是否可清空 */
     clearable?: boolean;
+    /** 是否纯文本模式，即无边框 */
     plain?: boolean;
+    /** 表单校验失败 */
     error?: boolean;
+    /** 表单校验失败 */
     warning?: boolean;
+    /** 选择范围时的分隔符 */
     rangeSeparator?: string;
+    /** 输入是否防抖动 */
     debounceInput?: boolean;
+    /** input自定义内联样式 */
     innerStyle?: React.CSSProperties;
+    /** 范围选择时开始输入框的占位内容 */
     startPlaceholder?: string;
+    /** 范围选择时结束输入框的占位内容 */
     endPlaceholder?: string;
+    /** 在点击由 clearable 属性生成的清空按钮时触发 */
     onClear?: (e: MouseEvent) => void;
+    /** 选中值发生变化时触发 */
     onChange?: (value: InputRangeValueType | null, event?: Event) => void;
 }

package/dist/InputNumber/typings.d.ts

@@ -4,28 +4,49 @@ import { BaseProps, FormControlBaseProps, NativeProps } from '../types/common';
 export type LiteralUnion<T extends U, U> = T | (U & {});
 export type ValueType = number | string;
 export interface InputNumberProps<V = ValueType> extends Omit<FormControlBaseProps<V>, 'onChange'>, BaseProps<HTMLDivElement>, NativeProps, Omit<React.AllHTMLAttributes<HTMLInputElement>, 'defaultValue' | 'size' | 'prefix' | 'type' | 'onInput' | 'onChange' | 'style' | 'value' | 'ref' | 'className' | 'readOnly' | 'disabled' | 'name' | 'children'> {
+    /** 设置计数器允许的最大值 */
     max?: number;
+    /** 设置计数器允许的最小值 */
     min?: number;
+    /** 计数器步长 */
     step?: number;
+    /** 是否只能输入 step 的倍数 */
     stepStrictly?: boolean;
+    /** 数值精度 */
     precision?: number;
+    /** 控制按钮位置 */
     controlsPositionRight?: boolean;
+    /** 占位符 */
     placeholder?: string;
+    /** 绑定值被改变时触发 */
     onChange?: (currentValue: number | string, oldValue?: number | string) => void;
+    /** 样式前缀 */
     prefixCls?: string;
+    /** 表单校验错误提示 */
     error?: boolean;
+    /** 表单校验警告提示 */
     warning?: boolean;
+    /** 输入框头部内容 */
     prefix?: React.ReactElement<any> | string | number;
+    /** 输入框尾部内容 */
     suffix?: React.ReactElement<any> | string | number;
+    /** 输入框前置内容 */
     prepend?: React.ReactElement<any> | string | number;
+    /** 输入框后置内容 */
     append?: React.ReactElement | string | number;
+    /** 最大输入长度 */
     maxLength?: number;
+    /** 原生属性，最小输入长度 */
     minLength?: number;
 }
 export interface InputNumberRef {
+    /** 顶级div */
     ref: Ref<HTMLDivElement>;
+    /** input */
     input: Ref<InputRef>;
     getValue: () => number;
+    /** 使 input 组件获得焦点 */
     focus: () => void;
+    /** 使 input 组件失去焦点 */
     blur: () => void;
 }

package/dist/Link/typings.d.ts

@@ -2,10 +2,15 @@ import React from 'react';
 import { IconName } from '../Icon';
 import { BaseProps, NativeProps, TypeAttributes } from '../types/common';
 export type LinkType = TypeAttributes.Appearance;
-export interface LinkProps extends BaseProps, NativeProps, Omit<React.AllHTMLAttributes<HTMLAnchorElement>, 'type' | 'style' | 'children'> {
+export interface LinkProps extends BaseProps, NativeProps<'--el-link-font-size' | '--el-link-font-weight' | '--el-link-text-color' | '--el-link-hover-text-color' | '--el-link-disabled-text-color'>, Omit<React.AllHTMLAttributes<HTMLAnchorElement>, 'type' | 'style' | 'children'> {
+    /** 链接地址 */
     href?: string;
+    /** 链接类型 */
     type?: LinkType;
+    /** 是否下划线  */
     underline?: boolean;
+    /** 是否禁用状态  */
     disabled?: boolean;
+    /** 图标组件 */
     icon?: IconName;
 }

package/dist/Loading/typings.d.ts

@@ -2,12 +2,17 @@ import { RefObject } from 'react';
 import { IconName } from '../Icon';
 import { BaseProps, NativeProps } from '../types/common';
 export interface LoadingProps extends BaseProps, NativeProps {
+    /** Loading 需要覆盖的 DOM 节点。 可传入一个 DOM 对象或字符串； 若传入字符串，则会将其作为参数传入 document.querySelector以获取到对应 DOM 节点 */
     target?: RefObject<HTMLElement>;
     visible?: boolean;
+    /** 是否让加载组件铺满整个屏幕 */
     fullscreen?: boolean;
     lock?: boolean;
+    /** 显示在加载图标下方的加载文案 */
     text?: string;
+    /** 自定义加载图标类名 */
     spinner?: IconName;
+    /** 遮罩背景色 */
     background?: string;
 }
 export type LoadingService = (props?: LoadingProps) => {

package/dist/Message/Main.d.ts

@@ -1,5 +1,12 @@
 import React from 'react';
 import { MessageProps, MessageRef } from './typings';
+/**
+ * @author	Parker
+ * @CreateTime	2022/5/2 21:15:44
+ * @LastEditor	Parker
+ * @ModifyTime	2022/5/3 12:09:53
+ * @Description
+ */
 export declare class Main {
     ref: React.RefObject<MessageRef>;
     constructor(props: MessageProps);

package/dist/Message/index.d.ts

@@ -1,6 +1,14 @@
 import { RefObject } from 'react';
 import { MessageMethod, MessageQueue } from './typings';
 export declare const instances: MessageQueue;
+/**
+ * 消息提示组件
+ * @author	Parker
+ * @CreateTime	2022/3/10 12:45:48
+ * @LastEditor	Parker
+ * @ModifyTime	2022/5/3 12:10:04
+ * @Description	Element Plus 消息提示组件魔改过来的，源代码见：https://github.com/element-plus/element-plus
+ */
 export declare const Message: MessageMethod;
 export declare function close(id: string, userOnClose?: (el?: RefObject<HTMLElement>) => void): void;
 export declare function closeAll(): void;

package/dist/Message/typings.d.ts

@@ -6,15 +6,25 @@ export interface MessageHandle {
 }
 export interface MessageProps extends BaseProps, NativeProps, AnimationEventProps {
     id?: string;
+    /** 文字是否居中 */
     center?: boolean;
+    /** 显示时间，单位为毫秒。 设为 0 则不会自动关闭 */
     duration?: number;
+    /** 自定义图标 */
     iconClass?: string;
+    /** 消息文字 */
     message?: string | React.ReactElement;
+    /** Message 距离窗口顶部的偏移量 */
     offset?: number;
+    /** 关闭时的回调函数, 参数为被关闭的 message 实例 */
     onClose?: (el?: RefObject<HTMLElement>) => void;
+    /** 是否显示关闭按钮 */
     showClose?: boolean;
+    /** 消息类型 */
     type?: 'success' | 'warning' | 'info' | 'error' | '';
+    /** 是否立即执行onClose方法 */
     immediate?: boolean;
+    /** 合并内容相同的消息，不支持 VNode 类型的消息 */
     grouping?: boolean;
     userOnClose?: (el?: RefObject<HTMLElement>) => void;
 }
@@ -37,6 +47,7 @@ export interface MessageRef {
     message: string | React.ReactElement;
     close: () => void;
     setOffset: (val: number) => void;
+    /** 设置重复数量 */
     setReapetNum: () => void;
 }
 export type MessageQueue = Array<RefObject<MessageRef>>;