wlwy-package 3.2.1 → 3.2.2

package/dist/types/packages/components/list/type.d.ts

@@ -0,0 +1,346 @@
+import type { ButtonProps, FormInstance, FormProps } from 'ant-design-vue';
+import type { Component } from 'vue';
+import type { VxeTableProps, VxeToolbarInstance } from 'vxe-table';
+import type { UseWatchFormType } from '../../hooks';
+import type { InputsType } from './input';
+import type { KeyType } from '../../type';
+import type { ApiResponse } from '../../axios/types';
+import type { WCardProps } from '../antd';
+import type { WColumnProp, WTableInstance } from '../table';
+/**********************WListTable组件********************** */
+export type TableDataType<T = any> = {
+    /**
+     * 加载表格数据loading状态
+     */
+    loading: boolean;
+    /**
+     * 每页显示条数
+     */
+    size: number;
+    /**
+     * 当前页码
+     */
+    current: number;
+    /**
+     * 总条数
+     */
+    total: number;
+    /**
+     * 表格数据
+     */
+    records: T[];
+};
+/**
+ * w-list-table组件参数类型
+ */
+export interface TablePropsType extends VxeTableProps {
+    /**
+     * 隐藏工具栏
+     */
+    hideToolbar?: boolean;
+    /**
+     * 隐藏分页
+     */
+    hidePager?: boolean;
+    /**
+     * 工具栏按钮列表
+     */
+    buttons?: ToolbarButtonType[];
+    /**
+     * 开启表格复选框
+     */
+    checkbox?: boolean;
+    /**
+     * 开启表格序号
+     */
+    sort?: boolean;
+    /**
+     * 已废弃，禁止使用，请用tableColumn 代替
+     * @deprecated
+     */
+    table?: WColumnProp[];
+    /**
+     * 动态渲染列配置
+     */
+    tableColumn?: WColumnProp[];
+    /**
+     * 已废弃，禁止使用
+     * @deprecated
+     */
+    _params?: any;
+}
+/**
+ * w-list-table组件工具栏属性
+ */
+export type ToolbarButtonType = {
+    key?: KeyType;
+    /**
+     * 权限代码
+     */
+    authCode: string;
+    /**
+     * 按钮名称
+     */
+    label: string;
+    /**
+     * 隐藏按钮
+     */
+    hide?: boolean;
+    /**
+     * 按钮类型，同Ant Design Vue框架Button组件的type属性一致
+     */
+    type?: ButtonProps['type'];
+    /**
+     * 按钮事件，同Ant Design Vue框架Button组件的click事件一致
+     */
+    click?: (event: Event) => void;
+};
+/**
+ * w-list-table组件属性
+ */
+export interface WListTableProps extends TablePropsType {
+    /**
+     * 表格数据配置
+     */
+    tableData?: TableDataType;
+}
+/**
+ * w-list-table表格组件实例
+ */
+export interface WListTableInstance<T = any> extends WTableInstance {
+    /**
+     * 获取选中行数据
+     */
+    getCheckboxRecords: () => Array<T>;
+    /**
+     * 获取表格实例
+     */
+    /**
+     * 获取工具栏实例
+     */
+    getToolbarInstance: () => VxeToolbarInstance | undefined;
+}
+/**********************WListHeader组件********************** */
+/**
+ * w-list-header组件参数配置
+ */
+export interface WListHeaderProps extends HeaderPropsType {
+    /**
+     * 最小行数
+     * @default 1
+     */
+    minRows?: number;
+    /**
+     * 列表搜索表头每行几列配置, 默认4列
+     */
+    column?: number;
+    /**
+     * 列间距
+     */
+    gutter?: number;
+    /**
+     * 列表搜索loading状态
+     */
+    loading?: boolean;
+    /**
+     * 列表搜索重置白名单
+     */
+    resetWhitelist?: string[];
+}
+/**
+ * 列表搜索表头参数配置
+ */
+export interface HeaderPropsType<T = any> extends Pick<FormProps, 'rules'> {
+    /**
+     * 搜索条件配置
+     */
+    option?: InputOption[];
+    /**
+     * 是否显示搜索表头
+     */
+    hide?: boolean;
+    /**
+     * 是否显示“展开”|“收起”按钮，默认显示
+     */
+    expand?: boolean;
+    /**
+     * 已废弃，禁止使用，请使用 defaultForm 代替
+     * @deprecated
+     */
+    hForm?: any;
+    /**
+     * 默认form数据
+     */
+    defaultForm?: any;
+    /**
+     * 点击搜索按钮后，接口调用前处理form数据钩子函数
+     */
+    translateForm?: (form: T) => Promise<T>;
+    /**
+     * 页面初始化后是否停止获取列表数据
+     */
+    stopGetList?: boolean;
+}
+/**
+ * 搜索条件配置
+ */
+export type InputOption = {
+    /**
+     * 隐藏条件
+     */
+    hide?: boolean;
+    [key: string]: any;
+} & ({
+    /**
+     * 自定义组件
+     */
+    component: Component;
+} | InputsType);
+/**
+ * w-list-header组件实例
+ */
+export interface WListHeaderInstance extends UseWatchFormType {
+    /**
+     * 获取FormInstance
+     * @returns FormInstance
+     */
+    getFormInstance: () => FormInstance | undefined;
+}
+/**********************WList组件********************** */
+type TabsOptionProps = {
+    /**
+     * key值
+     */
+    key: KeyType;
+    /**
+     * value值，默认为key值
+     */
+    value: KeyType;
+    /**
+     * 显示名
+     */
+    label?: string | Component;
+};
+/**
+ * w-list 组件属性
+ */
+export type WListProps = {
+    /**
+     * 搜索配置
+     */
+    headerProps?: WListHeaderProps;
+    /**
+     * 已废弃，禁止使用，使用headerProps代替
+     * @deprecated
+     */
+    hParams?: any;
+    /**
+     * 表格配置
+     */
+    tableProps?: WListTableProps;
+    /**
+     * 已废弃，禁止使用，使用tableProps代替
+     * @deprecated
+     */
+    sParams?: any;
+    /**
+     * 获取表格数据接口url
+     */
+    url?: string;
+    /**
+     * 获取表格数据自定义请求方法
+     */
+    request?: (data: any) => Promise<ApiResponse<ListResPonseType>>;
+    /**
+     * 获取表格数据请求类型，默认POST
+     */
+    method?: 'POST' | 'GET';
+    /**
+     * 已废弃，禁止使用，使用 formatResult 代替
+     * @deprecated
+     */
+    doBefore?: any;
+    /**
+     * 获取表格数据后处理结果钩子函数
+     */
+    formatResult?: (result: any) => Promise<ListResPonseType> | ListResPonseType;
+    /**
+     * 搜索头和表格之间的Tabs配置，支持Slot
+     */
+    tabs?: {
+        /**
+         * Tabs双向绑定的字段
+         */
+        model?: string;
+        /**
+         * Tabs标签配置
+         */
+        options: TabsOptionProps[];
+        /**
+         * 切换标签是否阻止表格刷新
+         */
+        preventRefresh?: boolean;
+    };
+    /**
+     * 是否有阴影效果
+     * @default true
+     */
+    shadow?: boolean;
+    /**
+     * 表格卡片配置
+     */
+    tableTitle?: WCardProps['title'];
+};
+/**
+ * w-list组件实例
+ */
+export interface WListInstance<T = any> extends UseWatchFormType {
+    /**
+     * 获取表格数据方法
+     * @param params 请求参数
+     */
+    getList: (params?: any) => Promise<ApiResponse<ListResPonseType> | undefined>;
+    /**
+     * 获取表格选中数据方法
+     * @returns 选中数据
+     */
+    getCheckboxRecords: () => Array<T>;
+    /**
+     * 获取WListHeader表格搜索组件实例
+     */
+    getHeaderInstance: () => WListHeaderInstance | undefined;
+    /**
+     * 获取WListTable表格组件实例
+     */
+    getTableInstance: () => WListTableInstance | undefined;
+    /**
+     * 清空表格数据
+     */
+    clearTableData: () => void;
+}
+/**
+ * 通用列表返回结果
+ */
+export type ListResPonseType<T = any> = {
+    /**
+     * 总页数
+     */
+    pages?: number;
+    /**
+     * 数据
+     */
+    records: T[];
+    /**
+     * 当前页
+     */
+    current?: number;
+    /**
+     * 每页条数
+     */
+    size?: number;
+    /**
+     * 总数
+     */
+    total: number;
+};
+export {};

