@reforgium/data-grid 2.4.0 → 2.5.0

package/fesm2022/reforgium-data-grid.mjs

@@ -1,2 +1,2 @@
-export { o as DATA_GRID_CONFIG, p as DEFAULT_DATA_GRID_DEFAULTS, r as DataGrid, i as DataGridCellEmptyDirective, j as DataGridCellLoadingDirective, b as DataGridCellTemplateDirective, h as DataGridDeclarativeCellDirective, f as DataGridDeclarativeColumn, g as DataGridDeclarativeHeaderDirective, n as DataGridExpanderIconDirective, d as DataGridHeaderTemplateDirective, e as DataGridRowDirective, l as DataGridSortIconDirective, k as DataGridStickyRowDirective, D as DataGridTypeCellTemplateDirective, q as provideDataGridDefaults } from './reforgium-data-grid-reforgium-data-grid-DmoyegCD.mjs';
+export { o as DATA_GRID_CONFIG, p as DATA_GRID_TYPE_RENDERERS, q as DATA_GRID_TYPE_TRANSFORMERS, r as DEFAULT_DATA_GRID_DEFAULTS, v as DataGrid, i as DataGridCellEmptyDirective, j as DataGridCellLoadingDirective, b as DataGridCellTemplateDirective, h as DataGridDeclarativeCellDirective, f as DataGridDeclarativeColumn, g as DataGridDeclarativeHeaderDirective, n as DataGridExpanderIconDirective, d as DataGridHeaderTemplateDirective, e as DataGridRowDirective, l as DataGridSortIconDirective, k as DataGridStickyRowDirective, D as DataGridTypeCellTemplateDirective, s as provideDataGridDefaults, t as provideDataGridTypeRenderers, u as provideDataGridTypeTransformers } from './reforgium-data-grid-reforgium-data-grid-Civdbsy1.mjs';
 //# sourceMappingURL=reforgium-data-grid.mjs.map

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.4.0",
+  "version": "2.5.0",
   "name": "@reforgium/data-grid",
   "description": "reforgium DataGrid component",
   "author": "rtommievich",

package/types/reforgium-data-grid.d.ts

@@ -121,6 +121,7 @@ type GridTooltipContext<Data extends AnyDict = AnyDict> = {
     col: GridColumn<Data>;
     index: number;
     value: AnyType;
+    isPinned: boolean;
 };
 type GridColumnTooltip<Data extends AnyDict = AnyDict> = true | string | ((row: Data) => string) | TemplateRef<GridTooltipContext>;
 /**
@@ -139,7 +140,8 @@ type GridStickySide = 'left' | 'right';
  * - `'index'` - Display row index number
  * - `'checkbox'` - Display checkbox for selection
  */
-type GridCellRendererType = 'plain' | 'date' | 'number' | 'index' | 'checkbox';
+type GridBuiltInCellType = 'plain' | 'date' | 'number' | 'index' | 'checkbox';
+type GridCellRendererType = GridBuiltInCellType | string;
 /**
  * Array of column definitions for the data grid.
  *
@@ -290,6 +292,13 @@ type BaseGridColumn<Data extends AnyDict = AnyDict> = {
      * Defaults to `true` when omitted.
      */
     resizable?: boolean;
+    /**
+     * Optional display transformer applied to row data before rendering cell content.
+     *
+     * Unlike `value`, this preserves the standard key-based value extraction and only
+     * customizes the final displayed text.
+     */
+    transformer?: GridCellTransformer<Data>;
     /**
      * Data key to use for expanding/collapsing row details.
      */
