@mantine-vue/table 2.4.0 → 3.1.0

package/lib/components/MVT_TableSlots.d.ts

@@ -1,5 +1,6 @@
 import { type Slots, type VNodeChild } from 'vue';
 import { type MVT_Cell, type MVT_Column, type MVT_InternalFilterOption, type MVT_Node, type MVT_Row, type MVT_RowData, type MVT_TableInstance } from '../types';
+import type { MVT_ServerGroupCellContext, MVT_ServerGroupPathId, MVT_ServerGroupPathItem, MVT_ServerGroupRowContext, MVT_ServerGroupingGroupByContext } from '../server-grouping/serverGrouping.types';
 /**
  * Scoped named slots supported on `<MantineVueTable>`.
  *
@@ -57,6 +58,33 @@ export interface MVT_TableSlots<TData extends MVT_RowData = MVT_RowData> {
         onSelectFilterMode: (filterMode: string) => void;
         table: MVT_TableInstance<TData>;
     }) => VNodeChild;
+    /**
+     * Replaces the built-in group-by toolbar control entirely (takes precedence
+     * over `serverGrouping.groupBy.renderControl`). Use the provided context to
+     * build your own UI; disable the default independently via
+     * `serverGrouping.groupBy.enabled: false`.
+     */
+    serverGroupByControl?: (arg: MVT_ServerGroupingGroupByContext) => VNodeChild;
+    serverGroupCell?: (arg: MVT_ServerGroupCellContext) => VNodeChild;
+    serverGroupCount?: (arg: MVT_ServerGroupRowContext) => VNodeChild;
+    serverGroupEmpty?: (arg: {
+        field?: string;
+        parentGroup?: MVT_ServerGroupPathItem;
+        pathId: MVT_ServerGroupPathId;
+        table: MVT_TableInstance<TData>;
+    }) => VNodeChild;
+    serverGroupError?: (arg: {
+        error: unknown;
+        pathId: MVT_ServerGroupPathId;
+        retry: () => void;
+        table: MVT_TableInstance<TData>;
+    }) => VNodeChild;
+    serverGroupLabel?: (arg: MVT_ServerGroupRowContext) => VNodeChild;
+    serverGroupLoading?: (arg: {
+        depth: number;
+        pathId: MVT_ServerGroupPathId;
+        table: MVT_TableInstance<TData>;
+    }) => VNodeChild;
     rowActionMenuItems?: (arg: {
         renderedRowIndex?: number;
         row: MVT_Row<TData>;

package/lib/components/buttons/MVT_EditActionButtons.d.ts

@@ -29,5 +29,5 @@ export declare const MVT_EditActionButtons: import("vue").DefineComponent<import
         default: string;
     };
 }>> & Readonly<{}>, {
-    variant: "text" | "icon";
+    variant: "icon" | "text";
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

package/lib/components/menus/MVT_ColumnActionMenu.d.ts

@@ -37,6 +37,6 @@ export declare const MVT_ColumnActionMenu: import("vue").DefineComponent<import(
         required: true;
     };
 }>> & Readonly<{}>, {
-    onChange: (opened: boolean) => void;
     opened: boolean;
+    onChange: (opened: boolean) => void;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

package/lib/index.d.mts

@@ -55,6 +55,13 @@ export * from './components/toolbar/MVT_ToolbarAlertBanner';
 export * from './components/toolbar/MVT_ToolbarDropZone';
 export * from './components/toolbar/MVT_ToolbarInternalButtons';
 export * from './components/toolbar/MVT_TopToolbar';
+export * from './server-grouping/createServerGroupingProvider';
+export * from './server-grouping/MVT_ServerGroupingBody';
+export * from './server-grouping/MVT_ServerGroupingGroupBy';
+export * from './server-grouping/serverGrouping.types';
+export * from './server-grouping/serverGrouping.utils';
+export * from './server-grouping/serverGroupingSelection';
+export * from './server-grouping/useMVT_ServerGrouping';
 export * from './fns/aggregationFns';
 export * from './fns/filterFns';
 export * from './fns/sortingFns';

package/lib/index.d.ts

@@ -55,6 +55,13 @@ export * from './components/toolbar/MVT_ToolbarAlertBanner';
 export * from './components/toolbar/MVT_ToolbarDropZone';
 export * from './components/toolbar/MVT_ToolbarInternalButtons';
 export * from './components/toolbar/MVT_TopToolbar';
+export * from './server-grouping/createServerGroupingProvider';
+export * from './server-grouping/MVT_ServerGroupingBody';
+export * from './server-grouping/MVT_ServerGroupingGroupBy';
+export * from './server-grouping/serverGrouping.types';
+export * from './server-grouping/serverGrouping.utils';
+export * from './server-grouping/serverGroupingSelection';
+export * from './server-grouping/useMVT_ServerGrouping';
 export * from './fns/aggregationFns';
 export * from './fns/filterFns';
 export * from './fns/sortingFns';

package/lib/server-grouping/MVT_ServerGroupingBody.d.ts

@@ -0,0 +1,24 @@
+import { type PropType } from 'vue';
+import { type MVT_RowData, type MVT_TableInstance } from '../types';
+/** Renders the server-grouping hierarchy as rows of the root table body. */
+export declare const MVT_ServerGroupingBody: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    table: {
+        type: PropType<MVT_TableInstance<MVT_RowData>>;
+        required: true;
+    };
+    tableProps: {
+        type: PropType<Record<string, any>>;
+        required: true;
+    };
+}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}> | null, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    table: {
+        type: PropType<MVT_TableInstance<MVT_RowData>>;
+        required: true;
+    };
+    tableProps: {
+        type: PropType<Record<string, any>>;
+        required: true;
+    };
+}>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

