@affino/datagrid-vue-app 0.1.21 → 0.1.23

package/dist/internal.js

@@ -1,7 +1,7 @@
 import { d as t, r } from "./chunks/dataGridOverlayThemeVars-vzY74EIz.js";
 import { buildDataGridChromePaneModel as o, buildDataGridChromeRenderModel as d } from "@affino/datagrid-chrome";
-import { D as l, a as n, r as G, u as D, b as S, c as u } from "./chunks/useDataGridAppRowModel-g0AWogvz.js";
-import { _ as b, a as T, c as p, b as m, d as c, p as x, u as R, e as f, f as C, g as M, h as v, i as h, j as w, k as y, l as F, m as P, n as A, o as O } from "./chunks/DataGridGanttStageEntry-Def2lt1S.js";
+import { D as l, a as n, r as G, u as D, b as S, c as u } from "./chunks/useDataGridAppRowModel-qRa5om5I.js";
+import { _ as b, a as T, c as p, b as m, d as c, p as x, u as R, e as f, f as C, g as M, h as v, i as h, j as w, k as y, l as F, m as P, n as A, o as O } from "./chunks/DataGridGanttStageEntry-C888labI.js";
 import { _ as E } from "./chunks/DataGridAdvancedFilterPopover.vue_vue_type_script_setup_true_lang-DhdOikY0.js";
 import { _ as K } from "./chunks/DataGridFindReplacePopover.vue_vue_type_script_setup_true_lang-DfHFHhUf.js";
 import { buildDataGridTimelineRenderModels as j, normalizeDataGridGanttOptions as k, resolveDataGridTimelineRange as z } from "@affino/datagrid-gantt";

package/dist/overlays/DataGridColumnMenu.vue.d.ts

