@stonecrop/atable 0.2.64 → 0.2.65

package/dist/atable.d.ts

@@ -1,17 +1,14 @@
-import ACell from '@/components/ACell.vue';
-import AExpansionRow from '@/components/AExpansionRow.vue';
+import ACell from './components/ACell.vue';
+import AExpansionRow from './components/AExpansionRow.vue';
 import { App } from 'vue';
-import ARow from '@/components/ARow.vue';
-import ATable from '@/components/ATable.vue';
-import ATableHeader from '@/components/ATableHeader.vue';
-import ATableModal from '@/components/ATableModal.vue';
-import { CellContext } from '@/types';
-import { createTableStore } from '@/stores/table';
-import { TableColumn } from '@/types';
-import { TableConfig } from '@/types';
-import { TableDisplay } from '@/types';
-import { TableModal } from '@/types';
-import { TableRow } from '@/types';
+import ARow from './components/ARow.vue';
+import ATable from './components/ATable.vue';
+import ATableHeader from './components/ATableHeader.vue';
+import ATableModal from './components/ATableModal.vue';
+import { ComputedRef } from 'vue';
+import { CSSProperties } from 'vue';
+import { Ref } from 'vue';
+import { Store } from 'pinia';
 
 export { ACell }
 
@@ -25,9 +22,351 @@ export { ATableHeader }
 
 export { ATableModal }
 
-export { CellContext }
+/**
+ * Table cell context definition.
+ * @public
+ */
+export declare type CellContext = {
+    row: TableRow;
+    column: TableColumn;
+    table: {
+        [key: string]: any;
+    };
+};
 
