@gopowerteam/table-render 0.0.1 → 0.0.3

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

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

package/dist/es/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/es/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/es/interfaces/table-column-options.d.ts

@@ -0,0 +1,40 @@
+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 TableColumnOptions<T> {
+    key: string;
+    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 ExportColumnOptions {
+    header?: string;
+    width?: number;
+    content?: (record: DataRecord) => string | number | undefined;
+}
+export type TableColumnsOptions<T = DataRecord> = TableColumnOptions<T>[];
+export type DataFormatter<T> = (record: T) => string | number | Date | undefined;

package/dist/es/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/es/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/es/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/es/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/es/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/es/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/es/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/es/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/es/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/es/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/es/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/es/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>;

package/dist/es/table-render/table-actions-render.d.ts

@@ -0,0 +1,2 @@
+import type { TableRenderContext, TableRenderOptions, TableRenderProps } from '.';
+export declare function tableActionsRender(props: TableRenderProps, ctx: TableRenderContext, { tableForm, tableEvents, }: TableRenderOptions): () => import("vue/jsx-runtime").JSX.Element;

package/dist/es/table-render/table-column-render.d.ts

@@ -0,0 +1,29 @@
+import { type TableColumnData, type TableData } from '@arco-design/web-vue';
+import type { TableColumnOptions, TableColumnSharedOptions, TableColumnsOptions } from '../interfaces';
+import { RenderColumnType } from '../utils';
+import type { EventEmits } from '../hooks';
+/**
+ * 生成Render模板
+ * @param render
+ * @returns
+ */
+export declare function toRenderColumn<T>(options?: TableColumnOptions<T>, context?: {
+    previewing?: boolean;
+    emits?: EventEmits;
+}): {
+    render: ({ record }: {
+        record: TableData;
+    }) => JSX.Element;
+    [RenderColumnType]: string | undefined;
+    disableColumnMode: boolean | undefined;
+    disableViewMode: boolean | undefined;
+    isRender: boolean;
+    type: string | undefined;
+} | undefined;
+export declare function renderTableColumns(columns: TableColumnsOptions, columnsOptions: TableColumnSharedOptions | undefined, events: EventEmits): TableColumnData[];
+/**
+ * 创建表格列
+ * @param options
+ * @returns
+ */
+export declare function renderTableColumn<T>(options: TableColumnOptions<T>, events: EventEmits): TableColumnData | undefined;

package/dist/es/table-render/table-edit-render.d.ts

@@ -0,0 +1,30 @@
+import { type PropType } from 'vue';
+import { type FormItemsOptions } from '@gopowerteam/form-render';
+declare const _default: import("vue").DefineComponent<{
+    record: {
+        type: ObjectConstructor;
+        required: true;
+    };
+    form: {
+        type: PropType<FormItemsOptions<any>>;
+        required: true;
+    };
+    onSubmit: {
+        type: FunctionConstructor;
+        required: false;
+    };
+}, () => import("vue/jsx-runtime").JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    record: {
+        type: ObjectConstructor;
+        required: true;
+    };
+    form: {
+        type: PropType<FormItemsOptions<any>>;
+        required: true;
+    };
+    onSubmit: {
+        type: FunctionConstructor;
+        required: false;
+    };
+}>>, {}, {}>;
+export default _default;

package/dist/es/table-render/table-form-render.d.ts

@@ -0,0 +1,2 @@
+import type { TableRenderContext, TableRenderOptions, TableRenderProps } from '.';
+export declare function tableFormRender(props: TableRenderProps, ctx: TableRenderContext, { tableForm, tableEvents, formInstance, }: TableRenderOptions): (() => import("vue/jsx-runtime").JSX.Element) | (() => undefined);

package/dist/es/table-render/table-pagination-render.d.ts

@@ -0,0 +1,2 @@
+import type { TableRenderContext, TableRenderOptions, TableRenderProps } from '.';
+export declare function tablePaginationRender(props: TableRenderProps, ctx: TableRenderContext, { pageService, tableEvents, }: TableRenderOptions): (() => import("vue/jsx-runtime").JSX.Element) | (() => undefined);

package/dist/es/table-render/table-selection-render.d.ts

@@ -0,0 +1,9 @@
+import { type Ref } from 'vue';
+import type { TableData, TableRowSelection } from '@arco-design/web-vue';
+import type { TableRenderContext, TableRenderOptions, TableRenderProps } from '.';
+export declare function tableSecletionRender(props: TableRenderProps, ctx: TableRenderContext, { tableSource, }: TableRenderOptions): {
+    selectedRowKeys: Ref<(string | number)[]>;
+    rowSelection?: TableRowSelection;
+    onSelect: (rowKeys: (string | number)[], rowKey: string | number, record: TableData) => void;
+    onSelectAll: (value: boolean) => void;
+};

package/dist/es/table-render/table-view-render.d.ts

