@gopowerteam/table-render 0.0.20 → 0.0.21

package/dist/cjs/config/provide.config.d.ts

@@ -0,0 +1,6 @@
+import type { InjectionKey } from 'vue';
+import type { DataRecord } from '../interfaces';
+export declare const provides: {
+    id: InjectionKey<string>;
+    source: InjectionKey<DataRecord[]>;
+};

package/dist/cjs/defines/define-columns.d.ts

@@ -0,0 +1,3 @@
+import type { DataRecord, TableColumnsOptions, TableColumnsStringKeyOptions, TableColumnsTypeKeyOptions } from '../interfaces';
+export declare function defineColumns<T = DataRecord>(columns: TableColumnsTypeKeyOptions<T>): TableColumnsOptions<T>;
+export declare function defineColumns<T = DataRecord>(columns: TableColumnsStringKeyOptions<T>): TableColumnsOptions<T>;

package/dist/cjs/defines/define-table-load.d.ts

@@ -0,0 +1,2 @@
+import type { TableLoadParams } from '../interfaces';
+export declare function defineTableLoad(load: (params: TableLoadParams) => void): (params: TableLoadParams) => void;

package/dist/cjs/defines/index.d.ts

@@ -0,0 +1,2 @@
+export * from './define-columns';
+export * from './define-table-load';

package/dist/cjs/hooks/index.d.ts

@@ -0,0 +1,2 @@
+export * from './use-table';
+export * from './use-events';

package/dist/cjs/hooks/use-events.d.ts

@@ -0,0 +1,38 @@
+import type { FormItemsOptions } from '@gopowerteam/form-render';
+import type { DataRecord, TableColumnsOptions } from '..';
+export type TableEvent = 'export' | 'reload' | 'preview' | 'edit';
+export interface TableReloadEventOptions {
+    reset?: boolean;
+}
+export interface TablePreviewEventOptions {
+    key?: string | number;
+    record?: DataRecord;
+    mode?: 'dialog' | 'drawer';
+    title?: string;
+}
+export interface TableEditEventOptions<T = DataRecord> {
+    key?: string | number;
+    record?: T;
+    mode?: 'dialog' | 'drawer';
+    title?: string;
+    form: FormItemsOptions<T>;
+    onSubmit?: (record: DataRecord) => void;
+}
+export interface TableExportEventOptions {
+    columns?: TableColumnsOptions;
+    source?: DataRecord[];
+    filename?: string;
+}
+export interface EventEmits {
+    (event: 'reload', options?: TableReloadEventOptions): void;
+    (event: 'preview', options?: TablePreviewEventOptions): void;
+    (event: 'export', options?: TableExportEventOptions): void;
+    (event: 'edit', options: TableEditEventOptions): void;
+    (event: TableEvent, options?: TableExportEventOptions | TableReloadEventOptions | TablePreviewEventOptions | TableEditEventOptions): void;
+}
+export declare function useEvents(events: {
+    reload: (options?: TableReloadEventOptions) => void;
+    export: (options?: TableExportEventOptions) => void;
+    preview: (options?: TablePreviewEventOptions) => void;
+    edit: (options: TableEditEventOptions) => void;
+}): EventEmits;

package/dist/cjs/hooks/use-export.d.ts

@@ -0,0 +1,7 @@
+import type { DataRecord, TableColumnsOptions } from '../interfaces';
+export declare function getTableRowValue(columns: TableColumnsOptions<any>, record: DataRecord): Record<string, any>;
+declare function exportExcel(columns: TableColumnsOptions, source: DataRecord[], filename?: string): void;
+export declare function useExport(): {
+    exportExcel: typeof exportExcel;
+};
+export {};

package/dist/cjs/hooks/use-table.d.ts

@@ -0,0 +1,13 @@
+import { type ComponentPublicInstance, type Ref } from 'vue';
+import type { TableRender } from '../table-render';
+type TableRenderInstance = InstanceType<typeof TableRender>;
+type TableRenderExpose = {
+    -readonly [K in keyof Omit<TableRenderInstance, keyof ComponentPublicInstance>]: TableRenderInstance[K];
+};
+/**
+ * 获取TableRender实例
+ * @param key
+ * @returns
+ */
+export declare function useTable(key: string): Readonly<Ref<TableRenderExpose>>;
+export {};

