@toolbox-web/grid 2.4.1 → 2.6.0

package/lib/plugins/pinned-rows/pinned-rows.d.ts

@@ -1,5 +1,5 @@
 import { ColumnConfig } from '../../core/types';
-import { AggregationRowConfig, PinnedRowsConfig, PinnedRowsContext } from './types';
+import { AggregationRowConfig, PanelRender, PanelSlot, PinnedRowsConfig, PinnedRowsContext } from './types';
 /**
  * Creates the info bar DOM element with all configured panels.
  *
@@ -40,3 +40,31 @@ export declare function buildContext(rows: unknown[], columns: unknown[], grid:
 } | null, filterState?: {
     cachedResult: unknown[] | null;
 } | null): PinnedRowsContext;
+/**
+ * Built-in panel renderer: total row count.
+ * Always renders. Output: `<span class="tbw-status-panel tbw-status-panel-row-count">Total: N rows</span>`.
+ */
+export declare function rowCountPanel(): PanelRender;
+/**
+ * Built-in panel renderer: selected row count.
+ * Returns `null` (skipped) when no rows are selected.
+ */
+export declare function selectedCountPanel(): PanelRender;
+/**
+ * Built-in panel renderer: filtered row count.
+ * Returns `null` (skipped) when the filtered count equals the total (no filter active).
+ */
+export declare function filteredCountPanel(): PanelRender;
+/**
+ * Renders a single {@link PanelSlot} as a `.tbw-pinned-rows` row with three zones.
+ * Returns `null` if no panel content was produced (all renders returned null).
+ */
+export declare function renderPanelSlot(slot: PanelSlot, context: PinnedRowsContext): HTMLElement | null;
+/**
+ * Renders a single {@link AggregationRowConfig} (slot variant) as one
+ * `.tbw-aggregation-rows` container holding one `.tbw-aggregation-row`.
+ *
+ * The container class includes `-top` or `-bottom` to preserve existing CSS
+ * (e.g. border-top vs border-bottom).
+ */
+export declare function renderAggregationSlot(slot: AggregationRowConfig, position: 'top' | 'bottom', columns: ColumnConfig[], dataRows: unknown[], globalFullWidth?: boolean): HTMLElement;

package/lib/plugins/pinned-rows/types.d.ts

@@ -102,33 +102,120 @@ export interface AggregationRowConfig {
 }
 /** Configuration options for the status bar plugin */
 export interface PinnedRowsConfig {
-    /** Position of the info bar (default: 'bottom') */
+    /**
+     * Unified ordered list of pinned-row slots. When provided, `aggregationRows`,
+     * `customPanels`, `position`, `showRowCount`, `showSelectedCount` and
+     * `showFilteredCount` are ignored — slots are rendered in declared order
+     * within their `position` ('top' or 'bottom', default 'bottom').
+     *
+     * When omitted, the plugin synthesizes a slot list from the legacy fields so
+     * existing consumers keep their current DOM byte-identical.
+     *
+     * @example Mixed slots, top placement
+     * ```ts
+     * import { rowCountPanel, selectedCountPanel } from '@toolbox-web/grid/plugins/pinned-rows';
+     *
+     * new PinnedRowsPlugin({
+     *   slots: [
+     *     { position: 'top', render: rowCountPanel() },
+     *     { position: 'top', aggregators: { price: 'sum' }, label: 'Total' },
+     *     { position: 'bottom', render: selectedCountPanel() },
+     *   ],
+     * });
+     * ```
+     */
+    slots?: PinnedRowSlot[];
+    /**
+     * Position of the info bar (default: 'bottom').
+     * @deprecated Use {@link PinnedRowsConfig.slots} with per-slot `position`.
+     */
     position?: PinnedRowsPosition;
-    /** Show total row count in info bar (default: true) */
+    /**
+     * Show total row count in info bar (default: true).
+     * @deprecated Use {@link PinnedRowsConfig.slots} with the exported `rowCountPanel()` render function.
+     */
     showRowCount?: boolean;
-    /** Show selected row count in info bar (default: true) */
+    /**
+     * Show selected row count in info bar (default: true).
+     * @deprecated Use {@link PinnedRowsConfig.slots} with the exported `selectedCountPanel()` render function.
+     */
     showSelectedCount?: boolean;
-    /** Show filtered row count when filter is active (default: true) */
+    /**
+     * Show filtered row count when filter is active (default: true).
+     * @deprecated Use {@link PinnedRowsConfig.slots} with the exported `filteredCountPanel()` render function.
+     */
     showFilteredCount?: boolean;
-    /** Custom panels to display in the info bar */
+    /**
+     * Custom panels to display in the info bar.
+     * @deprecated Use {@link PinnedRowsConfig.slots} with `PanelSlot` entries.
+     */
     customPanels?: PinnedRowsPanel[];
-    /** Aggregation rows (footer/header rows with computed values) */
+    /**
+     * Aggregation rows (footer/header rows with computed values).
+     * @deprecated Use {@link PinnedRowsConfig.slots} with `AggregationSlot` entries (any slot
+     * without a `render` field is treated as an aggregation slot).
+     */
     aggregationRows?: AggregationRowConfig[];
     /**
      * Default fullWidth mode for all aggregation rows.
      * When true, each aggregation row renders as a single spanning cell with label and
      * aggregated values inline. When false (default), rows render per-column cells aligned
-     * to the grid template. Individual `AggregationRowConfig.fullWidth` overrides this.
+     * to the grid template. Individual `AggregationRowConfig.fullWidth` (or `AggregationSlot.fullWidth`)
+     * overrides this.
      * @default false
      */
     fullWidth?: boolean;
 }
