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

package/dist/MessageBox/typings.d.ts

@@ -3,37 +3,70 @@ import { DialogFooterProps, DialogProps } from '../Dialog/typings';
 import { IconName, IconProps } from '../Icon';
 import { AnimationEventProps, BaseProps, NativeProps, TypeAttributes } from '../types/common';
 export interface MessageBoxProps extends BaseProps, NativeProps, AnimationEventProps {
+    /** 标题 */
     title?: string | React.ReactElement;
+    /** 消息正文内容 */
     message?: string | React.ReactElement;
+    /** 是否将 message 属性作为 HTML 片段处理 */
+    /** 消息类型，用于显示图标 */
     type?: 'success' | 'info' | 'warning' | 'error';
+    /** 消息自定义图标，该属性会覆盖 type 的图标 */
     icon?: IconName | React.ReactElement<IconProps>;
+    /** 遮罩的自定义类名 */
     modalClass?: string;
+    /** 自定义确认按钮及取消按钮的大小 */
     width?: DialogProps['width'];
+    /** 若不使用 Promise，可以使用此参数指定 MessageBox 关闭后的回调函数, instance 为 MessageBox 实例， 可以通过它访问实例上的属性和方法 */
     callback?: (value: string, action: Action) => any | ((action: Action) => any);
+    /** 是否显示右上角关闭按钮 */
     showClose?: boolean;
+    /** 是否可以通过点击 modal 关闭 MessageBox */
     closeOnClickModal?: boolean;
+    /** 关闭前的回调，会暂停消息弹出框的关闭过程；instance为 MessageBox 实例，可以通过它访问实例上的属性和方法；done用于关闭 MessageBox 实例 */
     beforeClose?: (action?: Action, done?: () => void, ref?: RefObject<MessageBoxRef>) => void;
+    /** 是否显示取消按钮（以 confirm 和 prompt 方式调用时为 true） */
     showCancelButton?: boolean;
+    /** 是否显示确定按钮 */
     showConfirmButton?: boolean;
+    /** 取消按钮的文本内容 */
     cancelButtonText?: string;
+    /** 确定按钮的文本内容 */
     confirmButtonText?: string;
+    /** 取消按钮的自定义类名 */
     cancelButtonClass?: string;
+    /** 确定按钮的自定义类名 */
     confirmButtonClass?: string;
+    /** 自定义确认和取消按钮的尺寸 */
     buttonSize?: TypeAttributes.Size;
+    /** 按钮位置 */
     buttonPosition?: DialogFooterProps['position'];
+    /** 是否将取消（点击取消按钮）与关闭（点击关闭按钮或遮罩层、按下 Esc 键）进行区分 */
     distinguishCancelAndClose?: boolean;
+    /** 内容区域padding */
     padding?: string | number;
+    /** 是否在 MessageBox 出现时将 body 滚动锁定 */
     lockScroll?: boolean;
+    /** 是否显示输入框 */
     showInput?: boolean;
+    /** 输入框占位文本 */
     inputPlaceholder?: string;
+    /** 输入框的类型 */
     inputType?: string;
+    /** 输入框的初始文本 */
     inputValue?: string;
+    /** 输入框的校验表达式 */
     inputPattern?: RegExp;
+    /** 输入框的校验函数。 应该返回一个 boolean 或者 string， 如果返回的是一个 string 类型，那么该返回值会被赋值给 inputErrorMessage 用于向用户展示错误消息。 */
     inputValidator?: (value: string) => boolean | string;
+    /** 校验未通过时的提示文本 */
     inputErrorMessage?: string;
+    /** 是否居中布局 */
     center?: boolean;
+    /** 为 MessageBox 启用可拖拽功能 */
     draggable?: boolean;
+    /** 拖动范围可以超出可视区 */
     overflow?: boolean;
+    /** 是否使用圆角按钮 */
     roundButton?: boolean;
 }
 export type MessageState = {
@@ -51,13 +84,30 @@ export interface MessageBoxInputData {
 export type ElMessageBoxShortcutMethod = (((message: MessageBoxProps['message'], title: MessageBoxProps['title'], options?: Omit<MessageBoxProps, 'message' | 'title'>) => Promise<MessageBoxData>) & ((message: MessageBoxProps['message'], options?: Omit<MessageBoxProps, 'message' | 'title'>) => Promise<MessageBoxData>));
 export interface MessageBoxMethod {
     (options?: MessageBoxProps): Promise<MessageBoxData>;
+    /**
+     * 消息弹窗提示
+     * @param message 消息内容
+     * @param title 标题
+     * @param options 其他设置项
+     * @returns
+     */
     alert: ElMessageBoxShortcutMethod;
+    /**
+     * 确认消息
+     * @param message 消息内容
+     * @param title 标题
+     * @param options 其他设置项
+     * @returns
+     */
     confirm: ElMessageBoxShortcutMethod;
     prompt: ElMessageBoxShortcutMethod;
 }
 export interface MessageBoxRef {
     ref: RefObject<HTMLDivElement>;
+    /** 关闭方法 */
     close: () => void;
+    /** 设置确认按钮是否加载状态 */
     setConfirmButtonLoading: (value: boolean) => void;
+    /** 修改确认按钮文本方法 */
     setConfirmButtonText: (value: string) => void;
 }

package/dist/Notification/Main.d.ts

@@ -1,5 +1,12 @@
 import { RefObject } from 'react';
 import { NotificationProps, NotificationRef } from './typings';
+/**
+ * @author	Parker
+ * @CreateTime	2022/3/10 12:45:48
+ * @LastEditor	Parker
+ * @ModifyTime	2022/5/3 12:24:58
+ * @Description
+ */
 export declare class Main {
     ref: RefObject<NotificationRef>;
     constructor(props: NotificationProps);

package/dist/Notification/index.d.ts

@@ -1,5 +1,20 @@
 import type { INotification, NotificationRef, Position } from './typings';
+/**
+ * 通知组件
+ * @author	Parker
+ * @CreateTime	2022/3/10 12:45:48
+ * @LastEditor	Parker
+ * @ModifyTime	2022/5/3 13:43:28
+ * @Description	Element Plus 通知组件魔改过来的，源代码见：https://github.com/element-plus/element-plus
+ */
 export declare const Notification: INotification;
+/**
+ *
+ * @param id
+ * @param position
+ * @param userOnClose
+ * @returns
+ */
 export declare function close(id: string, position: Position, userOnClose?: (vm: NotificationRef) => void): void;
 export declare function closeAll(): void;
 export type { INotification, INotificationHandle, NotificationProps as INotificationOptions } from './typings';

package/dist/Notification/typings.d.ts

@@ -18,18 +18,31 @@ export interface INotification {
     closeAll: () => void;
 }
 export interface NotificationProps extends BaseProps, NativeProps, AnimationEventProps {
+    /** 标题 */
     title?: string;
+    /** 通知栏正文内容 */
     message?: string | React.ReactElement;
+    /** 是否将 message 属性作为 HTML 片段处理 */
     dangerouslyUseHTMLString?: boolean;
+    /** 通知的类型	 */
     type?: 'success' | 'warning' | 'info' | 'error' | '';
+    /** 显示时间, 单位为毫秒。 值为 0 则不会自动关闭 */
     duration?: number;
+    /** 自定义弹出位置 */
     position?: Position;
+    /** 是否显示关闭按钮 */
     showClose?: boolean;
+    /** 关闭时的回调函数 */
     onClose?: () => void;
+    /**  */
     iconClass?: string;
+    /**  */
     id?: string;
+    /** 点击 Notification 时的回调函数 */
     onClick?: () => void;
+    /** 相对屏幕顶部的偏移量 偏移的距离，在同一时刻，所有的 Notification 实例应当具有一个相同的偏移量 */
     offset?: number;
+    /**  */
     onSuccess?: (ref: HTMLDivElement) => void;
 }
 export interface NotificationRef {

package/dist/Pagination/typings.d.ts

@@ -1,41 +1,69 @@
 import React from 'react';
 import { BaseProps, NativeProps } from '../types/common';
 export interface PaginationRef {
+    /** 当前页数 */
     pageNum: number;
+    /** 每页条数 */
     pageSize: number;
+    /** 设置当前页数 */
     setPageNum: (value: number) => void;
+    /** 设置每页条数 */
     setPageSize: (value: number) => void;
 }
 export interface PaginationProps extends BaseProps, NativeProps {
+    /** 当前页数 */
     current?: number;
+    /** 默认的当前页数 */
     defaultCurrent?: number;
+    /** 禁用分页 */
     disabled?: boolean;
+    /** 数据总数 */
     total: number;
+    /** 默认的每页条数 */
     defaultPageSize?: number;
+    /** 每页条数 */
     pageSize?: number;
+    /** 指定每页可以显示多少条 */
     pageSizeOptions?: Array<string>;
+    /** 只有一页时是否隐藏分页器 */
     hideOnSinglePage?: boolean;
+    /**  */
     showPrevNextJumpers?: boolean;
+    /** 是否可以快速跳转至某页 */
     showQuickJumper?: boolean | {
         goButton: React.ReactElement;
     };
+    /** 用于显示数据总量和当前数据顺序 */
     showTotal?: (total: number, [from, to]: [number, number]) => React.ReactElement | boolean | string;
+    /** 是否显示较少页面内容 */
     showLessItems?: boolean;
+    /** 是否显示原生 tooltip 页码提示 */
     showTitle?: boolean;
+    /** 是否展示 pageSize 切换器，当 total 大于 50 时默认为 true */
     showSizeChanger?: boolean;
+    /** pageSize 变化的回调 */
     onShowSizeChange?: (current?: number, size?: number) => void;
+    /** 用于自定义页码的结构，可用于优化 SEO */
     itemRender?: (page: number, type: PageType, element: React.ReactElement) => React.ReactElement<{
         disabled?: boolean;
     }>;
+    /** 页码或 pageSize 改变的回调，参数是改变后的页码及每页条数 */
     onChange?: (current: number, pageSize: number) => void;
+    /** 当添加该属性时，显示为简单分页 */
     simple?: boolean;
+    /** 当为 small 时，是小尺寸分页 */
     size?: 'small';
 }
 export type PageType = 'page' | 'prev' | 'next' | 'jump-prev' | 'jump-next';
 export interface PagerProps extends BaseProps, NativeProps {
+    /** 页数 */
     page: number;
+    /** 是否显示原生 tooltip 页码提示 */
     showTitle?: boolean;
+    /** 是否激活状态 */
     active?: boolean;
+    /** 点击事件 */
     onClick?: (page: number) => void;
+    /** 用于自定义页码的结构，可用于优化 SEO */
     itemRender?: (current: number, type: PageType, element: React.ReactElement) => React.ReactElement;
 }

package/dist/Popconfirm/typings.d.ts

@@ -3,14 +3,24 @@ import { PopperOptions } from '../Popper';
 import { BaseProps, NativeProps, TypeAttributes } from '../types/common';
 export interface PopconfirmProps extends BaseProps, NativeProps, PopperOptions {
     classPrefix?: string;
+    /** 显示的内容 */
     title: string;
+    /** 确认按钮文字 */
     confirmButtonText?: string;
+    /** 取消按钮文字 */
     cancelButtonText?: string;
+    /** 确认按钮类型 */
     confirmButtonType?: TypeAttributes.Appearance;
+    /** 取消按钮类型 */
     cancelButtonType?: TypeAttributes.Appearance;
+    /** 自定义图标 */
     icon?: IconName;
+    /** Icon 颜色 */
     iconColor?: string;
+    /** 是否隐藏 Icon */
     hideIcon?: boolean;
+    /** 点击确认按钮时触发 */
     onConfirm?: () => void;
+    /** 点击取消按钮时触发 */
     onCancel?: () => void;
 }

package/dist/Popover/typings.d.ts

@@ -2,17 +2,29 @@ import React from 'react';
 import { PopperOptions } from '../Popper';
 import { TransitionProps } from '../Transition';
 import { AnimationEventProps, BaseProps, NativeProps } from '../types/common';
+/** Dropdown 属性 */
 export interface PopoverProps extends BaseProps, NativeProps, PopperOptions, AnimationEventProps, TransitionProps {
+    /** 触发下拉的行为 */
     trigger?: 'hover' | 'click' | 'contextmenu';
+    /** 标题 */
     title?: string;
+    /** 显示的内容 */
     content?: string | React.ReactElement;
+    /** 默认提供的主题 */
     theme?: 'light' | 'dark' | string;
+    /** 宽度 */
     width?: number | string;
+    /** Popover 是否可用 */
     disabled?: boolean;
+    /** 展开下拉菜单的延时，仅在 trigger 为 hover 时有效 */
     showTimeout?: number;
+    /** 收起下拉菜单的延时（仅在 trigger 为 hover 时有效） */
     hideTimeout?: number;
+    /** 状态是否可见 */
     visible?: boolean;
+    /** 初始值 */
     defaultVisible?: boolean;
+    /** 是否纯文本 */
     plain?: boolean;
     onMouseEnter?: (e?: React.MouseEvent<any>) => void;
     onMouseLeave?: (e?: React.MouseEvent<any>) => void;

package/dist/Popper/typings.d.ts

@@ -17,13 +17,19 @@ export interface PopperOptionRef {
 }
 export type PopperOptions = {
     popperInstRef?: React.MutableRefObject<PopperOptionRef>;
+    /** 出现位置的偏移量 */
     offset?: number;
+    /** 出现的位置 */
     placement?: Placement;
+    /** 是否显示箭头 */
     arrowOffset?: number;
+    /** 箭头距离边缘的位置 */
     showArrow?: boolean;
+    /** 为 popper 添加自定义类名 */
     popperClass?: string;
+    /** 为 popper 添加自定义内联样式 */
     popperStyle?: React.CSSProperties;
-    effect?: 'light' | 'dark';
+    effect?: 'light' | 'dark' | string;
     popperOptions?: Options;
 };
 export type PopperProps = {

package/dist/Progress/typings.d.ts

@@ -1,18 +1,30 @@
 import { BaseProps, NativeProps } from '../types/common';
 export interface PropgressProps extends BaseProps, NativeProps {
+    /** 百分比，必填 */
     percentage: number;
+    /** 进度条类型 */
     type?: 'line' | 'circle' | 'dashboard';
+    /** 进度条的宽度 */
     strokeWidth?: number;
+    /** 进度条显示文字内置在进度条内（仅 type 为 'line' 时可用） */
     textInside?: boolean;
+    /** 进度条当前状态 */
     status?: 'success' | 'exception' | 'warning';
+    /** 是否为动画进度条 */
     indeterminate?: boolean;
+    /** 控制动画进度条速度 */
     duration?: number;
+    /** 进度条背景色 进度条背景色 （会覆盖 status 状态颜色） */
     color?: string | ((percentage: number) => string) | {
         color: string;
         percentage: number;
     }[];
+    /** 环形进度条画布宽度（只在 type 为 circle 或 dashboard 时可用） */
     width?: number;
+    /** 是否显示进度条文字内容 */
     showText?: boolean;
+    /** circle/dashboard 类型路径两端的形状 */
     strokeLinecap?: 'butt' | 'round' | 'square';
+    /** 指定进度条文字内容 */
     format?: (percentage: number) => string;
 }

package/dist/Radio/typings.d.ts

@@ -7,11 +7,18 @@ export type RadioRef = {
     setChecked: (value: boolean) => void;
 };
 export interface RadioProps<T = ValueType> extends Omit<React.AllHTMLAttributes<HTMLInputElement>, 'size' | 'prefix' | 'type' | 'value' | 'defaultValue' | 'onChange' | 'style' | 'children'>, Omit<FormControlBaseProps<T>, 'onChange'>, BaseProps, NativeProps {
+    /** tooltip 提示*/
     title?: string;
+    /** 是否只读 */
     readOnly?: boolean;
+    /** Render the control as plain text */
     plaintext?: boolean;
+    /** 是否选中 */
     checked?: boolean;
+    /** 默认是否选中 */
     defaultChecked?: boolean;
+    /** 原生 name 属性 */
     name?: string;
+    /** 当绑定值变化时触发的事件 */
     onChange?: (checked: boolean, value: T, event: React.ChangeEvent<HTMLInputElement>) => void;
 }

package/dist/RadioGroup/typings.d.ts

@@ -6,6 +6,7 @@ export interface RadioContextProps {
     value?: ValueType;
     controlled?: boolean;
     disabled?: boolean;
+    /** 尺寸 */
     size?: TypeAttributes.Size;
     readOnly?: boolean;
     plaintext?: boolean;

package/dist/Row/RowContext.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="react" />
 export interface RowContext {
+    /** 栅格间隔 */
     gutter?: number;
 }
 export declare const RowContext: import("react").Context<RowContext>;

package/dist/Row/typings.d.ts

@@ -1,7 +1,11 @@
 import { BaseProps, NativeProps } from '../types/common';
 export interface RowProps extends BaseProps, NativeProps {
+    /** 栅格间隔 */
     gutter?: number;
+    /** 布局下的水平排列方式 */
     justify?: 'start' | 'end' | 'center' | 'space-around' | 'space-between' | 'space-evenly';
+    /** flex 布局下的垂直排列方式 */
     align?: 'top' | 'middle' | 'bottom';
+    /** 自定义元素标签 */
     tag?: string;
 }

package/dist/Scrollbar/typings.d.ts

@@ -2,27 +2,47 @@ import React, { RefObject } from 'react';
 import { BaseProps, NativeProps } from '../types/common';
 export interface ScrollbarRef {
     ref: RefObject<HTMLDivElement>;
+    /** 滚动到一组特定坐标 */
     scrollTo: (options: number, yCoord?: number) => void;
+    /** 设置滚动条到顶部的距离 */
     setScrollTop: (value: number) => void;
+    /** 设置滚动条到左边的距离 */
     setScrollLeft: (value: number) => void;
+    /** 手动更新滚动条状态 */
     update: () => void;
+    /** 滚动条包裹的 ref 对象 */
     wrapRef: RefObject<HTMLDivElement>;
+    /** 视图ref对象 */
     resizeRef: RefObject<any>;
 }
 export interface ScrollbarProps extends BaseProps, NativeProps<'--el-scrollbar-opacity' | '--el-scrollbar-bg-color' | '--el-scrollbar-hover-opacity' | '--el-scrollbar-hover-bg-color' | '--el-scrollbar-width'> {
+    /** 滚动条高度 */
     height?: number | string;
+    /** 滚动条最大高度 */
     maxHeight?: number | string;
+    /** 是否使用原生滚动条样式 */
     native?: boolean;
+    /** 包裹容器的自定义样式 */
     wrapStyle?: React.CSSProperties;
+    /** 包裹容器的自定义类名 */
     wrapClass?: string;
+    /** 视图的自定义样式 */
     viewStyle?: React.CSSProperties;
+    /** 视图的自定义类名 */
     viewClass?: string;
+    /** 不响应容器尺寸变化，如果容器尺寸不会发生变化，最好设置它可以优化性能 */
     noresize?: boolean;
+    /** 视图的元素标签 */
     tag?: string;
+    /** 滚动条总是显示 */
     always?: boolean;
+    /** 滚动条最小尺寸 */
     minSize?: number;
+    /** 是否显示横向滚动条 */
     showHorizontal?: boolean;
+    /** 是否显示纵向滚动条 */
     showVertical?: boolean;
+    /** 滚动时触发的事件 */
     onScroll?: (data: {
         e: React.UIEvent<HTMLDivElement, UIEvent>;
         scrollTop: number;

package/dist/Select/typings.d.ts

@@ -16,43 +16,76 @@ export type SelectRef = {
 };
 type Child = React.ReactElement<SelectOptionGroupProps | SelectOptionProps> | React.ReactElement<SelectOptionGroupProps | SelectOptionProps>[];
 export interface SelectProps<V = ValueType> extends Omit<FormControlBaseProps<V>, 'onChange'>, BaseProps<Child | Child[]>, NativeProps, AnimationEventProps, PopperOptions {
+    /** 是否多选 */
     multiple?: boolean;
+    /** 是否禁用 */
     disabled?: boolean;
+    /** 作为 value 唯一标识的键名，绑定值为对象类型时必填 */
     valueKey?: string;
+    /** 是否可以清空选项 */
     clearable?: boolean;
+    /** 占位符 */
     placeholder?: string;
+    /** 是否可搜索 */
     filterable?: boolean;
+    /** 自定义搜索方法 */
     filterMethod?: (val: ValueType, searchText: string) => boolean;
+    /** 选项为空时显示的文字 */
     noDataText?: React.ReactElement | string;
+    /** 搜索条件无匹配时显示的文字 */
     noMatchText?: React.ReactElement | string;
+    /** 是否正在从远程获取数据 */
     loading?: boolean;
+    /** 远程加载时显示的文字 */
     loadingText?: React.ReactElement | string;
+    /**  */
     max?: boolean;
+    /**  */
     required?: boolean;
+    /** 表单校验错误提示 */
     error?: boolean;
+    /** 表单校验警告提示 */
     warning?: boolean;
+    /** 下拉项最大宽度 */
     maxWidth?: number;
+    /** 多选时是否将选中值按文字的形式展示 */
     collapseTags?: boolean;
+    /** 需要显示的 Tag 的最大数量 只有当 collapseTags 设置为 true 时才会生效。 */
     maxCollapseTags?: number;
+    /** 当鼠标悬停于折叠标签的文本时，是否显示所有选中的标签。 要使用此属性，collapseTags属性必须设定为 true */
     collapseTagsTooltip?: boolean;
+    /** 鼠标悬停于折叠标签的文本格式化函数， 要使用此属性，collapseTags属性必须设定为 true*/
     collapseTips?: (collapseNum: number, total: number) => string;
+    /** 是否允许用户创建新条目 */
     allowCreate?: boolean;
+    /** 是否纯文本模式，即无边框 */
     plain?: boolean;
+    /** 输入框前置内容，只对 type="text" 有效 */
     prepend?: React.ReactElement<any> | string | number;
+    /** 输入框后置内容，只对 type="text" 有效 */
     append?: React.ReactElement | string | number;
+    /** 尺寸 */
     size?: TypeAttributes.Size;
+    /** 是否追加到body下 */
     appendToBody?: boolean;
+    /** 选中值发生变化时触发 */
     onChange?: (value: ValueType, label?: string | (string | number)[]) => void;
+    /** 数据加载成功时调用 */
     onLoadSuccess?: (value: ValueType, label?: (string | number | undefined)[]) => void;
 }
 export interface SelectOptionProps extends BaseProps, NativeProps {
+    /** 选项的值 */
     value: string | number;
+    /** 选项的标签，若不设置则默认与 value 相同 */
     label?: string;
+    /** 是否禁用该选项 */
     disabled?: boolean;
     onClick?: (value: ValueType, label: string, e: Event) => void;
 }
 export interface SelectOptionGroupProps extends BaseProps<React.ReactElement<SelectOptionProps> | React.ReactElement<SelectOptionProps>[]>, NativeProps {
+    /** 分组的组名 */
     label: string;
+    /** 是否将该分组下所有选项置为禁用 */
     disabled?: boolean;
 }
 export interface SelectDropdownProps extends SelectProps {

package/dist/Skeleton/PlaceholderGraph.d.ts

@@ -2,9 +2,13 @@ import React from 'react';
 export interface SkeletonGraphProps {
     height?: number;
     width?: number;
+    /** Placeholder status */
     active?: boolean;
+    /** The prefix of the component CSS class */
     classPrefix?: string;
+    /** Additional classes */
     className?: string;
+    /** Additional style */
     style?: React.CSSProperties;
 }
 declare const SkeletonGraph: React.ForwardRefExoticComponent<SkeletonGraphProps & React.RefAttributes<HTMLDivElement>>;

package/dist/Skeleton/PlaceholderGrid.d.ts

@@ -4,9 +4,13 @@ export interface PlaceholderGridProps {
     rowHeight?: number;
     rowMargin?: number;
     columns?: number;
+    /** Placeholder status */
     active?: boolean;
+    /** The prefix of the component CSS class */
     classPrefix?: string;
+    /** Additional classes */
     className?: string;
+    /** Additional style */
     style?: React.CSSProperties;
 }
 declare const PlaceholderGrid: React.ForwardRefExoticComponent<PlaceholderGridProps & React.RefAttributes<HTMLDivElement>>;

package/dist/Skeleton/PlaceholderParagraph.d.ts

@@ -4,9 +4,13 @@ export interface PlaceholderParagraphProps {
     rowHeight?: number;
     rowMargin?: number;
     graph?: boolean | 'circle' | 'square' | 'image';
+    /** Placeholder status */
     active?: boolean;
+    /** The prefix of the component CSS class */
     classPrefix?: string;
+    /** Additional classes */
     className?: string;
+    /** Additional style */
     style?: React.CSSProperties;
 }
 declare const PlaceholderParagraph: React.ForwardRefExoticComponent<PlaceholderParagraphProps & React.RefAttributes<HTMLDivElement>>;

package/dist/Switch/typings.d.ts

@@ -7,19 +7,34 @@ export type ChangeValue = {
     value: ValueType;
 };
 export interface SwitchProps<V = ValueType> extends Omit<FormControlBaseProps<V>, 'onChange'>, BaseProps, NativeProps<'--el-switch-on-color' | '--el-switch-off-color'>, TooltipBaseProps<HTMLDivElement> {
+    /** switch 的宽度 */
     width?: number;
+    /** switch 打开时的文字描述 */
     activeText?: string;
+    /** switch 的状态为 off 时的文字描述 */
     inactiveText?: string;
+    /** switch 打开时的文字描述 */
     activeIcon?: IconName | React.ReactElement<any>;
+    /** switch 的状态为 off 时的文字描述 */
     inactiveIcon?: IconName | React.ReactElement<any>;
+    /** 当在 on 状态时的背景颜色 */
     activeColor?: string;
+    /** off 状态时的背景颜色 */
     inactiveColor?: string;
+    /** 开关的边框颜色 */
     borderColor?: string;
+    /** switch 状态为 on 时的值 */
     activeValue?: V;
+    /** switch的状态为 off 时的值 */
     inactiveValue?: V;
+    /**  */
     validateEvent?: boolean;
+    /** 是否显示加载中 */
     loading?: boolean;
+    /** 无论图标或文本是否显示在点内，只会呈现文本的第一个字符 */
     inlinePrompt?: boolean;
+    /** switch 状态改变前的钩子， 返回 false 或者返回 Promise 且被 reject 则停止切换 */
     beforeChange?: () => Promise<boolean> | boolean;
+    /** switch 状态发生变化时的回调函数 */
     onChange?: (value?: ValueType, checked?: boolean, e?: React.MouseEvent<HTMLDivElement, MouseEvent>) => void;
 }

package/dist/Table/Colgroup.d.ts

@@ -2,6 +2,7 @@ import { FC } from 'react';
 import { TableColumnCtx } from './typings';
 interface Props<T> {
     columns: TableColumnCtx<T>[];
+    /** 设置表格单元、行和列的布局方式 */
     tableLayout?: 'fixed' | 'auto';
 }
 declare const Colgroup: FC<Props<any>>;

package/dist/Table/TableContext.d.ts

@@ -3,9 +3,13 @@ import { Action, State } from './hooks/useSelection';
 import { TableColumnCtx, TableProps, TableRefs, TreeNode } from './typings';
 export interface TableContextProps<T> {
     tableId: string;
+    /** 多级列 */
     columns: TableColumnCtx<T>[][];
+    /** 最后一级列 */
     flattenColumns: TableColumnCtx<T>[];
+    /** 左固定列 */
     fixedLeftColumns: TableColumnCtx<T>[];
+    /** 右固定列 */
     fixedRightColumns: TableColumnCtx<T>[];
     tableRefs: TableRefs;
     props: Omit<TableProps<T>, 'children'>;
@@ -21,8 +25,11 @@ export interface TableBodyContextProps<T> {
     oldActiveRow: MutableRefObject<T | null | undefined>;
     state: State<T>;
     dispatch: (action: Action) => void;
+    /** 原始表格数据 */
     initialData: MutableRefObject<T[]>;
+    /** 排序后表格数据 */
     sortedData: MutableRefObject<T[]>;
+    /** 禁止选中行 */
     disabledRows: MutableRefObject<T[]>;
     isTreeTable: () => boolean;
     isTreeExpandCell: (id: string) => boolean;
@@ -30,6 +37,7 @@ export interface TableBodyContextProps<T> {
         hasChildren: string;
         children: string;
     };
+    /** 树节点信息 */
     treeNodes: MutableRefObject<TreeNode[]>;
 }
 export declare const TableContext: import("react").Context<TableContextProps<any>>;