package/dist/cjs/index.d.ts

@@ -0,0 +1,6 @@
+export * from './table-render';
+export * from './interfaces';
+export * from './hooks';
+export * from './defines';
+export * from './resolver';
+export { default } from './install';

package/dist/cjs/install.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from 'vue';
+declare const _default: Plugin;
+export default _default;

package/dist/cjs/interfaces/index.d.ts

@@ -0,0 +1,11 @@
+export * from './table-column-render';
+export * from './table-column-options';
+export * from './table-load-params';
+export * from './sortable-options';
+export * from './pageable-options';
+export interface DataRecord {
+    [key: string]: any;
+}
+export interface DataProp {
+    [key: string]: any;
+}

package/dist/cjs/interfaces/pageable-options.d.ts

@@ -0,0 +1,26 @@
+export interface PageableOptions {
+    /**
+     * 当前页码
+     */
+    pageIndex: number;
+    /**
+     * 分页容量
+     */
+    pageSize: number;
+    /**
+     * 分页容量选项
+     */
+    pageSizeOpts: number[];
+    /**
+     * 分页布局
+     */
+    pageLayouts: Array<'PrevJump' | 'PrevPage' | 'JumpNumber' | 'NextPage' | 'NextJump' | 'Sizes' | 'FullJump' | 'Total'>;
+    /**
+     * 数据总数
+     */
+    total: number;
+    /**
+     * 重置分页数据
+     */
+    reset(): void;
+}

package/dist/cjs/interfaces/sortable-options.d.ts

@@ -0,0 +1,8 @@
+export interface SortableOptions {
+    /**
+     * 重置分页数据
+     */
+    reset(): void;
+    update(key: string, diretion: 'asc' | 'desc'): void;
+    remove(key: string): void;
+}

package/dist/cjs/interfaces/table-column-options.d.ts

@@ -0,0 +1,51 @@
+import type { FormItemOptions } from '@gopowerteam/form-render';
+import type { TableColumnData } from '@arco-design/web-vue';
+import type { TableColumnRender } from './table-column-render';
+import type { DataRecord } from '.';
+export interface TableColumnPreviewOptions {
+    span?: number;
+}
+export interface TableColumnSharedOptions {
+    align?: 'left' | 'right' | 'center';
+    width?: number;
+    ellipsis?: boolean;
+}
+export interface TableFormSharedOptions {
+    minWidth?: number;
+}
+/**
+ * 列配置
+ */
+export interface TableColumnOptions<T> {
+    key: string | keyof T;
+    title: string;
+    index?: string;
+    fixed?: 'left' | 'right';
+    align?: 'left' | 'right' | 'center';
+    width?: number | 'auto';
+    render?: TableColumnRender<T>;
+    form?: boolean | Omit<FormItemOptions, 'key' | 'title'>;
+    formatter?: DataFormatter<T>;
+    ellipsis?: boolean;
+    preview?: TableColumnPreviewOptions;
+    exportable?: ExportColumnOptions | boolean;
+    sortable?: 'asc' | 'desc';
+    treeNode?: boolean;
+    visiable?: boolean | (() => boolean);
+    extraProps?: Partial<Omit<TableColumnData, 'dataIndex' | 'title' | 'fixed' | 'align' | 'width'>>;
+}
+export interface TableColumnTypeKeyOptions<T> extends TableColumnOptions<T> {
+    key: keyof T;
+}
+export interface TableColumnStringKeyOptions<T> extends TableColumnOptions<T> {
+    key: string;
+}
+export interface ExportColumnOptions {
+    header?: string;
+    width?: number;
+    content?: (record: DataRecord) => string | number | undefined;
+}
+export type TableColumnsOptions<T = DataRecord> = TableColumnOptions<T>[];
+export type TableColumnsTypeKeyOptions<T = DataRecord> = TableColumnTypeKeyOptions<T>[];
+export type TableColumnsStringKeyOptions<T = DataRecord> = TableColumnStringKeyOptions<T>[];
+export type DataFormatter<T> = (record: T) => string | number | Date | undefined;

package/dist/cjs/interfaces/table-column-render.d.ts