-/** Custom panel definition for the status bar */
+/**
+ * A unified pinned-row slot. Discriminated by the presence of `render`:
+ * - With `render`  ⇒ {@link PanelSlot} (a status-panel row)
+ * - Without `render` ⇒ {@link AggregationSlot} (an aggregation row)
+ *
+ * Each slot occupies one DOM row inside its `position` area, in declared order.
+ */
+export type PinnedRowSlot = PanelSlot | AggregationSlot;
+/** Horizontal zone within a panel slot row. */
+export type PanelZone = 'left' | 'center' | 'right';
+/**
+ * Render function for a panel slot.
+ * Return `null` to skip rendering (used by the built-in count panels for
+ * conditional display, e.g. only show "Selected: N" when N > 0).
+ */
+export type PanelRender = (context: PinnedRowsContext) => HTMLElement | null;
+/** Render function plus optional zone within the panel row. */
+export interface ZonedPanelRender {
+    /** Horizontal zone within the row (default: 'left') */
+    zone?: PanelZone;
+    /** Render function */
+    render: PanelRender;
+}
+/** A status-panel slot. Each slot becomes its own `.tbw-pinned-rows` row. */
+export interface PanelSlot {
+    /** Optional identifier for diffing/targeted updates */
+    id?: string;
+    /** Position relative to the grid body (default: 'bottom') */
+    position?: PinnedRowsPosition;
+    /**
+     * Render function (or array of zoned render functions).
+     * - Single `PanelRender` ⇒ rendered into the `'left'` zone.
+     * - Array of `ZonedPanelRender` ⇒ each entry rendered into its declared zone.
+     */
+    render: PanelRender | ZonedPanelRender[];
+}
+/**
+ * An aggregation slot (row of computed values). Equivalent to {@link AggregationRowConfig}
+ * but lives in the unified `slots[]` ordering.
+ */
+export type AggregationSlot = AggregationRowConfig;
+/**
+ * Custom panel definition for the legacy info bar.
+ * @deprecated Use {@link PinnedRowSlot} via {@link PinnedRowsConfig.slots}.
+ */
 export interface PinnedRowsPanel {
     /** Unique identifier for the panel */
     id: string;
     /** Position within the status bar */
-    position: 'left' | 'center' | 'right';
+    position: PanelZone;
     /** Render function for the panel content */
     render: (context: PinnedRowsContext) => HTMLElement | string;
 }