package/lib/server-grouping/MVT_ServerGroupingGroupBy.d.ts

@@ -0,0 +1,45 @@
+import { type PropType } from 'vue';
+import { type MVT_RowData, type MVT_TableInstance } from '../types';
+import { type MVT_ServerGroupableColumn, type MVT_ServerGroupingGroupByContext } from './serverGrouping.types';
+import { type MVT_ServerGroupingManager } from './useMVT_ServerGrouping';
+/**
+ * Resolve the columns/fields offered by the group-by toolbar control.
+ *
+ * With `serverGrouping.groupBy.columns` set, exactly that whitelist is used
+ * (entries may be custom descriptors like `'createdAt:month'`). Otherwise
+ * every leaf `data` column whose `enableGrouping` is not `false` is offered —
+ * display columns and columns with `enableGrouping: false` never appear.
+ */
+export declare const getServerGroupableColumns: (table: MVT_TableInstance<any>) => MVT_ServerGroupableColumn[];
+/** Build the scoped context handed to the group-by slot / render callback. */
+export declare const getServerGroupingGroupByContext: (table: MVT_TableInstance<any>, manager: MVT_ServerGroupingManager<MVT_RowData>) => MVT_ServerGroupingGroupByContext;
+/**
+ * Grouping actions for one column's action menu, or `undefined` when the
+ * column cannot be grouped by.
+ *
+ * Uses exactly the same rules as the toolbar "Group by" control: server
+ * grouping must be active and driven by the table's `grouping` state, the
+ * control must not be disabled, and the column must be offered by
+ * {@link getServerGroupableColumns}.
+ */
+export declare const getServerGroupingColumnActions: (table: MVT_TableInstance<any>, columnId: string) => MVT_ServerGroupingGroupByContext | undefined;
+/**
+ * Built-in group-by toolbar control for server-side grouping. Renders a
+ * "Group by" menu (add / reorder / remove / clear levels) plus the active
+ * levels as removable pills. Hidden when server grouping is inactive, when
+ * `groupBy.enabled` is `false`, or when grouping is a static
+ * `serverGrouping.grouping` array (which the control could not change).
+ */
+export declare const MVT_ServerGroupingGroupBy: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    table: {
+        type: PropType<MVT_TableInstance<MVT_RowData>>;
+        required: true;
+    };
+}>, () => string | number | boolean | void | import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}> | import("vue").VNodeArrayChildren | null, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    table: {
+        type: PropType<MVT_TableInstance<MVT_RowData>>;
+        required: true;
+    };
+}>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