package/dist/types/packages/components/table/constants.d.ts

@@ -0,0 +1,15 @@
+/** toolbar 专属 prop（旧平铺方式已弃用，请改用 toolbar.xxx） */
+export declare const TOOLBAR_ONLY_KEYS: readonly ["toolid", "import", "export", "print", "refresh", "custom", "resizable", "zoom"];
+/** pager 专属 prop（旧平铺方式已弃用，请改用 pager.xxx） */
+export declare const PAGER_ONLY_KEYS: readonly ["currentPage", "pageSize", "pageSizes", "layouts", "total", "pagerCount", "background", "autoHidden", "transfer", "pageSizePlacement", "iconPrevPage", "iconJumpPrev", "iconJumpNext", "iconNextPage", "iconJumpMore", "iconHomePage", "iconEndPage"];
+/** 多子组件共享，平铺在 WTable 顶层 */
+export declare const SHARED_PROP_KEYS: readonly ["loading", "size", "perfect", "border", "align"];
+export declare const TOOLBAR_SHARED_KEYS: readonly ["loading", "size", "perfect"];
+export declare const PAGER_SHARED_KEYS: readonly ["size", "perfect", "border", "align"];
+export declare const TABLE_SHARED_KEYS: readonly ["loading", "border", "align"];
+export declare const WTABLE_OWN_KEYS: readonly ["data", "showPager", "showCheckbox", "showSeq", "showToolbar", "toolbar", "pager"];
+/** vxe-table 企业版参数，开源版传入会触发控制台警告 */
+export declare const VXE_TABLE_PRO_ONLY_KEYS: readonly ["areaConfig", "clipConfig", "fnrConfig"];
+/** 旧 slot 名 → 新 slot 名 */
+export declare const SLOT_ALIASES: readonly [readonly ["buttons", "toolbar-buttons"], readonly ["tools", "toolbar-tools"], readonly ["left", "pager-left"], readonly ["right", "pager-right"]];
+export declare const RESERVED_SLOT_NAMES: Set<string>;