@@ -0,0 +1,27 @@
+import type { EventEmits } from '../hooks';
+import type { TableColumnRenders } from '../table-columns';
+import type { TableColumnOptions } from './table-column-options';
+interface TableColumnRenderResultType {
+    $type?: string;
+    $disableColumnMode?: boolean;
+    $disableViewMode?: boolean;
+}
+export interface TableColumnRenderResult<T> extends TableColumnRenderResultType {
+    (record: T, columnOptions: TableColumnOptions<T>, ctx?: {
+        previewing?: boolean;
+        emits?: EventEmits;
+    }): JSX.Element;
+}
+/**
+ * Render函数
+ */
+export interface TableColumnRender<T> {
+    (render: TableColumnRenderFun<T>): TableColumnRenderResult<T>;
+}
+/**
+ * Render函数模板
+ */
+type TableColumnRenderFun<T> = ReturnType<typeof TableColumnRenders<T>> & {
+    [key: string]: any;
+};
+export {};

package/dist/cjs/interfaces/table-load-params.d.ts

@@ -0,0 +1,18 @@
+import type { RequestPlugin } from '@gopowerteam/request';
+import type { SortableOptions } from './sortable-options';
+import type { PageableOptions } from './pageable-options';
+export interface DataRecord {
+    [key: string]: any;
+}
+export interface DataProp {
+    [key: string]: any;
+}
+/**
+ * 数据加载参数
+ */
+export interface TableLoadParams {
+    form: DataRecord;
+    page?: (RequestPlugin & PageableOptions);
+    sort?: (RequestPlugin & SortableOptions);
+    update: (data: DataRecord[]) => void;
+}

package/dist/cjs/resolver.d.ts

@@ -0,0 +1,8 @@
+export declare function TableRenderResolver(): {
+    type: "component";
+    resolve: (name: string) => {
+        name: string;
+        from: string;
+        sideEffects: string[];
+    } | undefined;
+};

package/dist/cjs/table-columns/button/index.d.ts

@@ -0,0 +1,26 @@
+export type RenderButtonColumnOptions<T> = RenderSingleButtonColumnOptions<T> | RenderSingleButtonColumnOptions<T>[] | RenderMultipleButtonColumnOptions<T>;
+export interface RenderSingleButtonColumnOptions<T> {
+    content?: string | ((record: T) => string | number | undefined);
+    onClick?: (record: T) => Promise<void> | void;
+    autoReload?: boolean;
+    type?: 'primary' | 'secondary' | 'outline' | 'dashed' | 'text';
+    shape?: 'square' | 'round' | 'circle';
+    visiable?: boolean | ((record: T) => boolean);
+    disabled?: boolean | ((record: T) => boolean);
+    confirm?: boolean;
+    icon?: () => JSX.Element;
+    confirmText?: string;
+    confirmAppend?: string | HTMLElement;
+    confirmOffset?: {
+        left: number;
+        top: number;
+    };
+    confirmPosition?: {
+        left: number;
+        top: number;
+    };
+}
+export interface RenderMultipleButtonColumnOptions<T> {
+    buttons?: RenderSingleButtonColumnOptions<T>[];
+}
+export declare function renderButtonColumn<T>(options: RenderButtonColumnOptions<T>): import("../..").TableColumnRenderResult<T>;

package/dist/cjs/table-columns/currency/index.d.ts

@@ -0,0 +1,9 @@
+import type { DataRecord } from '../../interfaces';
+export interface CurrencyColumnOptions {
+    prefix?: string;
+    suffix?: string;
+    precision?: number;
+    scale?: number;
+    thousands?: boolean;
+}
+export declare function renderCurrencyColumn<T = DataRecord>(options?: CurrencyColumnOptions): import("../../interfaces").TableColumnRenderResult<T>;

package/dist/cjs/table-columns/date/index.d.ts

@@ -0,0 +1,17 @@
+import type { DataRecord } from '../../interfaces';
+export interface DateColumnOptions {
+    format?: keyof typeof dateFormats | (() => string);
+}
+declare const dateFormats: {
+    date: string;
+    datetime: string;
+    time: string;
+    week: string;
+};
+/**
+ * 渲染Date Column
+ * @param options DateColumn列选项
+ * @returns JSX
+ */
+export declare function renderDateColumn<T = DataRecord>(options?: DateColumnOptions): import("../../interfaces").TableColumnRenderResult<T>;
+export {};

package/dist/cjs/table-columns/dict/index.d.ts