package/lib/server-grouping/createServerGroupingProvider.d.ts

@@ -0,0 +1,39 @@
+import type { MVT_RowData } from '../types';
+import type { MVT_ServerGroupingContext, MVT_ServerGroupingProvider, MVT_ServerGroupRequest, MVT_ServerRecordRequest } from './serverGrouping.types';
+/**
+ * Config for {@link createServerGroupingProvider}. Accepts concise property
+ * names (`groups`, `groupId`, `records`, …) in addition to the explicit
+ * adapter names of {@link MVT_ServerGroupingProvider} (`getGroups`,
+ * `getGroupId`, `getRecords`, …). Explicit names win when both are given.
+ */
+export interface MVT_CreateServerGroupingProviderOptions<TData extends MVT_RowData = MVT_RowData, TGroup = unknown, TGroupResponse = unknown, TRecordResponse = unknown> extends Partial<Omit<MVT_ServerGroupingProvider<TData, TGroup, TGroupResponse, TRecordResponse>, 'loadGroups' | 'loadRecords'>> {
+    loadGroups: (request: MVT_ServerGroupRequest<TGroup>) => Promise<TGroupResponse>;
+    loadRecords: (request: MVT_ServerRecordRequest<TGroup>) => Promise<TRecordResponse>;
+    groups?: (response: TGroupResponse) => TGroup[];
+    groupRowCount?: (response: TGroupResponse) => number;
+    groupId?: (group: TGroup, context: MVT_ServerGroupingContext<TGroup>) => string;
+    groupLabel?: (group: TGroup, context: MVT_ServerGroupingContext<TGroup>) => string;
+    groupValue?: (group: TGroup, context: MVT_ServerGroupingContext<TGroup>) => unknown;
+    groupCount?: (group: TGroup, context: MVT_ServerGroupingContext<TGroup>) => number | undefined;
+    groupMeta?: (group: TGroup, context: MVT_ServerGroupingContext<TGroup>) => Record<string, unknown>;
+    hasChildren?: (group: TGroup, context: MVT_ServerGroupingContext<TGroup>) => boolean;
+    records?: (response: TRecordResponse) => TData[];
+    recordRowCount?: (response: TRecordResponse) => number;
+    rowId?: (row: TData) => string;
+    cacheKey?: (request: MVT_ServerGroupRequest<TGroup> | MVT_ServerRecordRequest<TGroup>) => unknown[];
+}
+/**
+ * Build a {@link MVT_ServerGroupingProvider} with sensible defaults for common
+ * response formats:
+ *
+ * - `groups`/`records` default to the response itself when it is an array.
+ * - `groupRowCount`/`recordRowCount` default to the mapped array length.
+ * - `groupId`/`groupLabel` default to stringifying `groupValue` (or the group
+ *   itself when it is a primitive).
+ * - `groupValue` defaults to the group object itself.
+ * - `groupMeta` defaults to `{}`; `groupCount` and aggregates stay optional.
+ * - `hasChildren` defaults to `true` (every level up to and including the last
+ *   grouping level is expandable).
+ * - `rowId` falls back to the table's existing `getRowId` logic.
+ */
+export declare const createServerGroupingProvider: <TData extends MVT_RowData = MVT_RowData, TGroup = unknown, TGroupResponse = unknown, TRecordResponse = unknown>(options: MVT_CreateServerGroupingProviderOptions<TData, TGroup, TGroupResponse, TRecordResponse>) => MVT_ServerGroupingProvider<TData, TGroup, TGroupResponse, TRecordResponse>;