package/dist/types/packages/components/table/index.d.ts

@@ -0,0 +1,7 @@
+export type { WTableInstance, WTableProps, WTableDeprecatedProps, WTableSlots, WToolbarProps, WToolbarOnlyProps, WPagerProps, WPagerOnlyProps, WPagerInstance, ResetPagerParams, PagerState, WColumnProp, WListSearchProps, WListSearchInstance } from './type';
+export { default as WTable } from './src/table.vue';
+export { default as WPager } from './src/pager.vue';
+export { default as WColumn } from './src/column.vue';
+export { default as WListSearch } from './src/search.vue';
+export { WTABLE_VXE_DEFAULT_CONFIG } from './vxeDefaultConfig';
+export type { WTableVxeDefaultConfig } from './vxeDefaultConfig';

package/dist/types/packages/components/table/resolveInjectColumns.d.ts

@@ -0,0 +1,17 @@
+import { type Slot } from 'vue';
+/** 扫描 default 插槽，判断是否存在手写的 seq / checkbox 列 */
+export declare function resolveManualColumnTypes(defaultSlot?: Slot): {
+    seq: boolean;
+    checkbox: boolean;
+};
+export declare function useInjectBuiltinColumns(defaultSlot: Slot | undefined, options: {
+    showSeq: boolean;
+    showCheckbox: boolean;
+}): {
+    manual: {
+        seq: boolean;
+        checkbox: boolean;
+    };
+    shouldInjectSeq: boolean;
+    shouldInjectCheckbox: boolean;
+};