@@ -303,7 +312,24 @@ type BaseGridColumn<Data extends AnyDict = AnyDict> = {
  *
  * @template Data - Type of data objects displayed in the grid rows
  */
-type GridCellRenderer<Data> = KeyResolver<Data, string | number>;
+type GridCellValueContext<Data extends AnyDict = AnyDict> = {
+    col: GridColumn<Data>;
+    index: number;
+    isPinned: boolean;
+};
+type GridCellRenderer<Data extends AnyDict = AnyDict> = {
+    bivarianceHack(row: Data, ctx: GridCellValueContext<Data>): string | number;
+}['bivarianceHack'];
+type GridCellTransformerContext<Data extends AnyDict = AnyDict> = {
+    value: unknown;
+    col: GridColumn<Data>;
+    index: number;
+    type: GridCellRendererType;
+    isPinned: boolean;
+};
+type GridCellTransformer<Data extends AnyDict = AnyDict> = {
+    bivarianceHack(row: Data, ctx: GridCellTransformerContext<Data>): unknown;
+}['bivarianceHack'];
 /**
  * Context data provided to the header template.
  *
@@ -344,6 +370,7 @@ type RenderTemplateData<Data extends AnyDict = AnyDict> = {
      * Zero-based row index in the current data set.
      */
     index: number;
+    isPinned: boolean;
 };
 type DeclarativeColumnDef<Data extends AnyDict = AnyDict> = {
     key: DataKey<Data>;
@@ -365,6 +392,7 @@ type DeclarativeColumnDef<Data extends AnyDict = AnyDict> = {
     typeParams?: AnyType;
     defaultValue?: AnyType;
     value?: GridCellRenderer<Data>;
+    transformer?: GridCellTransformer<Data>;
     track?: (row: Data) => string;
     tooltip?: GridColumnTooltip<Data>;
 };
@@ -416,17 +444,18 @@ declare class DataGridDeclarativeColumn<Data extends AnyDict = AnyDict> {
     maxWidth: _angular_core.InputSignalWithTransform<number | undefined, string | number | undefined>;
     flex: _angular_core.InputSignalWithTransform<number | undefined, string | number | undefined>;
     resizable: _angular_core.InputSignalWithTransform<boolean | undefined, string | boolean | undefined>;
-    type: _angular_core.InputSignal<GridCellRendererType | undefined>;
+    type: _angular_core.InputSignal<string | undefined>;
     typeParams: _angular_core.InputSignal<any>;
     defaultValue: _angular_core.InputSignal<any>;
     value: _angular_core.InputSignal<GridCellRenderer<Data> | undefined>;
+    transformer: _angular_core.InputSignal<GridCellTransformer<Data> | undefined>;
     track: _angular_core.InputSignal<((row: Data) => string) | undefined>;
     tooltip: _angular_core.InputSignal<GridColumnTooltip<Data> | undefined>;
     private headerTplRef;
     private cellTplRef;
     toDeclarativeColumn(): DeclarativeColumnDef<Data>;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<DataGridDeclarativeColumn<any>, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<DataGridDeclarativeColumn<any>, "re-dg-column", never, { "key": { "alias": "key"; "required": true; "isSignal": true; }; "header": { "alias": "header"; "required": false; "isSignal": true; }; "align": { "alias": "align"; "required": false; "isSignal": true; }; "sortKey": { "alias": "sortKey"; "required": false; "isSignal": true; }; "sticky": { "alias": "sticky"; "required": false; "isSignal": true; }; "expandBy": { "alias": "expandBy"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "visible": { "alias": "visible"; "required": false; "isSignal": true; }; "width": { "alias": "width"; "required": false; "isSignal": true; }; "minWidth": { "alias": "minWidth"; "required": false; "isSignal": true; }; "maxWidth": { "alias": "maxWidth"; "required": false; "isSignal": true; }; "flex": { "alias": "flex"; "required": false; "isSignal": true; }; "resizable": { "alias": "resizable"; "required": false; "isSignal": true; }; "type": { "alias": "type"; "required": false; "isSignal": true; }; "typeParams": { "alias": "typeParams"; "required": false; "isSignal": true; }; "defaultValue": { "alias": "defaultValue"; "required": false; "isSignal": true; }; "value": { "alias": "value"; "required": false; "isSignal": true; }; "track": { "alias": "track"; "required": false; "isSignal": true; }; "tooltip": { "alias": "tooltip"; "required": false; "isSignal": true; }; }, {}, ["headerTplRef", "cellTplRef"], ["*"], true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<DataGridDeclarativeColumn<any>, "re-dg-column", never, { "key": { "alias": "key"; "required": true; "isSignal": true; }; "header": { "alias": "header"; "required": false; "isSignal": true; }; "align": { "alias": "align"; "required": false; "isSignal": true; }; "sortKey": { "alias": "sortKey"; "required": false; "isSignal": true; }; "sticky": { "alias": "sticky"; "required": false; "isSignal": true; }; "expandBy": { "alias": "expandBy"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "visible": { "alias": "visible"; "required": false; "isSignal": true; }; "width": { "alias": "width"; "required": false; "isSignal": true; }; "minWidth": { "alias": "minWidth"; "required": false; "isSignal": true; }; "maxWidth": { "alias": "maxWidth"; "required": false; "isSignal": true; }; "flex": { "alias": "flex"; "required": false; "isSignal": true; }; "resizable": { "alias": "resizable"; "required": false; "isSignal": true; }; "type": { "alias": "type"; "required": false; "isSignal": true; }; "typeParams": { "alias": "typeParams"; "required": false; "isSignal": true; }; "defaultValue": { "alias": "defaultValue"; "required": false; "isSignal": true; }; "value": { "alias": "value"; "required": false; "isSignal": true; }; "transformer": { "alias": "transformer"; "required": false; "isSignal": true; }; "track": { "alias": "track"; "required": false; "isSignal": true; }; "tooltip": { "alias": "tooltip"; "required": false; "isSignal": true; }; }, {}, ["headerTplRef", "cellTplRef"], ["*"], true, never>;
 }
 
 declare class DataGridDeclarativeHeaderDirective {
@@ -699,6 +728,10 @@ type DataGridConfigOverrides = Partial<Omit<DataGridConfigProvider, 'translation
 };
 declare const DEFAULT_DATA_GRID_DEFAULTS: DataGridConfigProvider;
 declare const DATA_GRID_CONFIG: InjectionToken<DataGridConfigProvider>;
+type DataGridTypeTransformers<Data extends AnyDict = AnyDict> = Partial<Record<GridCellRendererType, GridCellTransformer<Data>>>;
+type DataGridTypeRenderers<Data extends AnyDict = AnyDict> = Partial<Record<GridCellRendererType, TemplateRef<RenderTemplateData<Data>>>>;
+declare const DATA_GRID_TYPE_TRANSFORMERS: InjectionToken<Partial<Record<string, GridCellTransformer<AnyDict>>>>;
+declare const DATA_GRID_TYPE_RENDERERS: InjectionToken<Partial<Record<string, TemplateRef<RenderTemplateData<AnyDict>>>>>;
 /**
  * Provides a default configuration for Data Grid, overriding base settings.
  *
@@ -706,6 +739,18 @@ declare const DATA_GRID_CONFIG: InjectionToken<DataGridConfigProvider>;
  * @returns EnvironmentProviders for use in application or component configuration.
  */
 declare function provideDataGridDefaults(config: DataGridConfigOverrides): EnvironmentProviders;
+/**
+ * Provides global type-based cell transformers for all `re-data-grid` instances in the current injector scope.
+ *
+ * Registrations are merged with parent injector registrations, and later providers override earlier ones.
+ */
+declare function provideDataGridTypeTransformers<Data extends AnyDict = AnyDict>(transformers: DataGridTypeTransformers<Data>): EnvironmentProviders;
+/**
+ * Provides global type-based cell render templates for all `re-data-grid` instances in the current injector scope.
+ *
+ * Registrations are merged with parent injector registrations, and later providers override earlier ones.
+ */
+declare function provideDataGridTypeRenderers<Data extends AnyDict = AnyDict>(renderers: DataGridTypeRenderers<Data>): EnvironmentProviders;
 
 type DeclarativeColumnsResult<Data extends AnyDict = AnyDict> = {
     columns: GridColumns<Data>;
@@ -964,7 +1009,7 @@ declare class DataGridVm<Data extends AnyDict> {
      * Stores reusable template references for different cell renderer types
      * that can be shared across multiple columns.
      */
-    globalTypeCellTpls: Map<GridCellRendererType, TemplateRef<Data>>;
+    globalTypeCellTpls: Map<string, TemplateRef<Data>>;
     globalDataCellTpls: Map<string | keyof Data, TemplateRef<Data>>;
     globalRowCellTpls: Map<string | keyof Data, TemplateRef<Data>>;
     pinnedTop: _angular_core.WritableSignal<GridPinnedRow<Data>[]>;
@@ -1568,6 +1613,6 @@ declare class DataGrid<Data extends AnyDict> {
     static ɵcmp: _angular_core.ɵɵComponentDeclaration<DataGrid<any>, "re-data-grid", never, { "data": { "alias": "data"; "required": false; "isSignal": true; }; "columns": { "alias": "columns"; "required": false; "isSignal": true; }; "mode": { "alias": "mode"; "required": false; "isSignal": true; }; "pinnedRows": { "alias": "pinnedRows"; "required": false; "isSignal": true; }; "isRowSticky": { "alias": "isRowSticky"; "required": false; "isSignal": true; }; "isRowDisabled": { "alias": "isRowDisabled"; "required": false; "isSignal": true; }; "getRowTemplate": { "alias": "getRowTemplate"; "required": false; "isSignal": true; }; "hasIndexColumn": { "alias": "hasIndexColumn"; "required": false; "isSignal": true; }; "selection": { "alias": "selection"; "required": false; "isSignal": true; }; "pageSize": { "alias": "pageSize"; "required": false; "isSignal": true; }; "rowHeight": { "alias": "rowHeight"; "required": false; "isSignal": true; }; "height": { "alias": "height"; "required": false; "isSignal": true; }; "virtualBuffer": { "alias": "virtualBuffer"; "required": false; "isSignal": true; }; "lockVerticalScroll": { "alias": "lockVerticalScroll"; "required": false; "isSignal": true; }; "headerGroups": { "alias": "headerGroups"; "required": false; "isSignal": true; }; "loading": { "alias": "loading"; "required": false; "isSignal": true; }; "loadingMode": { "alias": "loadingMode"; "required": false; "isSignal": true; }; "deferContent": { "alias": "deferContent"; "required": false; "isSignal": true; }; "deferHeader": { "alias": "deferHeader"; "required": false; "isSignal": true; }; "deferPinned": { "alias": "deferPinned"; "required": false; "isSignal": true; }; "deferCells": { "alias": "deferCells"; "required": false; "isSignal": true; }; "deferIcons": { "alias": "deferIcons"; "required": false; "isSignal": true; }; "deferTooltip": { "alias": "deferTooltip"; "required": false; "isSignal": true; }; "rowKey": { "alias": "rowKey"; "required": false; "isSignal": true; }; "pageStartFromZero": { "alias": "pageStartFromZero"; "required": false; "isSignal": true; }; "sortMode": { "alias": "sortMode"; "required": false; "isSignal": true; }; }, { "pageChange": "pageChange"; "sortChange": "sortChange"; "multiSortChange": "multiSortChange"; "selectChange": "selectChange"; "rowClick": "rowClick"; "rowContext": "rowContext"; "rowDoubleClick": "rowDoubleClick"; "cellClick": "cellClick"; "cellContext": "cellContext"; "cellDoubleClick": "cellDoubleClick"; }, ["cellTypedSlotRefs", "cellDataSlotRefs", "declarativeColumnRefs", "headerSlotRefs", "emptySlotRefs", "loadingSlotRefs", "sortIcSlotRefs", "expanderIcSlotRefs", "stickyRowSlotRefs", "rowSlotRefs"], never, true, never>;
 }
 
-export { DATA_GRID_CONFIG, DEFAULT_DATA_GRID_DEFAULTS, DataGrid, DataGridCellEmptyDirective, DataGridCellLoadingDirective, DataGridCellTemplateDirective, DataGridDeclarativeCellDirective, DataGridDeclarativeColumn, DataGridDeclarativeHeaderDirective, DataGridExpanderIconDirective, DataGridHeaderTemplateDirective, DataGridRowDirective, DataGridSortIconDirective, DataGridStickyRowDirective, DataGridTypeCellTemplateDirective, provideDataGridDefaults };
-export type { BaseGridColumn, DataGridConfigProvider, DataGridRowTemplateContext, DataGridStickyRowTemplateContext, DeclarativeColumnDef, GridCellAlign, GridCellClickEvent, GridCellContextEvent, GridCellDoubleClickEvent, GridCellRenderer, GridCellRendererType, GridColumn, GridColumnTooltip, GridColumns, GridHeaderGroup, GridMultiSortEvent, GridPageChangeEvent, GridPaginationMode, GridPinnedPosition, GridPinnedRow, GridPinnedRows, GridRowClickEvent, GridRowContextEvent, GridRowDoubleClickEvent, GridSelectEvent, GridSelectMode, GridSelection, GridSortEvent, GridSortItem, GridSortMode, GridSortOrder, GridStickySide, GridTooltipContext, HeaderTemplateData, RenderTemplateData };
+export { DATA_GRID_CONFIG, DATA_GRID_TYPE_RENDERERS, DATA_GRID_TYPE_TRANSFORMERS, DEFAULT_DATA_GRID_DEFAULTS, DataGrid, DataGridCellEmptyDirective, DataGridCellLoadingDirective, DataGridCellTemplateDirective, DataGridDeclarativeCellDirective, DataGridDeclarativeColumn, DataGridDeclarativeHeaderDirective, DataGridExpanderIconDirective, DataGridHeaderTemplateDirective, DataGridRowDirective, DataGridSortIconDirective, DataGridStickyRowDirective, DataGridTypeCellTemplateDirective, provideDataGridDefaults, provideDataGridTypeRenderers, provideDataGridTypeTransformers };
+export type { BaseGridColumn, DataGridConfigProvider, DataGridRowTemplateContext, DataGridStickyRowTemplateContext, DataGridTypeRenderers, DataGridTypeTransformers, DeclarativeColumnDef, GridBuiltInCellType, GridCellAlign, GridCellClickEvent, GridCellContextEvent, GridCellDoubleClickEvent, GridCellRenderer, GridCellRendererType, GridCellTransformer, GridCellTransformerContext, GridCellValueContext, GridColumn, GridColumnTooltip, GridColumns, GridHeaderGroup, GridMultiSortEvent, GridPageChangeEvent, GridPaginationMode, GridPinnedPosition, GridPinnedRow, GridPinnedRows, GridRowClickEvent, GridRowContextEvent, GridRowDoubleClickEvent, GridSelectEvent, GridSelectMode, GridSelection, GridSortEvent, GridSortItem, GridSortMode, GridSortOrder, GridStickySide, GridTooltipContext, HeaderTemplateData, RenderTemplateData };
 //# sourceMappingURL=reforgium-data-grid.d.ts.map