@@ -1,4 +1,4 @@
-import type { DataGridColumnMenuActionOptions, DataGridColumnMenuDisabledReasons, DataGridColumnMenuItemKey, DataGridColumnMenuItemLabels } from "./dataGridColumnMenu";
+import type { DataGridColumnMenuActionOptions, DataGridColumnMenuCustomItem, DataGridColumnMenuDisabledReasons, DataGridColumnMenuItemKey, DataGridColumnMenuItemLabels, DataGridColumnMenuTriggerMode } from "./dataGridColumnMenu";
 type DataGridColumnPin = "left" | "right" | "none";
 type __VLS_Props = {
     rows: readonly Record<string, unknown>[];
@@ -7,6 +7,8 @@ type __VLS_Props = {
     disabledReasons: DataGridColumnMenuDisabledReasons;
     labels: DataGridColumnMenuItemLabels;
     actionOptions: DataGridColumnMenuActionOptions;
+    customItems: readonly DataGridColumnMenuCustomItem[];
+    triggerMode: DataGridColumnMenuTriggerMode;
     columnKey: string;
     columnLabel: string;
     columnDataType?: string;
@@ -28,9 +30,14 @@ declare function toggleMenuFromElement(element: HTMLElement | null): void;
 declare var __VLS_15: {
     open: boolean;
     toggleMenuFromElement: typeof toggleMenuFromElement;
+}, __VLS_17: {
+    open: boolean;
+    toggleMenuFromElement: typeof toggleMenuFromElement;
 };
 type __VLS_Slots = {} & {
     default?: (props: typeof __VLS_15) => any;
+} & {
+    default?: (props: typeof __VLS_17) => any;
 };
 declare const __VLS_base: import("vue").DefineComponent<__VLS_TypePropsToOption<__VLS_Props>, unknown, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     sort: (direction: "asc" | "desc" | null) => void;

package/dist/overlays/dataGridColumnMenu.d.ts

@@ -1,5 +1,8 @@
 export declare const DATAGRID_COLUMN_MENU_ITEM_KEYS: readonly ["sort", "group", "pin", "filter"];
 export type DataGridColumnMenuItemKey = (typeof DATAGRID_COLUMN_MENU_ITEM_KEYS)[number];
+export declare const DATAGRID_COLUMN_MENU_TRIGGER_MODES: readonly ["button", "contextmenu", "button+contextmenu"];
+export type DataGridColumnMenuTriggerMode = (typeof DATAGRID_COLUMN_MENU_TRIGGER_MODES)[number];
+export type DataGridColumnMenuCustomItemPlacement = "start" | "end" | `before:${DataGridColumnMenuItemKey}` | `after:${DataGridColumnMenuItemKey}`;
 export type DataGridColumnMenuItemLabels = Readonly<Partial<Record<DataGridColumnMenuItemKey, string>>>;
 export type DataGridColumnMenuDisabledReasons = Readonly<Partial<Record<DataGridColumnMenuItemKey, string>>>;
 export declare const DATAGRID_COLUMN_MENU_ACTION_KEYS: readonly ["sortAsc", "sortDesc", "clearSort", "toggleGroup", "pinMenu", "pinLeft", "pinRight", "unpin", "clearFilter", "addCurrentSelectionToFilter", "selectAllValues", "clearAllValues", "applyFilter", "cancelFilter"];
@@ -11,6 +14,20 @@ export interface DataGridColumnMenuActionOption {
     label?: string;
 }
 export type DataGridColumnMenuActionOptions = Readonly<Partial<Record<DataGridColumnMenuActionKey, DataGridColumnMenuActionOption>>>;
+export interface DataGridColumnMenuCustomItemContext {
+    columnKey: string;
+    columnLabel: string;
+    closeMenu: () => void;
+}
+export interface DataGridColumnMenuCustomItem {
+    key: string;
+    label: string;
+    placement?: DataGridColumnMenuCustomItemPlacement;
+    hidden?: boolean;
+    disabled?: boolean;
+    disabledReason?: string;
+    onSelect?: (context: DataGridColumnMenuCustomItemContext) => void | Promise<void>;
+}
 export interface DataGridColumnMenuColumnOptions {
     items?: readonly DataGridColumnMenuItemKey[];
     hide?: readonly DataGridColumnMenuItemKey[];
@@ -18,25 +35,30 @@ export interface DataGridColumnMenuColumnOptions {
     disabledReasons?: DataGridColumnMenuDisabledReasons;
     labels?: DataGridColumnMenuItemLabels;
     actions?: DataGridColumnMenuActionOptions;
+    customItems?: readonly DataGridColumnMenuCustomItem[];
 }
 export interface DataGridColumnMenuOptions {
     enabled: boolean;
+    trigger: DataGridColumnMenuTriggerMode;
     maxFilterValues: number;
     items: readonly DataGridColumnMenuItemKey[];
     disabled: readonly DataGridColumnMenuItemKey[];
     disabledReasons: DataGridColumnMenuDisabledReasons;
     labels: DataGridColumnMenuItemLabels;
     actions: DataGridColumnMenuActionOptions;
+    customItems: readonly DataGridColumnMenuCustomItem[];
     columns: Readonly<Record<string, DataGridColumnMenuColumnOptions>>;
 }
 export type DataGridColumnMenuProp = boolean | {
     enabled?: boolean;
+    trigger?: DataGridColumnMenuTriggerMode;
     maxFilterValues?: number;
     items?: readonly DataGridColumnMenuItemKey[];
     disabled?: readonly DataGridColumnMenuItemKey[];
     disabledReasons?: DataGridColumnMenuDisabledReasons;
     labels?: DataGridColumnMenuItemLabels;
     actions?: DataGridColumnMenuActionOptions;
+    customItems?: readonly DataGridColumnMenuCustomItem[];
     columns?: Readonly<Record<string, DataGridColumnMenuColumnOptions>>;
 } | null;
 export declare function resolveDataGridColumnMenu(input: DataGridColumnMenuProp | undefined): DataGridColumnMenuOptions;
@@ -45,3 +67,4 @@ export declare function resolveDataGridColumnMenuDisabledItems(options: DataGrid
 export declare function resolveDataGridColumnMenuLabels(options: DataGridColumnMenuOptions, columnKey: string): DataGridColumnMenuItemLabels;
 export declare function resolveDataGridColumnMenuDisabledReasons(options: DataGridColumnMenuOptions, columnKey: string): DataGridColumnMenuDisabledReasons;
 export declare function resolveDataGridColumnMenuActionOptions(options: DataGridColumnMenuOptions, columnKey: string): DataGridColumnMenuActionOptions;
+export declare function resolveDataGridColumnMenuCustomItems(options: DataGridColumnMenuOptions, columnKey: string): readonly DataGridColumnMenuCustomItem[];

package/dist/stage/dataGridTableStage.types.d.ts

@@ -2,7 +2,7 @@ import type { ComponentPublicInstance, CSSProperties, Ref } from "vue";
 import type { DataGridColumnPin, DataGridColumnSnapshot, DataGridOverlayRange, DataGridRowNode } from "@affino/datagrid-vue";
 import type { DataGridFillBehavior } from "@affino/datagrid-vue/advanced";
 import type { DataGridLayoutMode } from "../config/dataGridLayout";
-import type { DataGridColumnMenuActionOptions, DataGridColumnMenuDisabledReasons, DataGridColumnMenuItemKey, DataGridColumnMenuItemLabels } from "../overlays/dataGridColumnMenu";
+import type { DataGridColumnMenuActionOptions, DataGridColumnMenuCustomItem, DataGridColumnMenuDisabledReasons, DataGridColumnMenuItemKey, DataGridColumnMenuItemLabels, DataGridColumnMenuTriggerMode } from "../overlays/dataGridColumnMenu";
 export type DataGridTableMode = "base" | "tree" | "pivot" | "worker";
 export type DataGridPendingEdge = "top" | "right" | "bottom" | "left";
 export type DataGridTableRow<TRow extends Record<string, unknown>> = DataGridRowNode<TRow>;
@@ -43,6 +43,7 @@ export interface DataGridTableStageColumnsSection {
     sortIndicator: (columnKey: string) => string;
     setColumnFilterText: (columnKey: string, value: string) => void;
     columnMenuEnabled?: boolean;
+    columnMenuTrigger?: DataGridColumnMenuTriggerMode;
     columnMenuValueFilterEnabled?: boolean;
     columnMenuValueFilterRowLimit?: number;
     columnMenuMaxFilterValues?: number;
@@ -51,6 +52,7 @@ export interface DataGridTableStageColumnsSection {
     resolveColumnMenuDisabledReasons?: (columnKey: string) => DataGridColumnMenuDisabledReasons;
     resolveColumnMenuLabels?: (columnKey: string) => DataGridColumnMenuItemLabels;
     resolveColumnMenuActionOptions?: (columnKey: string) => DataGridColumnMenuActionOptions;
+    resolveColumnMenuCustomItems?: (columnKey: string) => readonly DataGridColumnMenuCustomItem[];
     isColumnFilterActive?: (columnKey: string) => boolean;
     isColumnGrouped?: (columnKey: string) => boolean;
     resolveColumnGroupOrder?: (columnKey: string) => number | null;
@@ -116,7 +118,7 @@ export interface DataGridTableStageEditingSection<TRow extends Record<string, un
     updateEditingCellValue: (value: string) => void;
     handleEditorKeydown: (event: KeyboardEvent) => void;
     handleEditorBlur: () => void;
-    commitInlineEdit: (target?: "stay" | "next" | "previous") => void;
+    commitInlineEdit: (target?: "stay" | "next" | "previous" | "none") => void;
     cancelInlineEdit: () => void;
 }
 export interface DataGridTableStageCellsSection<TRow extends Record<string, unknown>> {

package/dist/stage/useDataGridTableStageHistory.d.ts

@@ -1,4 +1,5 @@
 import type { DataGridCopyRange } from "@affino/datagrid-vue/advanced";
+import type { DataGridHistoryController } from "../dataGridHistory";
 export interface DataGridTableStageHistoryAdapter {
     captureSnapshot: () => unknown;
     captureSnapshotForRowIds?: (rowIds: readonly (string | number)[]) => unknown;
@@ -15,9 +16,11 @@ export interface UseDataGridTableStageHistoryOptions<TRow extends Record<string,
     runtime: Pick<import("@affino/datagrid-vue").UseDataGridRuntimeResult<TRow>, "api" | "getBodyRowAtIndex" | "resolveBodyRowIndexById">;
     cloneRowData: (row: TRow) => TRow;
     syncViewport: () => void;
+    enabled?: boolean;
+    maxHistoryDepth?: number;
     history?: DataGridTableStageHistoryAdapter;
 }
-export interface UseDataGridTableStageHistoryResult {
+export interface UseDataGridTableStageHistoryResult extends DataGridHistoryController {
     captureHistorySnapshot: () => unknown;
     captureHistorySnapshotForRowIds: (rowIds: readonly (string | number)[]) => unknown;
     recordHistoryIntentTransaction: (descriptor: {

package/dist/stage/useDataGridTableStageRuntime.d.ts

@@ -2,7 +2,8 @@ import { type ComputedRef, type Ref } from "vue";
 import type { DataGridColumnSnapshot, DataGridRowSelectionSnapshot, DataGridSelectionSnapshot } from "@affino/datagrid-vue";
 import type { DataGridCopyRange } from "@affino/datagrid-vue/advanced";
 import type { DataGridCellEditablePredicate } from "../dataGridEditability";
-import type { DataGridColumnMenuActionOptions, DataGridColumnMenuDisabledReasons, DataGridColumnMenuItemKey, DataGridColumnMenuItemLabels } from "../overlays/dataGridColumnMenu";
+import type { DataGridHistoryController } from "../dataGridHistory";
+import type { DataGridColumnMenuActionOptions, DataGridColumnMenuCustomItem, DataGridColumnMenuDisabledReasons, DataGridColumnMenuItemKey, DataGridColumnMenuItemLabels, DataGridColumnMenuTriggerMode } from "../overlays/dataGridColumnMenu";
 import type { DataGridLayoutMode } from "../config/dataGridLayout";
 import type { DataGridVirtualizationOptions } from "../config/dataGridVirtualization";
 import type { DataGridTableStageContext } from "./dataGridTableStageContext";
@@ -59,6 +60,7 @@ export interface UseDataGridTableStageRuntimeOptions<TRow extends Record<string,
     sortIndicator: (columnKey: string) => string;
     setColumnFilterText: (columnKey: string, value: string) => void;
     columnMenuEnabled?: Ref<boolean>;
+    columnMenuTrigger?: Ref<DataGridColumnMenuTriggerMode>;
     columnMenuValueFilterEnabled?: Ref<boolean>;
     columnMenuValueFilterRowLimit?: Ref<number>;
     columnMenuMaxFilterValues?: Ref<number>;
@@ -67,6 +69,7 @@ export interface UseDataGridTableStageRuntimeOptions<TRow extends Record<string,
     resolveColumnMenuDisabledReasons?: (columnKey: string) => DataGridColumnMenuDisabledReasons;
     resolveColumnMenuLabels?: (columnKey: string) => DataGridColumnMenuItemLabels;
     resolveColumnMenuActionOptions?: (columnKey: string) => DataGridColumnMenuActionOptions;
+    resolveColumnMenuCustomItems?: (columnKey: string) => readonly DataGridColumnMenuCustomItem[];
     isColumnFilterActive?: (columnKey: string) => boolean;
     isColumnGrouped?: (columnKey: string) => boolean;
     resolveColumnGroupOrder?: (columnKey: string) => number | null;
@@ -87,6 +90,9 @@ export interface UseDataGridTableStageRuntimeOptions<TRow extends Record<string,
     applyRangeMove?: (baseRange: DataGridCopyRange, targetRange: DataGridCopyRange) => boolean;
     isCellEditable?: DataGridCellEditablePredicate<TRow>;
     history?: DataGridTableStageHistoryAdapter;
+    historyEnabled?: Ref<boolean>;
+    historyMaxDepth?: Ref<number | undefined>;
+    historyShortcuts?: Ref<false | "grid" | "window">;
     isContextMenuVisible?: () => boolean;
     closeContextMenu?: () => void;
     openContextMenuFromCurrentCell?: () => void;
@@ -97,6 +103,7 @@ export interface UseDataGridTableStageRuntimeOptions<TRow extends Record<string,
 export interface UseDataGridTableStageRuntimeResult<TRow extends Record<string, unknown>> {
     tableStageProps: ComputedRef<DataGridTableStageProps<TRow>>;
     tableStageContext: DataGridTableStageContext<TRow>;
+    historyController: DataGridHistoryController;
     syncViewportFromDom: () => void;
     copySelectedCells: (trigger?: "keyboard" | "context-menu") => Promise<boolean>;
     pasteSelectedCells: (trigger?: "keyboard" | "context-menu") => Promise<boolean>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@affino/datagrid-vue-app",
-  "version": "0.1.21",
+  "version": "0.1.23",
   "description": "Declarative Vue DataGrid component for Affino",
   "type": "module",
   "main": "dist/index.js",
@@ -37,10 +37,10 @@
   "dependencies": {
     "@affino/menu-vue": "^2.1.1",
     "@affino/popover-vue": "^1.1.0",
-    "@affino/datagrid-vue": "0.3.13",
+    "@affino/datagrid-vue": "0.3.15",
     "@affino/datagrid-chrome": "0.1.1",
-    "@affino/datagrid-gantt": "0.1.1",
-    "@affino/datagrid-theme": "0.2.2"
+    "@affino/datagrid-theme": "0.2.2",
+    "@affino/datagrid-gantt": "0.1.1"
   },
   "peerDependencies": {
     "vue": "^3.3.0"