-export { createTableStore }
+/**
+ * Table cell context definition.
+ * @public
+ */
+declare type CellContext_2 = {
+    	row: TableRow_2
+    	column: TableColumn_2
+    	table: { [key: string]: any }
+}
+
+/**
+ * Create a table store
+ * @param initData - Initial data for the table store
+ * @returns table store instance
+ * @public
+ */
+export declare const createTableStore: (initData: {
+    columns: TableColumn_2[];
+    rows: TableRow_2[];
+    id?: string;
+    config?: TableConfig_2;
+    table?: {
+        [key: string]: any;
+    };
+    display?: TableDisplay_2[];
+    modal?: TableModal_2;
+}) => Store<`table-${string}`, Pick<{
+columns: Ref<    {
+name: string;
+align?: CanvasTextAlign;
+edit?: boolean;
+label?: string;
+type?: string;
+width?: string;
+pinned?: boolean;
+cellComponent?: string;
+cellComponentProps?: Record<string, any>;
+modalComponent?: string | ((context?: CellContext_2) => string);
+modalComponentExtraProps?: Record<string, any>;
+format?: string | ((value: any, context?: CellContext_2) => string);
+mask?: (value: any) => any;
+}[], TableColumn_2[] | {
+name: string;
+align?: CanvasTextAlign;
+edit?: boolean;
+label?: string;
+type?: string;
+width?: string;
+pinned?: boolean;
+cellComponent?: string;
+cellComponentProps?: Record<string, any>;
+modalComponent?: string | ((context?: CellContext_2) => string);
+modalComponentExtraProps?: Record<string, any>;
+format?: string | ((value: any, context?: CellContext_2) => string);
+mask?: (value: any) => any;
+}[]>;
+rows: Ref<    {
+[x: string]: any;
+indent?: number;
+parent?: number;
+}[], TableRow_2[] | {
+[x: string]: any;
+indent?: number;
+parent?: number;
+}[]>;
+config: Ref<    {
+view?: "uncounted" | "list" | "list-expansion" | "tree";
+fullWidth?: boolean;
+}, TableConfig_2 | {
+view?: "uncounted" | "list" | "list-expansion" | "tree";
+fullWidth?: boolean;
+}>;
+table: Ref<    {}, {}>;
+display: Ref<    {
+childrenOpen?: boolean;
+expanded?: boolean;
+indent?: number;
+isParent?: boolean;
+isRoot?: boolean;
+open?: boolean;
+parent?: number;
+rowModified?: boolean;
+}[], TableDisplay_2[] | {
+childrenOpen?: boolean;
+expanded?: boolean;
+indent?: number;
+isParent?: boolean;
+isRoot?: boolean;
+open?: boolean;
+parent?: number;
+rowModified?: boolean;
+}[]>;
+modal: Ref<    {
+colIndex?: number;
+event?: string;
+left?: number;
+parent?: HTMLElement;
+rowIndex?: number;
+top?: number;
+visible?: boolean;
+width?: string;
+component?: string;
+componentProps?: Record<string, any>;
+}, TableModal_2 | {
+colIndex?: number;
+event?: string;
+left?: number;
+parent?: HTMLElement;
+rowIndex?: number;
+top?: number;
+visible?: boolean;
+width?: string;
+component?: string;
+componentProps?: Record<string, any>;
+}>;
+hasPinnedColumns: ComputedRef<boolean>;
+numberedRowWidth: ComputedRef<string>;
+zeroColumn: ComputedRef<boolean>;
+closeModal: (event: MouseEvent) => void;
+getCellData: <T = any>(colIndex: number, rowIndex: number) => T;
+getCellDisplayValue: (colIndex: number, rowIndex: number) => any;
+getFormattedValue: (colIndex: number, rowIndex: number, value: any) => any;
+getHeaderCellStyle: (column: TableColumn_2) => CSSProperties;
+getIndent: (colIndex: number, indentLevel?: number) => string;
+getRowExpandSymbol: (rowIndex: number) => "" | "-" | "+";
+isRowVisible: (rowIndex: number) => boolean;
+setCellData: (colIndex: number, rowIndex: number, value: any) => void;
+toggleRowExpand: (rowIndex: number) => void;
+}, "columns" | "rows" | "config" | "table" | "display" | "modal">, Pick<{
+columns: Ref<    {
+name: string;
+align?: CanvasTextAlign;
+edit?: boolean;
+label?: string;
+type?: string;
+width?: string;
+pinned?: boolean;
+cellComponent?: string;
+cellComponentProps?: Record<string, any>;
+modalComponent?: string | ((context?: CellContext_2) => string);
+modalComponentExtraProps?: Record<string, any>;
+format?: string | ((value: any, context?: CellContext_2) => string);
+mask?: (value: any) => any;
+}[], TableColumn_2[] | {
+name: string;
+align?: CanvasTextAlign;
+edit?: boolean;
+label?: string;
+type?: string;
+width?: string;
+pinned?: boolean;
+cellComponent?: string;
+cellComponentProps?: Record<string, any>;
+modalComponent?: string | ((context?: CellContext_2) => string);
+modalComponentExtraProps?: Record<string, any>;
+format?: string | ((value: any, context?: CellContext_2) => string);
+mask?: (value: any) => any;
+}[]>;
+rows: Ref<    {
+[x: string]: any;
+indent?: number;
+parent?: number;
+}[], TableRow_2[] | {
+[x: string]: any;
+indent?: number;
+parent?: number;
+}[]>;
+config: Ref<    {
+view?: "uncounted" | "list" | "list-expansion" | "tree";
+fullWidth?: boolean;
+}, TableConfig_2 | {
+view?: "uncounted" | "list" | "list-expansion" | "tree";
+fullWidth?: boolean;
+}>;
+table: Ref<    {}, {}>;
+display: Ref<    {
+childrenOpen?: boolean;
+expanded?: boolean;
+indent?: number;
+isParent?: boolean;
+isRoot?: boolean;
+open?: boolean;
+parent?: number;
+rowModified?: boolean;
+}[], TableDisplay_2[] | {
+childrenOpen?: boolean;
+expanded?: boolean;
+indent?: number;
+isParent?: boolean;
+isRoot?: boolean;
+open?: boolean;
+parent?: number;
+rowModified?: boolean;
+}[]>;
+modal: Ref<    {
+colIndex?: number;
+event?: string;
+left?: number;
+parent?: HTMLElement;
+rowIndex?: number;
+top?: number;
+visible?: boolean;
+width?: string;
+component?: string;
+componentProps?: Record<string, any>;
+}, TableModal_2 | {
+colIndex?: number;
+event?: string;
+left?: number;
+parent?: HTMLElement;
+rowIndex?: number;
+top?: number;
+visible?: boolean;
+width?: string;
+component?: string;
+componentProps?: Record<string, any>;
+}>;
+hasPinnedColumns: ComputedRef<boolean>;
+numberedRowWidth: ComputedRef<string>;
+zeroColumn: ComputedRef<boolean>;
+closeModal: (event: MouseEvent) => void;
+getCellData: <T = any>(colIndex: number, rowIndex: number) => T;
+getCellDisplayValue: (colIndex: number, rowIndex: number) => any;
+getFormattedValue: (colIndex: number, rowIndex: number, value: any) => any;
+getHeaderCellStyle: (column: TableColumn_2) => CSSProperties;
+getIndent: (colIndex: number, indentLevel?: number) => string;
+getRowExpandSymbol: (rowIndex: number) => "" | "-" | "+";
+isRowVisible: (rowIndex: number) => boolean;
+setCellData: (colIndex: number, rowIndex: number, value: any) => void;
+toggleRowExpand: (rowIndex: number) => void;
+}, "hasPinnedColumns" | "numberedRowWidth" | "zeroColumn">, Pick<{
+columns: Ref<    {
+name: string;
+align?: CanvasTextAlign;
+edit?: boolean;
+label?: string;
+type?: string;
+width?: string;
+pinned?: boolean;
+cellComponent?: string;
+cellComponentProps?: Record<string, any>;
+modalComponent?: string | ((context?: CellContext_2) => string);
+modalComponentExtraProps?: Record<string, any>;
+format?: string | ((value: any, context?: CellContext_2) => string);
+mask?: (value: any) => any;
+}[], TableColumn_2[] | {
+name: string;
+align?: CanvasTextAlign;
+edit?: boolean;
+label?: string;
+type?: string;
+width?: string;
+pinned?: boolean;
+cellComponent?: string;
+cellComponentProps?: Record<string, any>;
+modalComponent?: string | ((context?: CellContext_2) => string);
+modalComponentExtraProps?: Record<string, any>;
+format?: string | ((value: any, context?: CellContext_2) => string);
+mask?: (value: any) => any;
+}[]>;
+rows: Ref<    {
+[x: string]: any;
+indent?: number;
+parent?: number;
+}[], TableRow_2[] | {
+[x: string]: any;
+indent?: number;
+parent?: number;
+}[]>;
+config: Ref<    {
+view?: "uncounted" | "list" | "list-expansion" | "tree";
+fullWidth?: boolean;
+}, TableConfig_2 | {
+view?: "uncounted" | "list" | "list-expansion" | "tree";
+fullWidth?: boolean;
+}>;
+table: Ref<    {}, {}>;
+display: Ref<    {
+childrenOpen?: boolean;
+expanded?: boolean;
+indent?: number;
+isParent?: boolean;
+isRoot?: boolean;
+open?: boolean;
+parent?: number;
+rowModified?: boolean;
+}[], TableDisplay_2[] | {
+childrenOpen?: boolean;
+expanded?: boolean;
+indent?: number;
+isParent?: boolean;
+isRoot?: boolean;
+open?: boolean;
+parent?: number;
+rowModified?: boolean;
+}[]>;
+modal: Ref<    {
+colIndex?: number;
+event?: string;
+left?: number;
+parent?: HTMLElement;
+rowIndex?: number;
+top?: number;
+visible?: boolean;
+width?: string;
+component?: string;
+componentProps?: Record<string, any>;
+}, TableModal_2 | {
+colIndex?: number;
+event?: string;
+left?: number;
+parent?: HTMLElement;
+rowIndex?: number;
+top?: number;
+visible?: boolean;
+width?: string;
+component?: string;
+componentProps?: Record<string, any>;
+}>;
+hasPinnedColumns: ComputedRef<boolean>;
+numberedRowWidth: ComputedRef<string>;
+zeroColumn: ComputedRef<boolean>;
+closeModal: (event: MouseEvent) => void;
+getCellData: <T = any>(colIndex: number, rowIndex: number) => T;
+getCellDisplayValue: (colIndex: number, rowIndex: number) => any;
+getFormattedValue: (colIndex: number, rowIndex: number, value: any) => any;
+getHeaderCellStyle: (column: TableColumn_2) => CSSProperties;
+getIndent: (colIndex: number, indentLevel?: number) => string;
+getRowExpandSymbol: (rowIndex: number) => "" | "-" | "+";
+isRowVisible: (rowIndex: number) => boolean;
+setCellData: (colIndex: number, rowIndex: number, value: any) => void;
+toggleRowExpand: (rowIndex: number) => void;
+}, "closeModal" | "getCellData" | "getCellDisplayValue" | "getFormattedValue" | "getHeaderCellStyle" | "getIndent" | "getRowExpandSymbol" | "isRowVisible" | "setCellData" | "toggleRowExpand">>;
 
 /**
  * Install all ATable components
@@ -36,14 +375,164 @@ export { createTableStore }
  */
 export declare function install(app: App): void;
 