package/dist/types/packages/components/table/src/action-column.vue.d.ts

@@ -0,0 +1,11 @@
+declare const _default: __VLS_WithSlots<import("vue").DefineComponent<{}, {
+    el: import("vue").Ref<HTMLDivElement | undefined, HTMLDivElement | undefined>;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>, {
+    default?: ((props: {}) => any) | undefined;
+}>;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/types/packages/components/table/src/column.vue.d.ts

@@ -0,0 +1,82 @@
+import { VxeColumnPropTypes } from 'vxe-table';
+import type { WColumnProp } from '../type';
+declare var __VLS_7: string, __VLS_8: any, __VLS_15: {
+    $table: import("vxe-table").VxeTableConstructor<any> & import("vxe-table").VxeTablePrivateMethods<any>;
+    $grid: import("vxe-table").VxeGridConstructor<any> | null;
+    seq: string | number;
+    rowid: string;
+    row: any;
+    rowIndex: number;
+    $rowIndex: number;
+    _rowIndex: number;
+    column: import("vxe-table").VxeTableDefines.ColumnInfo<any>;
+    columnIndex: number;
+    $columnIndex: number;
+    _columnIndex: number;
+    fixed: VxeColumnPropTypes.Fixed;
+    type: string;
+    isHidden: boolean;
+    isEdit: boolean;
+    level: number;
+    visibleData: any[];
+    data: any[];
+    items: any[];
+}, __VLS_17: {
+    $table: import("vxe-table").VxeTableConstructor<any> & import("vxe-table").VxeTablePrivateMethods<any>;
+    $grid: import("vxe-table").VxeGridConstructor<any> | null;
+    seq: string | number;
+    rowid: string;
+    row: any;
+    rowIndex: number;
+    $rowIndex: number;
+    _rowIndex: number;
+    column: import("vxe-table").VxeTableDefines.ColumnInfo<any>;
+    columnIndex: number;
+    $columnIndex: number;
+    _columnIndex: number;
+    fixed: VxeColumnPropTypes.Fixed;
+    type: string;
+    isHidden: boolean;
+    isEdit: boolean;
+    level: number;
+    visibleData: any[];
+    data: any[];
+    items: any[];
+}, __VLS_19: {
+    $table: import("vxe-table").VxeTableConstructor<any> & import("vxe-table").VxeTablePrivateMethods<any>;
+    $grid: import("vxe-table").VxeGridConstructor<any> | null;
+    seq: string | number;
+    rowid: string;
+    row: any;
+    rowIndex: number;
+    $rowIndex: number;
+    _rowIndex: number;
+    column: import("vxe-table").VxeTableDefines.ColumnInfo<any>;
+    columnIndex: number;
+    $columnIndex: number;
+    _columnIndex: number;
+    fixed: VxeColumnPropTypes.Fixed;
+    type: string;
+    isHidden: boolean;
+    isEdit: boolean;
+    level: number;
+    visibleData: any[];
+    data: any[];
+    items: any[];
+};
+type __VLS_Slots = {} & {
+    [K in NonNullable<typeof __VLS_7>]?: (props: typeof __VLS_8) => any;
+} & {
+    default?: (props: typeof __VLS_15) => any;
+} & {
+    default?: (props: typeof __VLS_17) => any;
+} & {
+    default?: (props: typeof __VLS_19) => any;
+};
+declare const _default: __VLS_WithSlots<import("vue").DefineComponent<WColumnProp, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<WColumnProp> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>, __VLS_Slots>;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};