vft 0.0.440 → 0.0.442

package/lib/components/table/field.d.ts

@@ -1,8 +1,19 @@
 import type { ColumnItemProps } from './types';
+/** 序号列配置 */
 export declare const SEQ_FIELD: ColumnItemProps;
+/** 复选框列配置 */
 export declare const CHECKED_FIELD: ColumnItemProps;
+/** ID 列配置 */
 export declare const ID_FIELD: ColumnItemProps;
+/** 名称列配置 */
 export declare const NAME_FIELD: ColumnItemProps;
+/**
+ * 日期列配置生成器
+ * @param format - 日期格式，默认为 'YYYY-MM-DD'
+ * @param field - 字段名，默认为 'date'
+ * @param title - 列标题，默认为 '时间'
+ * @returns 日期列配置对象
+ */
 export declare const DATE_FIELD: ({ format, field, title, }?: {
     format?: string | undefined;
     field?: string | undefined;
@@ -15,6 +26,13 @@ export declare const DATE_FIELD: ({ format, field, title, }?: {
         row: any;
     }) => string;
 };
+/**
+ * 日期时间列配置生成器
+ * @param format - 日期时间格式，默认为 'YYYY-MM-DD HH:mm:ss'
+ * @param field - 字段名，默认为 'date'
+ * @param title - 列标题，默认为 '时间'
+ * @returns 日期时间列配置对象
+ */
 export declare const DATE_TIME_FIELD: ({ format, field, title, }?: {
     format?: string | undefined;
     field?: string | undefined;
@@ -27,6 +45,13 @@ export declare const DATE_TIME_FIELD: ({ format, field, title, }?: {
         row: any;
     }) => string;
 };
+/**
+ * 创建时间列配置生成器
+ * @param format - 日期时间格式，默认为 'YYYY-MM-DD HH:mm:ss'
+ * @param field - 字段名，默认为 'createTime'
+ * @param title - 列标题，默认为 '创建时间'
+ * @returns 创建时间列配置对象
+ */
 export declare const CREATE_TIME_FIELD: ({ format, field, title, }?: {
     format?: string | undefined;
     field?: string | undefined;
@@ -39,6 +64,13 @@ export declare const CREATE_TIME_FIELD: ({ format, field, title, }?: {
         row: any;
     }) => string;
 };
+/**
+ * 更新时间列配置生成器
+ * @param format - 日期时间格式，默认为 'YYYY-MM-DD HH:mm:ss'
+ * @param field - 字段名，默认为 'updateTime'
+ * @param title - 列标题，默认为 '更新时间'
+ * @returns 更新时间列配置对象
+ */
 export declare const UPDATE_TIME_FIELD: ({ format, field, title, }?: {
     format?: string | undefined;
     field?: string | undefined;
@@ -51,6 +83,15 @@ export declare const UPDATE_TIME_FIELD: ({ format, field, title, }?: {
         row: any;
     }) => string;
 };
+/**
+ * 状态列配置生成器
+ * @param field - 字段名，默认为 'status'
+ * @param title - 列标题，默认为 '状态'
+ * @param normalText - 正常状态显示文本，默认为 '正常'
+ * @param disabledText - 禁用状态显示文本，默认为 '禁用'
+ * @param strToNumber - 是否将字符串转换为数字进行判断，默认为 true
+ * @returns 状态列配置对象
+ */
 export declare const STATUS_FIELD: ({ field, title, normalText, disabledText, strToNumber, }?: {
     field?: string | undefined;
     title?: string | undefined;
@@ -58,14 +99,33 @@ export declare const STATUS_FIELD: ({ field, title, normalText, disabledText, st
     disabledText?: string | undefined;
     strToNumber?: boolean | undefined;
 }) => ColumnItemProps;
+/** 操作列配置参数接口 */
 interface ActionFieldProps {
+    /** 确认删除提示文本 */
     confirmText?: string;
+    /** 左侧按钮点击回调函数 */
     leftCallback?: (data?: any) => void;
+    /** 右侧按钮点击回调函数，支持异步操作 */
     rightCallback?: ((data?: any) => Promise<any>) | ((data?: any) => void);
+    /** 左侧按钮文本 */
     leftText?: string;
+    /** 右侧按钮文本 */
     rightText?: string;
+    /** 是否显示左侧按钮 */
     showLeft?: boolean;
+    /** 是否显示右侧按钮 */
     showRight?: boolean;
 }
+/**
+ * 操作列配置生成器
+ * @param confirmText - 确认删除提示文本，默认为 '确认删除?'
+ * @param leftCallback - 左侧按钮点击回调
+ * @param rightCallback - 右侧按钮点击回调
+ * @param leftText - 左侧按钮文本，默认为 '编辑'
+ * @param rightText - 右侧按钮文本，默认为 '删除'
+ * @param showLeft - 是否显示左侧按钮，默认为 true
+ * @param showRight - 是否显示右侧按钮，默认为 true
+ * @returns 操作列配置对象
+ */
 export declare const ACTION_FIELD: ({ confirmText, leftCallback, rightCallback, leftText, rightText, showLeft, showRight, }?: ActionFieldProps) => ColumnItemProps;
 export {};