-export { TableColumn }
+/**
+ * Table column definition.
+ * @public
+ */
+export declare type TableColumn = {
+    name: string;
+    align?: CanvasTextAlign;
+    edit?: boolean;
+    label?: string;
+    type?: string;
+    width?: string;
+    pinned?: boolean;
+    cellComponent?: string;
+    cellComponentProps?: Record<string, any>;
+    modalComponent?: string | ((context?: CellContext) => string);
+    modalComponentExtraProps?: Record<string, any>;
+    format?: string | ((value: any, context?: CellContext) => string);
+    mask?: (value: any) => any;
+};
 
-export { TableConfig }
+/**
+ * Table column definition.
+ * @public
+ */
+declare type TableColumn_2 = {
+    	name: string
+
+    	align?: CanvasTextAlign
+    	edit?: boolean
+    	label?: string
+    	type?: string
+    	width?: string
+    	pinned?: boolean
+
+    	cellComponent?: string
+    	cellComponentProps?: Record<string, any>
+    	modalComponent?: string | ((context?: CellContext_2) => string)
+    	modalComponentExtraProps?: Record<string, any>
+
+    	format?: string | ((value: any, context?: CellContext_2) => string)
+    	mask?: (value: any) => any
+}
 
-export { TableDisplay }
+/**
+ * Table configuration definition.
+ * @public
+ */
+export declare type TableConfig = {
+    /**
+     * The type of view to display the table in. Possible values:
+     * - `uncounted` - row numbers are not displayed in the table
+     * - `list` - row numbers are displayed in the table
+     * - `list-expansion` - carets are displayed in the number column that expand/collapse the row inline
+     * - `tree` - carets are displayed in the number column that expand/collapse grouped rows
+     */
+    view?: 'uncounted' | 'list' | 'list-expansion' | 'tree';
+    fullWidth?: boolean;
+};
 
