@yidun/antd-super-table 0.0.6 → 0.0.8

package/dist/{config.d.ts → src/config.d.ts}

@@ -28,10 +28,3 @@ export declare const SceneModalActionTypeEnum: {
 };
 /** 本地缓存需要保存的列配置字段 */
 export declare const cacheColumnKeys: string[];
-/** 场景管理接口地址 */
-export declare const sceneApiUrls: {
-    query: string;
-    create: string;
-    update: string;
-    delete: string;
-};

package/dist/{index.d.ts → src/index.d.ts}

@@ -1,7 +1,11 @@
+import type SuperTableComponent from './SuperTable.vue';
 import SuperTable from './SuperTable.vue';
+import DynamicList from './components/DynamicList.vue';
 export default SuperTable;
+export { DynamicList };
 export { SuperTableColumnTypeEnum, SuperTableFormItemTypeEnum } from './config';
 export * from './typings';
+export type SuperTableInstance = InstanceType<typeof SuperTableComponent>;
 declare module 'vue' {
     interface GlobalComponents {
         SuperTable: typeof SuperTable;

package/dist/src/typings.d.ts

@@ -0,0 +1,358 @@
+import type { SelectProps, TableProps, PaginationProps } from 'ant-design-vue';
+import type { Component, Reactive, Ref } from 'vue';
+/**
+ * 表格列对应的类型枚举
+ * @public
+ */
+export type SuperTableColumnType = 'text' | 'link' | 'button' | 'tag' | 'image' | 'component' | 'sort';
+/**
+ * 查询表单项对应的类型枚举
+ * @public
+ */
+export type SuperTableFormItemType = 'input' | 'inputGroup' | 'inputNumber' | 'inputNumberRange' | 'select' | 'treeSelect' | 'cascader' | 'datePicker' | 'rangePicker' | 'component';
+/**
+ * 表格列吸附方式类型
+ * @public
+ */
+export type SuperTableColumnFixedType = 'left' | 'right' | false;
+/**
+ * 排序方式类型
+ * @public
+ */
+export type SuperTableSortOrders = 'ascend' | 'descend' | null;
+/**
+ * 场景存储类型
+ * @public
+ */
+export type SuperTableSceneStorageType = 'local' | 'api';
+/**
+ * 表格数据项类型
+ * @public
+ */
+export type SuperTableDataItem = Record<string, any>;
+/**
+ * 查询条件配置接口
+ * @public
+ */
+export interface SuperTableFormItem {
+    /** 查询项类型 */
+    type: SuperTableFormItemType;
+    /** 查询项对应的字段名称 */
+    name: string;
+    /** 绑定数据时v-model对应的name，默认为value */
+    modelPropName?: string;
+    /** 查询项标签 */
+    label: string;
+    /** 传递给查询项的props */
+    props?: Record<string, any>;
+    /** 选项值 */
+    value?: any;
+    /** 自定义组件 */
+    component?: Component;
+    /** 查询项宽度系数 */
+    span?: number;
+    /** 是否显示 */
+    visible?: boolean;
+    /** 带select前缀的组合输入框配置 */
+    addonBeforeProps?: SelectProps;
+    /** 改变时保持静默，不要触发搜索 */
+    quiet?: boolean;
+    /** 是否展示label，默认展示 */
+    showLabel?: boolean;
+    /** 固定选项，不允许删除，高级搜索时一定会默认展示 */
+    fixed?: boolean;
+    /**
+     * 默认选中，开启后表现为：
+     * 1. 高级搜索弹窗打开时会默认选中对应的搜索项
+     * 2. 没有配置默认场景时，会根据选中的项目生成一个默认场景
+     */
+    selected?: boolean;
+    /** @internal 以下为内置属性，不允许修改 */
+    /** 默认值 */
+    _defaultValue?: any;
+    /** 排序 */
+    _order?: number;
+    /** 是否选中 */
+    _selected?: boolean;
+    /** 在选中场景中的排序 */
+    _orderInScene?: number;
+    [key: string]: any;
+}
+/**
+ * 表格列配置接口
+ * @public
+ */
+export interface SuperTableColumn {
+    /** 列对应的key */
+    key: string;
+    /** 展示类型：text-文本，button-按钮，link-链接，tag-标签，component-自定义组件 */
+    type?: SuperTableColumnType | ((row: SuperTableDataItem, index: number) => SuperTableColumnType);
+    /** 标题 */
+    title: string;
+    /** 标题对应的提示信息 */
+    titleTooltip?: string | ((row: SuperTableDataItem, index: number) => string);
+    /** 表格内容 */
+    content?: string | ((row: SuperTableDataItem, index: number) => any);
+    /** 表格内容对应的提示信息 */
+    tooltip?: string | boolean | ((row: SuperTableDataItem, index: number) => string);
+    /** 表格内容解析自定义组件 */
+    component?: Component;
+    /** 表格内容解析用到的组件对应的props */
+    props?: Record<string, any> | ((row: SuperTableDataItem, index: number) => Record<string, any>);
+    /** 是否可复制 */
+    copyable?: boolean;
+    /** 是否超出显示省略号 */
+    ellipsis?: boolean;
+    /** 是否可见 */
+    visible?: boolean;
+    /** 宽度 */
+    width?: number;
+    /** 固定列位置 */
+    fixed?: SuperTableColumnFixedType;
+    /** 排序 */
+    sorter?: boolean | ((a: SuperTableDataItem, b: SuperTableDataItem) => number);
+    /** 默认排序 */
+    defaultSortOrder?: SuperTableSortOrders;
+    /** 列索引 */
+    index?: number;
+    [key: string]: any;
+}
+/**
+ * 场景中保存的查询条件配置接口
+ * @public
+ */
+export interface SuperTableQuerySceneItem {
+    /** 字段名称 */
+    name: string;
+    /** 字段类型 */
+    type: SuperTableFormItemType;
+    /** 字段值 */
+    value: any;
+}
+/**
+ * 查询场景接口
+ * @public
+ */
+export interface SuperTableQueryScene {
+    /** 场景唯一标识 */
+    code: string;
+    /** 场景名称 */
+    name: string;
+    /** 配置类型 */
+    type?: string;
+    /** 配置详情 */
+    value?: string;
+    /** 查询项列表 */
+    items: SuperTableQuerySceneItem[];
+    /** 是否是私有配置 */
+    asPrivate?: boolean;
+    /** 是否是自定义场景 */
+    isCustom?: boolean;
+}
+/**
+ * 默认场景配置接口
+ * @public
+ */
+export interface SuperTableDefaultSceneConfig {
+    /** 场景名称 */
+    name?: string;
+    /** 场景唯一标识，多个自定义场景时必填 */
+    code?: string;
+    /** 查询项列表 */
+    items: {
+        /** 字段名称 */
+        name: string;
+        /** 字段值 */
+        value: any;
+    }[];
+}
+/**
+ * 场景状态接口
+ * @public
+ */
+export interface SuperTableSceneState {
+    /** 查询场景列表 */
+    list: SuperTableQueryScene[];
+    /** 是否正在加载场景 */
+    loading: boolean;
+    /** 是否正在保存场景 */
+    submiting: boolean;
+    /** 是否已经加载过场景 */
+    loaded: boolean;
+}
+/**
+ * 提供给弹窗使用的表格全局状态接口
+ * @public
+ */
+export interface SuperTableContext {
+    /** 场景类型 */
+    sceneType: string;
+    /** 场景状态 */
+    sceneState: Reactive<SuperTableSceneState>;
+    /** 查询场景 */
+    queryScene(): void;
+    /** 新增/更新场景 */
+    updateScene(scene: SuperTableQueryScene | SuperTableQueryScene[]): void;
+    /** 删除场景 */
+    deleteScene(sceneCode: string): void;
+    /** 当前生效中的查询参数 */
+    selectedFormItems: SuperTableQuerySceneItem[];
+    /** 禁用添加场景功能 */
+    allowCreateScene: Ref<boolean>;
+}
+/**
+ * 场景请求配置接口
+ * @public
+ */
+export interface SuperTableSceneRequestConfig {
+    /** 查询场景列表 */
+    querySceneList: (params: {
+        type: string;
+    }) => Promise<{
+        code: number;
+        data: SuperTableQueryScene[];
+        msg: string;
+    }>;
+    /** 创建场景 */
+    createScene: (params: {
+        type: string;
+        name: string;
+        value: string;
+        asPrivate?: boolean;
+    }) => Promise<{
+        code: number;
+        data: string;
+        msg: string;
+    }>;
+    /** 更新场景 */
+    updateScene: (params: {
+        code: string;
+        name: string;
+        value: string;
+    }) => Promise<{
+        code: number;
+        msg: string;
+    }>;
+    /** 删除场景 */
+    deleteScene: (params: string[]) => Promise<{
+        code: number;
+        msg: string;
+    }>;
+}
+/**
+ * 数据请求方法类型
+ * @public
+ */
+export type SuperTableRequestFunction = (options: {
+    /** 查询参数 */
+    params: Record<string, any>;
+    /** 分页大小 */
+    pageSize?: number;
+    /** 当前页码 */
+    pageNum?: number;
+    [key: string]: any;
+}) => Promise<{
+    total: number;
+    data: Record<string, any>[];
+}>;
+/**
+ * Antd表格属性扩展接口
+ * @public
+ */
+export interface SuperTableAntdProps extends Omit<TableProps, 'columns' | 'dataSource' | 'pagination'> {
+    pagination: PaginationProps;
+    columns: SuperTableColumn[];
+    dataSource: SuperTableDataItem[];
+}
+/**
+ * 表单操作方法接口
+ * @public
+ */
+export interface SuperTableFormOperations {
+    /**
+     * 获取表单项配置
+     * @param name - 表单项名称
+     * @returns 表单项配置
+     */
+    getFormItem(name: string): SuperTableFormItem | undefined;
+    /**
+     * 设置表单项配置
+     * @param name - 表单项名称
+     * @param keyPath - 配置路径
+     * @param newConfig - 新的配置值
+     */
+    setFormItem(name: string, keyPath: string, newConfig: any): void;
+    /**
+     * 获取表单值
+     * @param name - 表单项名称或名称数组，不传则获取所有值
+     * @returns 表单值对象
+     */
+    getFormValues(name?: string | string[]): Record<string, any>;
+    /**
+     * 设置表单值
+     * @param values - 要设置的表单值对象
+     */
+    setFormValues(values: Record<string, any>): void;
+    /**
+     * 获取单个表单项值
+     * @param name - 表单项名称
+     * @returns 表单项值
+     */
+    getFormValue(name: string): any;
+    /**
+     * 设置单个表单项值
+     * @param name - 表单项名称
+     * @param value - 要设置的值
+     */
+    setFormValue(name: string, value: any): void;
+}
+/**
+ * 表格操作方法接口
+ * @public
+ */
+export interface SuperTableTableOperations {
+    /**
+     * 获取表格数据
+     * @returns 表格数据数组
+     */
+    getTableData(): SuperTableDataItem[];
+    /**
+     * 设置表格数据
+     * @param data - 要设置的表格数据
+     */
+    setTableData(data: SuperTableDataItem[]): void;
+    /**
+     * 设置表格数据项
+     * @param index - 数据项索引
+     * @param data - 要设置的数据项
+     */
+    setTableDataItem(index: number, data: Partial<SuperTableDataItem>): void;
+    /**
+     * 刷新表格数据
+     */
+    onRefresh(): void;
+}
+/**
+ * 组件实例类型
+ * @public
+ */
+export interface SuperTableSlots {
+    /** 场景选择器前面的插槽 */
+    sceneAddonBefore?: () => any;
+    /** 场景选择器后面的插槽 */
+    sceneAddonAfter?: () => any;
+    /** 额外内容插槽 */
+    extra?: () => any;
+    /** 表格头部插槽 */
+    tableHead?: () => any;
+    /** 工具栏额外按钮插槽 */
+    toolBarExtra?: () => any;
+    /** 展开列标题插槽 */
+    expandColumnTitle?: () => any;
+    /** 表格底部插槽 */
+    tableFoot?: () => any;
+    /** 展开行内容插槽 */
+    expandedRowRender?: (props: {
+        record: any;
+    }) => any;
+}

package/dist/{utils → src/utils}/index.d.ts

@@ -46,13 +46,16 @@ export declare const initTableColumns: (columns: SuperTableColumn[]) => {
     }> | undefined;
     index: number;
     key: string;
-    type?: import("..").SuperTableColumnType | ((row: import("..").TableDataItem, index: number) => import("..").SuperTableColumnType);
+    type?: import("..").SuperTableColumnType | ((row: import("..").SuperTableDataItem, index: number) => import("..").SuperTableColumnType);
     title: string;
-    titleTooltip?: string | ((row: import("..").TableDataItem, index: number) => string);
-    content?: string | ((row: import("..").TableDataItem, index: number) => any);
-    tooltip?: string | boolean | ((row: import("..").TableDataItem, index: number) => string);
-    props?: Record<string, any> | ((row: import("..").TableDataItem, index: number) => Record<string, any>);
+    titleTooltip?: string | ((row: import("..").SuperTableDataItem, index: number) => string);
+    content?: string | ((row: import("..").SuperTableDataItem, index: number) => any);
+    tooltip?: string | boolean | ((row: import("..").SuperTableDataItem, index: number) => string);
+    props?: Record<string, any> | ((row: import("..").SuperTableDataItem, index: number) => Record<string, any>);
     copyable?: boolean;
+    fixed?: import("..").SuperTableColumnFixedType;
+    sorter?: boolean | ((a: import("..").SuperTableDataItem, b: import("..").SuperTableDataItem) => number);
+    defaultSortOrder?: import("..").SuperTableSortOrders;
 }[];
 /**
  * 格式化场景配置项数据

package/dist/{utils → src/utils}/service.d.ts

@@ -2,7 +2,7 @@ import type { SuperTableQueryScene } from '../typings';
 /**
  * 接口响应数据结构
  */
-interface IResponse {
+export interface IResponse {
     /** 状态码 */
     code: number;
     /** 响应数据 */
@@ -19,18 +19,6 @@ interface LocalStorageConfig {
     /** 设置场景列表 */
     setScenes: (newScenes: SuperTableQueryScene[]) => void;
 }
-/**
- * API存储策略配置选项
- */
-interface ApiStorageConfig {
-    /** API地址配置 */
-    sceneRequestUrls?: {
-        query: string;
-        create: string;
-        update: string;
-        delete: string;
-    };
-}
 /**
  * 本地存储场景服务
  */
@@ -42,17 +30,6 @@ export declare const localStorageSceneService: (config: LocalStorageConfig) => {
     updateScene: (params: any) => Promise<IResponse>;
     deleteScene: (params: string[]) => Promise<IResponse>;
 };
-/**
- * API存储场景服务
- */
-export declare const apiSceneService: (config?: ApiStorageConfig) => {
-    querySceneList: (params: {
-        type: string;
-    }) => Promise<IResponse>;
-    createScene: (params: any) => Promise<IResponse>;
-    updateScene: (params: any) => Promise<IResponse>;
-    deleteScene: (params: string[]) => Promise<IResponse>;
-};
 /** 不启用场景时，返回的场景服务 */
 export declare const disabledSceneService: () => {
     querySceneList: () => Promise<IResponse>;