@@ -0,0 +1,13 @@
+import type { DataRecord } from '../../interfaces';
+type Dict = Map<string | number | boolean, string | number | boolean>;
+declare const TagType: {
+    success: string;
+    warning: string;
+    error: string;
+};
+export type DictColumnOptions = Dict | {
+    dict: Dict;
+    tag: boolean | keyof typeof TagType;
+};
+export declare function renderDictColumn<T = DataRecord>(options: DictColumnOptions): import("../../interfaces").TableColumnRenderResult<T>;
+export {};

package/dist/cjs/table-columns/image/index.d.ts

@@ -0,0 +1,10 @@
+import type { DataRecord } from '../../interfaces';
+export interface ImageColumnOptions {
+    width?: string;
+    height?: string;
+    radius?: string;
+    preview?: boolean;
+    rotate?: number;
+    parse?: (key: string) => Promise<string>;
+}
+export declare function renderImageColumn<T = DataRecord>(options?: ImageColumnOptions): import("../..").TableColumnRenderResult<T>;

package/dist/cjs/table-columns/index.d.ts

@@ -0,0 +1,11 @@
+export declare function TableColumnRenders<T>(): {
+    text: (options?: import("./text").TextColumnOptions<T> | undefined) => import("..").TableColumnRenderResult<T>;
+    dict: (options: import("./dict").DictColumnOptions) => import("..").TableColumnRenderResult<T>;
+    tag: (options?: import("./tag").TagColumnOptions | undefined) => import("..").TableColumnRenderResult<T>;
+    render: (renderer: import("./render").RenderColumnOptions<T>) => import("..").TableColumnRenderResult<T>;
+    phone: (options?: import("./phone").PhoneColumnOptions | undefined) => import("..").TableColumnRenderResult<T>;
+    image: (options?: import("./image").ImageColumnOptions | undefined) => import("..").TableColumnRenderResult<T>;
+    currency: (options?: import("./currency").CurrencyColumnOptions | undefined) => import("..").TableColumnRenderResult<T>;
+    date: (options?: import("./currency").CurrencyColumnOptions | undefined) => import("..").TableColumnRenderResult<T>;
+    button: (options: import("./button").RenderButtonColumnOptions<T>) => import("..").TableColumnRenderResult<T>;
+};

package/dist/cjs/table-columns/phone/index.d.ts

@@ -0,0 +1,7 @@
+import type { DataRecord } from '../../interfaces';
+export interface PhoneColumnOptions {
+    safe?: boolean;
+    separator?: string;
+    callable?: boolean;
+}
+export declare function renderPhoneColumn<T = DataRecord>(options?: PhoneColumnOptions): import("../../interfaces").TableColumnRenderResult<T>;

package/dist/cjs/table-columns/render/index.d.ts

@@ -0,0 +1,5 @@
+import type { DataRecord } from '../../interfaces';
+export interface RenderColumnOptions<T> {
+    (record: T): JSX.Element;
+}
+export declare function renderRenderColumn<T = DataRecord>(renderer: RenderColumnOptions<T>): import("../../interfaces").TableColumnRenderResult<T>;

package/dist/cjs/table-columns/tag/index.d.ts

@@ -0,0 +1,8 @@
+import type { DataRecord } from '../../interfaces';
+export interface TagColumnOptions {
+    textColors?: string[] | ((tag: any, index: number) => string);
+    backgroundColors?: string[] | ((tag: any, index: number) => string);
+    border?: string;
+    radius?: number;
+}
+export declare function renderTagColumn<T = DataRecord>(options?: TagColumnOptions): import("../../interfaces").TableColumnRenderResult<T>;

package/dist/cjs/table-columns/text/index.d.ts

@@ -0,0 +1,11 @@
+import type { DataRecord } from '../../interfaces';
+export type TextColumnOptions<T> = TextColumnObjectOptions<T> | TextColumnFunctionOptions<T>;
+export interface TextColumnObjectOptions<T> {
+    color?: string | ((record: T) => string);
+    content?: string | ((record: T) => string | number | undefined);
+    size?: string | number | ((record: T) => string | number);
+}
+export interface TextColumnFunctionOptions<T> {
+    (record: T): string | number | undefined;
+}
+export declare function renderTextColumn<T = DataRecord>(options?: TextColumnOptions<T>): import("../../interfaces").TableColumnRenderResult<T>;