-export { TableModal }
+/**
+ * Table configuration definition.
+ * @public
+ */
+declare type TableConfig_2 = {
+    	/**
+     	 * The type of view to display the table in. Possible values:
+     	 * - `uncounted` - row numbers are not displayed in the table
+     	 * - `list` - row numbers are displayed in the table
+     	 * - `list-expansion` - carets are displayed in the number column that expand/collapse the row inline
+     	 * - `tree` - carets are displayed in the number column that expand/collapse grouped rows
+     	 */
+    	view?: 'uncounted' | 'list' | 'list-expansion' | 'tree'
+    	fullWidth?: boolean
+}
 
-export { TableRow }
+/**
+ * Table display definition.
+ * @public
+ */
+export declare type TableDisplay = {
+    childrenOpen?: boolean;
+    expanded?: boolean;
+    indent?: number;
+    isParent?: boolean;
+    isRoot?: boolean;
+    open?: boolean;
+    parent?: number;
+    rowModified?: boolean;
+};
+
+/**
+ * Table display definition.
+ * @public
+ */
+declare type TableDisplay_2 = {
+    	childrenOpen?: boolean
+    	expanded?: boolean
+    	indent?: number
+    	isParent?: boolean
+    	isRoot?: boolean
+    	open?: boolean
+    	parent?: number
+    	rowModified?: boolean
+}
+
+/**
+ * Table modal definition.
+ * @public
+ */
+export declare type TableModal = {
+    colIndex?: number;
+    event?: string;
+    left?: number;
+    parent?: HTMLElement;
+    rowIndex?: number;
+    top?: number;
+    visible?: boolean;
+    width?: string;
+    component?: string;
+    componentProps?: Record<string, any>;
+};
+
+/**
+ * Table modal definition.
+ * @public
+ */
+declare type TableModal_2 = {
+    	colIndex?: number
+    	event?: string
+    	left?: number
+    	parent?: HTMLElement
+    	rowIndex?: number
+    	top?: number
+    	visible?: boolean
+    	width?: string
+
+    	component?: string
+    	componentProps?: Record<string, any>
+}
+
+/**
+ * Table row definition.
+ * @public
+ */
+export declare type TableRow = {
+    [key: string]: any;
+    indent?: number;
+    parent?: number;
+};
+
+/**
+ * Table row definition.
+ * @public
+ */
+declare type TableRow_2 = {
+    	[key: string]: any
+    	indent?: number
+    	parent?: number
+}
 
 export { }