@toolbox-web/grid 0.6.0 → 1.1.0

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

@@ -1,30 +1,91 @@
 import { BaseGridPlugin } from '../../core/plugin/base-plugin';
 import { AggregationRowConfig, PinnedRowsConfig, PinnedRowsContext, PinnedRowsPanel } from './types';
 /**
- * Pinned Rows Plugin for tbw-grid
+ * Pinned Rows (Status Bar) Plugin for tbw-grid
+ *
+ * Creates fixed status bars at the top or bottom of the grid for displaying aggregations,
+ * row counts, or custom content. Think of it as the "totals row" you'd see in a spreadsheet—
+ * always visible regardless of scroll position.
+ *
+ * ## Installation
  *
- * @example
  * ```ts
- * new PinnedRowsPlugin({
- *   enabled: true,
- *   position: 'bottom',
- *   showRowCount: true,
- *   showSelectedCount: true,
- *   aggregationRows: [
- *     { id: 'totals', position: 'bottom', values: { amount: 'sum' } },
+ * import { PinnedRowsPlugin } from '@toolbox-web/grid/plugins/pinned-rows';
+ * ```
+ *
+ * ## Configuration Options
+ *
+ * | Option | Type | Default | Description |
+ * |--------|------|---------|-------------|
+ * | `position` | `'top' \| 'bottom'` | `'bottom'` | Status bar position |
+ * | `showRowCount` | `boolean` | `true` | Show total row count |
+ * | `showSelectedCount` | `boolean` | `true` | Show selected row count |
+ * | `showFilteredCount` | `boolean` | `true` | Show filtered row count |
+ * | `aggregationRows` | `AggregationRowConfig[]` | - | Aggregation row configs |
+ *
+ * ## Built-in Aggregation Functions
+ *
+ * | Function | Description |
+ * |----------|-------------|
+ * | `sum` | Sum of values |
+ * | `avg` | Average of values |
+ * | `count` | Count of rows |
+ * | `min` | Minimum value |
+ * | `max` | Maximum value |
+ *
+ * ## CSS Custom Properties
+ *
+ * | Property | Default | Description |
+ * |----------|---------|-------------|
+ * | `--tbw-pinned-rows-bg` | `var(--tbw-color-panel-bg)` | Status bar background |
+ * | `--tbw-pinned-rows-border` | `var(--tbw-color-border)` | Status bar border |
+ *
+ * @example Status Bar with Aggregation
+ * ```ts
+ * import '@toolbox-web/grid';
+ * import { PinnedRowsPlugin } from '@toolbox-web/grid/plugins/pinned-rows';
+ *
+ * grid.gridConfig = {
+ *   columns: [
+ *     { field: 'product', header: 'Product' },
+ *     { field: 'quantity', header: 'Qty', type: 'number' },
+ *     { field: 'price', header: 'Price', type: 'currency' },
  *   ],
- * })
+ *   plugins: [
+ *     new PinnedRowsPlugin({
+ *       position: 'bottom',
+ *       showRowCount: true,
+ *       aggregationRows: [
+ *         {
+ *           id: 'totals',
+ *           aggregators: { quantity: 'sum', price: 'sum' },
+ *           cells: { product: 'Totals:' },
+ *         },
+ *       ],
+ *     }),
+ *   ],
+ * };
  * ```
+ *
+ * @see {@link PinnedRowsConfig} for all configuration options
+ * @see {@link AggregationRowConfig} for aggregation row structure
+ *
+ * @internal Extends BaseGridPlugin
  */
 export declare class PinnedRowsPlugin extends BaseGridPlugin<PinnedRowsConfig> {
+    /** @internal */
     readonly name = "pinnedRows";
+    /** @internal */
     readonly styles: string;
+    /** @internal */
     protected get defaultConfig(): Partial<PinnedRowsConfig>;
     private infoBarElement;
     private topAggregationContainer;
     private bottomAggregationContainer;
     private footerWrapper;
+    /** @internal */
     detach(): void;
+    /** @internal */
     afterRender(): void;
     private cleanup;
     private cleanupFooter;

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

@@ -1 +1 @@
-{"version":3,"file":"PinnedRowsPlugin.d.ts","sourceRoot":"","sources":["../../../../../../libs/grid/src/lib/plugins/pinned-rows/PinnedRowsPlugin.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAI/D,OAAO,KAAK,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE1G;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,gBAAiB,SAAQ,cAAc,CAAC,gBAAgB,CAAC;IACpE,QAAQ,CAAC,IAAI,gBAAgB;IAC7B,SAAkB,MAAM,SAAU;IAElC,cAAuB,aAAa,IAAI,OAAO,CAAC,gBAAgB,CAAC,CAOhE;IAGD,OAAO,CAAC,cAAc,CAA4B;IAClD,OAAO,CAAC,uBAAuB,CAA4B;IAC3D,OAAO,CAAC,0BAA0B,CAA4B;IAC9D,OAAO,CAAC,aAAa,CAA4B;IAIxC,MAAM,IAAI,IAAI;IAqBd,WAAW,IAAI,IAAI;IA4H5B,OAAO,CAAC,OAAO;IAmBf,OAAO,CAAC,aAAa;IAerB,OAAO,CAAC,iBAAiB;IASzB,OAAO,CAAC,cAAc;IAUtB;;OAEG;IACH,OAAO,IAAI,IAAI;IAIf;;;OAGG;IACH,UAAU,IAAI,iBAAiB;IAa/B;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,eAAe,GAAG,IAAI;IAQtC;;;OAGG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAO7B;;;OAGG;IACH,iBAAiB,CAAC,GAAG,EAAE,oBAAoB,GAAG,IAAI;IAQlD;;;OAGG;IACH,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;CAOvC"}
+{"version":3,"file":"PinnedRowsPlugin.d.ts","sourceRoot":"","sources":["../../../../../../libs/grid/src/lib/plugins/pinned-rows/PinnedRowsPlugin.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAI/D,OAAO,KAAK,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE1G;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuEG;AACH,qBAAa,gBAAiB,SAAQ,cAAc,CAAC,gBAAgB,CAAC;IACpE,gBAAgB;IAChB,QAAQ,CAAC,IAAI,gBAAgB;IAC7B,gBAAgB;IAChB,SAAkB,MAAM,SAAU;IAElC,gBAAgB;IAChB,cAAuB,aAAa,IAAI,OAAO,CAAC,gBAAgB,CAAC,CAOhE;IAGD,OAAO,CAAC,cAAc,CAA4B;IAClD,OAAO,CAAC,uBAAuB,CAA4B;IAC3D,OAAO,CAAC,0BAA0B,CAA4B;IAC9D,OAAO,CAAC,aAAa,CAA4B;IAIjD,gBAAgB;IACP,MAAM,IAAI,IAAI;IAqBvB,gBAAgB;IACP,WAAW,IAAI,IAAI;IA4H5B,OAAO,CAAC,OAAO;IAmBf,OAAO,CAAC,aAAa;IAerB,OAAO,CAAC,iBAAiB;IASzB,OAAO,CAAC,cAAc;IAUtB;;OAEG;IACH,OAAO,IAAI,IAAI;IAIf;;;OAGG;IACH,UAAU,IAAI,iBAAiB;IAa/B;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,eAAe,GAAG,IAAI;IAQtC;;;OAGG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAO7B;;;OAGG;IACH,iBAAiB,CAAC,GAAG,EAAE,oBAAoB,GAAG,IAAI;IAQlD;;;OAGG;IACH,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;CAOvC"}

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

@@ -1,7 +1,9 @@
 /**
  * Pinned Rows Plugin Entry Point
  * Re-exports plugin class and types for tree-shakeable imports.
+ *
+ * @module Plugins/Pinned Rows
  */
 export { PinnedRowsPlugin } from './PinnedRowsPlugin';
-export type { AggregationRowConfig, AggregatorConfig, AggregatorDefinition, AggregatorFormatter, PinnedRowsConfig, PinnedRowsContext, PinnedRowsPanel, } from './types';
+export type { AggregationRowConfig, AggregatorDefinition, PinnedRowsConfig, PinnedRowsContext, PinnedRowsPanel, } from './types';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../libs/grid/src/lib/plugins/pinned-rows/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,YAAY,EACV,oBAAoB,EACpB,gBAAgB,EAChB,oBAAoB,EACpB,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,GAChB,MAAM,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../libs/grid/src/lib/plugins/pinned-rows/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,YAAY,EACV,oBAAoB,EACpB,oBAAoB,EACpB,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,GAChB,MAAM,SAAS,CAAC"}

package/lib/plugins/pinned-rows/index.js

@@ -25,6 +25,28 @@ class A {
    * ```
    */
   static dependencies;
+  /**
+   * Plugin manifest - declares owned properties, config rules, and hook priorities.
+   *
+   * This is read by the configuration validator to:
+   * - Validate that required plugins are loaded when their properties are used
+   * - Execute configRules to detect invalid/conflicting settings
+   * - Order hook execution based on priority
+   *
+   * @example
+   * ```typescript
+   * static override readonly manifest: PluginManifest<MyConfig> = {
+   *   ownedProperties: [
+   *     { property: 'myProp', level: 'column', description: 'the "myProp" column property' },
+   *   ],
+   *   configRules: [
+   *     { id: 'myPlugin/conflict', severity: 'warn', message: '...', check: (c) => c.a && c.b },
+   *   ],
+   * };
+   * ```
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  static manifest;
   /**
    * Plugin version - defaults to grid version for built-in plugins.
    * Third-party plugins can override with their own semver.
@@ -184,23 +206,6 @@ class A {
   get gridElement() {
     return this.grid;
   }
-  /**
-   * Get the render root of the grid for DOM queries.
-   * @deprecated Use `gridElement` instead. This getter exists only for backward compatibility.
-   *
-   * With Shadow DOM removed, the grid element itself is the render root.
-   * All new code should use `this.gridElement` for DOM queries.
-   *
-   * @example
-   * // OLD (deprecated)
-   * const rows = this.shadowRoot?.querySelector('.rows');
-   *
-   * // NEW (preferred)
-   * const rows = this.gridElement.querySelector('.rows');
-   */
-  get shadowRoot() {
-    return this.gridElement;
-  }
   /**
    * Get the disconnect signal for event listener cleanup.
    * This signal is aborted when the grid disconnects from the DOM.
@@ -451,8 +456,11 @@ function v(n, t, e, o, r) {
 }
 const S = "@layer tbw-plugins{.tbw-footer{flex-shrink:0;z-index:var(--tbw-z-layer-pinned-rows, 20);background:var(--tbw-color-panel-bg)}.tbw-pinned-rows{display:flex;align-items:center;justify-content:space-between;padding:var(--tbw-button-padding, var(--tbw-spacing-md, .5rem) var(--tbw-spacing-lg, .75rem));background:var(--tbw-pinned-rows-bg, var(--tbw-color-panel-bg));border-top:1px solid var(--tbw-pinned-rows-border, var(--tbw-color-border));font-size:var(--tbw-font-size-xs, .75rem);color:var(--tbw-pinned-rows-color, var(--tbw-color-fg-muted));min-height:32px;box-sizing:border-box;min-width:fit-content}.tbw-pinned-rows-left,.tbw-pinned-rows-center,.tbw-pinned-rows-right{display:flex;align-items:center;gap:var(--tbw-spacing-xl, 1rem)}.tbw-pinned-rows-left{justify-content:flex-start}.tbw-pinned-rows-center{justify-content:center;flex:1}.tbw-pinned-rows-right{justify-content:flex-end}.tbw-status-panel{white-space:nowrap}.tbw-aggregation-rows{min-width:fit-content;background:var(--tbw-aggregation-bg, var(--tbw-color-header-bg))}.tbw-aggregation-rows-top{border-bottom:1px solid var(--tbw-aggregation-border, var(--tbw-color-border))}.tbw-aggregation-rows-bottom{border-top:1px solid var(--tbw-aggregation-border, var(--tbw-color-border))}.tbw-aggregation-row{display:grid;grid-template-columns:var(--tbw-column-template);font-size:var(--tbw-aggregation-font-size, .8em);font-weight:var(--tbw-aggregation-font-weight, 600)}.tbw-aggregation-cell{padding:var(--tbw-cell-padding, .125rem .5rem);min-height:var(--tbw-row-height, 1.75rem);display:flex;align-items:center;border-right:1px solid var(--tbw-color-border-cell)}.tbw-aggregation-cell:last-child{border-right:0}.tbw-aggregation-cell-full{grid-column:1 / -1;border-right:0}}";
 class B extends A {
+  /** @internal */
   name = "pinnedRows";
+  /** @internal */
   styles = S;
+  /** @internal */
   get defaultConfig() {
     return {
       position: "bottom",
@@ -468,11 +476,13 @@ class B extends A {
   footerWrapper = null;
   // #endregion
   // #region Lifecycle
+  /** @internal */
   detach() {
     this.infoBarElement && (this.infoBarElement.remove(), this.infoBarElement = null), this.topAggregationContainer && (this.topAggregationContainer.remove(), this.topAggregationContainer = null), this.bottomAggregationContainer && (this.bottomAggregationContainer.remove(), this.bottomAggregationContainer = null), this.footerWrapper && (this.footerWrapper.remove(), this.footerWrapper = null);
   }
   // #endregion
   // #region Hooks
+  /** @internal */
   afterRender() {
     const t = this.gridElement;
     if (!t) return;