@skyux/ag-grid 14.11.0 → 14.13.0

package/fesm2022/skyux-ag-grid.mjs

@@ -84,6 +84,8 @@ const RESOURCES = {
         sky_ag_grid_column_group_header_collapse_aria_label: {
             message: 'Collapse column group {0}',
         },
+        sky_ag_grid_locale_no_rows_to_show: { message: 'No data available' },
+        sky_ag_grid_locale_no_matching_rows: { message: 'No matching rows' },
     },
     'FR-CA': {
         sky_ag_grid_row_selector_aria_label: {
@@ -311,6 +313,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
 /**
  * These column types can be used by setting the AG Grid [column definition `type`](https://www.ag-grid.com/angular-data-grid/column-properties/#reference-editing) to one of the following values.
  * Any [SKY UX component](https://developer.blackbaud.com/skyux/components) can be made into a [cell editor](https://www.ag-grid.com/angular-data-grid/cell-editors/) or [cell renderer](https://www.ag-grid.com/angular-data-grid/component-cell-renderer/) component. If you would like to use a component that does not have a column definition yet, please consider [contributing it](https://github.com/blackbaud/skyux/blob/main/CONTRIBUTING.md) to the SKY UX data entry grid module.
+ * Use `defineSkyAgGridColDef()` to validate a column definition's `cellEditorParams` and `cellRendererParams` against its cell type.
  */
 var SkyCellType;
 (function (SkyCellType) {
@@ -357,7 +360,7 @@ var SkyCellType;
      *
      * **Read-only mode**
      *
-     * Cells the column will display, by default, either: the name(s) of the selected value(s) if there are less than 6, or a summary count of the values if there are more than 5. If the lookup needs to show a different property or needs to be formatted in any way, you can [define a `valueFormatter`](https://www.ag-grid.com/angular-data-grid/value-formatters/) on the column definition.
+     * Cells in the column will display, by default, either: the name(s) of the selected value(s) if there are less than 6, or a summary count of the values if there are more than 5. If the lookup needs to show a different property or needs to be formatted in any way, you can [define a `valueFormatter`](https://www.ag-grid.com/angular-data-grid/value-formatters/) on the column definition.
      */
     SkyCellType["Lookup"] = "skyCellLookup";
     /**
@@ -3612,8 +3615,22 @@ function getValidatorCellRendererSelector(component, fallback) {
     };
 }
 let rowNodeId = -1;
+const skyAgGridLocaleTextDefaults = {
+    noRowsToShow: 'No data available',
+    noMatchingRows: 'No matching rows',
+};
+const skyAgGridLocaleTextResourceKeys = {
+    noRowsToShow: 'sky_ag_grid_locale_no_rows_to_show',
+    noMatchingRows: 'sky_ag_grid_locale_no_matching_rows',
+};
 /**
  * `SkyAgGridService` provides methods to get AG Grid `gridOptions` to ensure grids match SKY UX functionality. The `gridOptions` can be overridden, and include registered SKY UX column types.
+ *
+ * Locale text is resolved once, when the grid options are created. [AG Grid does not re-read
+ * locale text after a grid is created](https://www.ag-grid.com/angular-data-grid/localisation/),
+ * so an application that changes locale at runtime must destroy and recreate the grid. Setting
+ * `gridOptions.getLocaleText` replaces SKY UX locale text entirely — use `gridOptions.localeText`
+ * to override individual strings instead.
  */
 class SkyAgGridService {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -3629,8 +3646,13 @@ class SkyAgGridService {
     #numberValidatorMsg = toSignal(this.#resources?.getString('sky_ag_grid_cell_renderer_number_validator_message') ?? of('Please enter a valid number'), { initialValue: 'Please enter a valid number' });
     #rowSelectorHeading = toSignal(this.#resources?.getString('sky_ag_grid_row_selector_column_heading') ??
         of('Row selection'), { initialValue: 'Row selection' });
+    #localeText = toSignal(this.#resources?.getStrings(skyAgGridLocaleTextResourceKeys) ??
+        of(skyAgGridLocaleTextDefaults), { initialValue: skyAgGridLocaleTextDefaults });
     /**
      * Returns [AG Grid `gridOptions`](https://www.ag-grid.com/angular-data-grid/grid-options/) with default SKY UX options, styling, and cell renderers registered for read-only grids.
+     *
+     * Locale text is resolved once, at call time. If the application's locale changes at
+     * runtime, destroy and recreate the grid to pick up the new locale text.
      * @param args
      * @returns
      */
@@ -3641,6 +3663,9 @@ class SkyAgGridService {
     }
     /**
      * Returns [AG Grid `gridOptions`](https://www.ag-grid.com/angular-data-grid/grid-options/) with default SKY UX options, styling, and cell editors registered for editable grids.
+     *
+     * Locale text is resolved once, at call time. If the application's locale changes at
+     * runtime, destroy and recreate the grid to pick up the new locale text.
      * @param args
      * @returns
      */
@@ -3691,6 +3716,10 @@ class SkyAgGridService {
                 ...defaultGridOptions.context,
                 ...providedGridOptions.context,
             },
+            localeText: {
+                ...defaultGridOptions.localeText,
+                ...providedGridOptions.localeText,
+            },
             columnTypes: {
                 ...providedGridOptions.columnTypes,
                 // apply default second to prevent consumers from overwriting our default column types
@@ -3958,6 +3987,7 @@ class SkyAgGridService {
                 iconKey,
                 this.#getIconTemplate(iconKey),
             ])),
+            localeText: this.#localeText(),
             loadingOverlayComponent: SkyAgGridLoadingComponent,
             onCellFocused: (event) => this.#onCellFocused(event),
             rowModelType: 'clientSide',
@@ -4067,11 +4097,30 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                 }]
         }] });
 