@@ -0,0 +1,73 @@
+import { type PropType } from 'vue';
+import type { DataRecord, TableColumnsOptions } from '..';
+import type { RenderSingleButtonColumnOptions } from '../table-columns/button';
+declare const _default: import("vue").DefineComponent<{
+    record: {
+        type: ObjectConstructor;
+        required: true;
+    };
+    columns: {
+        type: PropType<TableColumnsOptions<any>>;
+        required: true;
+    };
+    minWidth: {
+        type: NumberConstructor;
+        required: false;
+        default: number;
+    };
+    border: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    exclude: {
+        type: PropType<string[]>;
+        default: () => never[];
+    };
+    layout: {
+        type: PropType<"horizontal" | "vertical" | "inline-horizontal" | "inline-vertical">;
+        required: false;
+        default: string;
+    };
+    buttons: {
+        type: PropType<RenderSingleButtonColumnOptions<DataRecord>[]>;
+        default: () => never[];
+    };
+}, () => import("vue/jsx-runtime").JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    record: {
+        type: ObjectConstructor;
+        required: true;
+    };
+    columns: {
+        type: PropType<TableColumnsOptions<any>>;
+        required: true;
+    };
+    minWidth: {
+        type: NumberConstructor;
+        required: false;
+        default: number;
+    };
+    border: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    exclude: {
+        type: PropType<string[]>;
+        default: () => never[];
+    };
+    layout: {
+        type: PropType<"horizontal" | "vertical" | "inline-horizontal" | "inline-vertical">;
+        required: false;
+        default: string;
+    };
+    buttons: {
+        type: PropType<RenderSingleButtonColumnOptions<DataRecord>[]>;
+        default: () => never[];
+    };
+}>>, {
+    minWidth: number;
+    buttons: RenderSingleButtonColumnOptions<DataRecord>[];
+    border: boolean;
+    exclude: string[];
+    layout: "horizontal" | "vertical" | "inline-horizontal" | "inline-vertical";
+}, {}>;
+export default _default;

package/dist/es/utils/create-column-render.d.ts

@@ -0,0 +1,7 @@
+import type { TableColumnRenderResult } from '../interfaces';
+export declare const RenderColumnType: unique symbol;
+export declare function createColumnRender<T>(type: string, render: TableColumnRenderResult<T>, options?: {
+    disableColumnMode?: boolean;
+    disableViewMode?: boolean;
+    showOverflow?: boolean;
+}): TableColumnRenderResult<T>;

package/dist/es/utils/create-table-form.d.ts

@@ -0,0 +1,3 @@
+import type { FormItemsOptions } from '@gopowerteam/form-render';
+import type { TableColumnsOptions } from '../interfaces';
+export declare function createTableForm(columns: TableColumnsOptions): FormItemsOptions;

package/dist/es/utils/create-table-source.d.ts

@@ -0,0 +1,3 @@
+import { type Ref } from 'vue';
+import type { DataRecord, TableColumnsOptions } from '../interfaces';
+export declare function createTableSource(columns: TableColumnsOptions): [Ref<DataRecord[]>, (source: DataRecord[]) => void];

package/dist/es/utils/get-column-value.d.ts

@@ -0,0 +1,8 @@
+import type { TableColumnOptions } from '../interfaces';
+/**
+ * 获取当前
+ * @param record
+ * @param column
+ * @returns
+ */
+export declare function getColumnValue<T>(record: T, column: TableColumnOptions<T>): any;

package/dist/es/utils/index.d.ts

@@ -0,0 +1,5 @@
+export * from './create-column-render';
+export * from './create-table-form';
+export * from './create-table-source';
+export * from './get-column-value';
+export * from './set-column-value';

package/dist/es/utils/page.service.d.ts

@@ -0,0 +1,37 @@
+import type { AdapterResponse, RequestPlugin, RequestSendOptions } from '@gopowerteam/request';
+import type { PageableOptions } from '../interfaces/pageable-options';
+export declare class PageService implements RequestPlugin, PageableOptions {
+    data: {
+        index: number;
+        size: number;
+        total: number;
+    };
+    get pageIndex(): number;
+    set pageIndex(value: number);
+    get pageSize(): number;
+    set pageSize(value: number);
+    get total(): number;
+    set total(value: number);
+    pageSizeOpts: number[];
+    pageLayouts: ('PrevJump' | 'PrevPage' | 'JumpNumber' | 'NextPage' | 'NextJump' | 'Sizes' | 'FullJump' | 'Total')[];
+    /**
+     * 构造函数
+     * @param index
+     * @param size
+     */
+    constructor(index?: number, size?: number);
+    /**
+     * 重置操作
+     */
+    reset(): void;
+    /**
+     * 前置操作
+     * @param options
+     */
+    before(options: RequestSendOptions): void;
+    /**
+     * 后置操作
+     * @param response
+     */
+    after(response: AdapterResponse): void;
+}

package/dist/es/utils/set-column-value.d.ts

@@ -0,0 +1,8 @@
+import type { DataRecord, TableColumnOptions } from '../interfaces';
+/**
+ * 获取当前
+ * @param record
+ * @param column
+ * @returns
+ */
+export declare function setColumnValue<T = DataRecord>(record: DataRecord, column: TableColumnOptions<T>, value: any): any;

package/dist/es/utils/sort.service.d.ts

@@ -0,0 +1,26 @@
+import type { RequestPlugin, RequestSendOptions } from '@gopowerteam/request';
+import type { SortableOptions } from '../interfaces';
+export declare class SortService implements RequestPlugin, SortableOptions {
+    private sort;
+    constructor(data?: any);
+    /**
+     * 更新排序
+     * @param key 排序关键字
+     * @param value 排序方式
+     */
+    update(key: string, value: 'desc' | 'asc'): void;
+    /**
+     * 移除排序项
+     * @param key 排序关键字
+     */
+    remove(key: string): void;
+    before: (params: RequestSendOptions) => void;
+    /**
+     * 重置分页数据
+     */
+    reset(): void;
+    /**
+     * 转换排序对象为字符串
+     */
+    private stringify;
+}

package/dist/es/utils/to-px.d.ts

@@ -0,0 +1 @@
+export declare function toPx(value: string | number | undefined): string | undefined;