+/**
+ * Builds a column definition whose `cellEditorParams` and `cellRendererParams`
+ * are validated against the SKY UX cell types in the `type` property. The cell
+ * type is inferred, so no type arguments are needed:
+ * ```
+ * defineSkyAgGridColDef({
+ *   field: 'endDate',
+ *   type: [SkyCellType.Date, SkyCellType.Validator],
+ *   cellRendererParams: { skyComponentProperties: { validator: ... } },
+ * })
+ * ```
+ */
+// `C` preserves the exact shape of the passed literal (like `satisfies`), `F`
+// keeps `field` narrowed to its literal type for row-typed grid options, and
+// the `Record` intersection rejects misspelled or unknown properties.
+function defineSkyAgGridColDef(colDef) {
+    return colDef;
+}
+
 // Export any types that should be included in the root.
 
 /**
  * Generated bundle index. Do not edit.
  */
 
-export { SkyAgGridCellEditorInitialAction, SkyAgGridCellEditorUtils, SkyAgGridHeaderGroupInfo, SkyAgGridHeaderInfo, SkyAgGridModule, SkyAgGridService, SkyCellClass, SkyCellType, SkyHeaderClass, SkyAgGridCellEditorAutocompleteComponent as λ1, SkyAgGridCellRendererValidatorTooltipComponent as λ10, SkyAgGridCellValidatorTooltipComponent as λ11, SkyAgGridWrapperComponent as λ12, SkyAgGridRowDeleteDirective as λ13, SkyAgGridDataManagerAdapterDirective as λ14, SkyAgGridCellEditorLookupComponent as λ15, SkyAgGridCellRendererLookupComponent as λ16, SkyAgGridHeaderComponent as λ17, SkyAgGridHeaderGroupComponent as λ18, SkyAgGridColumnFilterDatepickerComponent as λ19, SkyAgGridCellEditorTextComponent as λ2, SkyAgGridCellEditorCurrencyComponent as λ3, SkyAgGridCellEditorNumberComponent as λ4, SkyAgGridCellEditorDatepickerComponent as λ5, SkyAgGridRowDeleteComponent as λ6, SkyAgGridCellRendererRowSelectorComponent as λ7, SkyAgGridCellRendererCurrencyValidatorComponent as λ8, SkyAgGridCellRendererCurrencyComponent as λ9 };
+export { SkyAgGridCellEditorInitialAction, SkyAgGridCellEditorUtils, SkyAgGridHeaderGroupInfo, SkyAgGridHeaderInfo, SkyAgGridModule, SkyAgGridService, SkyCellClass, SkyCellType, SkyHeaderClass, defineSkyAgGridColDef, SkyAgGridCellEditorAutocompleteComponent as λ1, SkyAgGridCellRendererValidatorTooltipComponent as λ10, SkyAgGridCellValidatorTooltipComponent as λ11, SkyAgGridWrapperComponent as λ12, SkyAgGridRowDeleteDirective as λ13, SkyAgGridDataManagerAdapterDirective as λ14, SkyAgGridCellEditorLookupComponent as λ15, SkyAgGridCellRendererLookupComponent as λ16, SkyAgGridHeaderComponent as λ17, SkyAgGridHeaderGroupComponent as λ18, SkyAgGridColumnFilterDatepickerComponent as λ19, SkyAgGridCellEditorTextComponent as λ2, SkyAgGridCellEditorCurrencyComponent as λ3, SkyAgGridCellEditorNumberComponent as λ4, SkyAgGridCellEditorDatepickerComponent as λ5, SkyAgGridRowDeleteComponent as λ6, SkyAgGridCellRendererRowSelectorComponent as λ7, SkyAgGridCellRendererCurrencyValidatorComponent as λ8, SkyAgGridCellRendererCurrencyComponent as λ9 };
 //# sourceMappingURL=skyux-ag-grid.mjs.map