@skyux/ag-grid 13.11.4 → 13.12.0

package/index.d.ts

@@ -51,7 +51,7 @@ declare class SkyAgGridWrapperComponent implements AfterContentInit, AfterViewIn
 }
 
 /**
- * @internal
+ * Connects `SkyAgGridWrapperComponent` with a `SkyDataViewComponent` to control the grid using a `SkyDataManagerService` instance.
  */
 declare class SkyAgGridDataManagerAdapterDirective implements OnDestroy {
     #private;
@@ -93,6 +93,11 @@ interface SkyAgGridRowDeleteConfirmArgs {
     id: string;
 }
 
+/**
+ * Enables inline row delete functionality for an AG Grid when included
+ * on the `SkyAgGridWrapperComponent` element. The directive uses
+ * `rowDeleteIds` to determine which rows to add inline delete options to.
+ */
 declare class SkyAgGridRowDeleteDirective implements AfterContentInit, AfterViewInit, OnDestroy {
     #private;
     /**
@@ -116,6 +121,17 @@ declare class SkyAgGridRowDeleteDirective implements AfterContentInit, AfterView
     static ɵdir: i0.ɵɵDirectiveDeclaration<SkyAgGridRowDeleteDirective, "[skyAgGridRowDelete]", never, { "rowDeleteIds": { "alias": "rowDeleteIds"; "required": false; "isSignal": true; }; }, { "rowDeleteIds": "rowDeleteIdsChange"; "rowDeleteCancel": "rowDeleteCancel"; "rowDeleteConfirm": "rowDeleteConfirm"; }, ["agGrid"], never, true, never>;
 }
 
+/**
+ * Provides `SkyAgGridWrapperComponent` and `SkyAgGridRowDeleteDirective`, but to use
+ * AG Grid in your application, you must also load `AgGridAngular` from `ag-grid-angular` and
+ * `ModuleRegistry` from `ag-grid-community`. For more information, see
+ * [AG Grid modules](https://www.ag-grid.com/angular-data-grid/modules/).
+ *
+ * @example
+ * ```typescript
+ * ModuleRegistry.registerModules([AllCommunityModule]);
+ * ```
+ */
 declare class SkyAgGridModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<SkyAgGridModule, never>;
     static ɵmod: i0.ɵɵNgModuleDeclaration<SkyAgGridModule, never, [typeof i1$1.AgGridAngular, typeof i2.CommonModule, typeof SkyAgGridDataManagerAdapterDirective, typeof SkyAgGridResourcesModule, typeof SkyAgGridRowDeleteDirective, typeof SkyAgGridWrapperComponent], [typeof SkyAgGridDataManagerAdapterDirective, typeof SkyAgGridRowDeleteDirective, typeof SkyAgGridWrapperComponent]>;
@@ -139,7 +155,7 @@ declare class SkyAgGridAdapterService {
 
 interface SkyGetGridOptionsArgs<T = any> {
     /**
-     * The [AG Grid `gridOptions`](https://www.ag-grid.com/javascript-grid-properties/) that override default SKY UX `gridOptions`. SKY UX column types for components and column `cellClassRules` enforce required cell styling and cannot be overridden.
+     * The [AG Grid `gridOptions`](https://www.ag-grid.com/angular-data-grid/grid-options/) that override default SKY UX `gridOptions`. SKY UX column types for components and column `cellClassRules` enforce required cell styling and cannot be overridden.
      */
     gridOptions: GridOptions<T>;
     /**
@@ -161,13 +177,13 @@ declare class SkyAgGridService implements OnDestroy {
     constructor(agGridAdapterService: SkyAgGridAdapterService, themeSvc?: SkyThemeService, resources?: SkyLibResourcesService);
     ngOnDestroy(): void;
     /**
-     * Returns [AG Grid `gridOptions`](https://www.ag-grid.com/javascript-grid-properties/) with default SKY UX options, styling, and cell renderers registered for read-only grids.
+     * 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.
      * @param args
      * @returns
      */
     getGridOptions<T = any>(args: SkyGetGridOptionsArgs<T>): GridOptions<T>;
     /**
-     * Returns [AG Grid `gridOptions`](https://www.ag-grid.com/javascript-grid-properties/) with default SKY UX options, styling, and cell editors registered for editable grids.
+     * 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.
      * @param args
      * @returns
      */
@@ -451,17 +467,17 @@ declare class SkyAgGridCellEditorUtils {
 
 /**
  * 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/javascript-grid-cell-editor/) or [cell renderer](https://www.ag-grid.com/javascript-grid-cell-rendering-components/) 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.
+ * 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.
  */
 declare enum SkyCellType {
     /**
      * **Edit mode**
      *
-     * Cells in the column will be edited as [SKY UX autocomplete components](https://developer.blackbaud.com/skyux/components/autocomplete). You can set any of the autocomplete component's properties by passing `SkyCellEditorAutocompleteParams` in the [column definition's `cellEditorParams` property](https://www.ag-grid.com/angular-data-grid/column-properties/#reference-editing). These params can be updated as other cell edits are made or [provided dynamically](https://www.ag-grid.com/javascript-grid-cell-editing/#dynamic-parameters) based on other cell values. See the demo for an example. Text can be entered and a value selected from the provided list.
+     * Cells in the column will be edited as [SKY UX autocomplete components](https://developer.blackbaud.com/skyux/components/autocomplete). You can set any of the autocomplete component's properties by passing `SkyCellEditorAutocompleteParams` in the [column definition's `cellEditorParams` property](https://www.ag-grid.com/angular-data-grid/column-properties/#reference-editing). These params can be updated as other cell edits are made or [provided dynamically](https://www.ag-grid.com/angular-data-grid/cell-editing/) based on other cell values. See the demo for an example. Text can be entered and a value selected from the provided list.
      *
      * **Read-only mode**
      *
-     * Cells the column will display the currently selected value's name property by default. If the autocomplete needs to show a different property or needs to be formatted in any way, you can [define a `valueFormatter`](https://www.ag-grid.com/javascript-grid-value-formatters/) on the column definition.
+     * Cells the column will display the currently selected value's name property by default. If the autocomplete 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.
      */
     Autocomplete = "skyCellAutocomplete",
     /**
@@ -483,21 +499,21 @@ declare enum SkyCellType {
     /**
      * **Edit mode**
      *
-     * Cells in the column will be edited as [SKY UX datepicker components](https://developer.blackbaud.com/skyux/components/datepicker). You can set any of the datepicker component's properties by passing `SkyCellEditorDatepickerParams` in the [column definition's `cellEditorParams` property](https://www.ag-grid.com/angular-data-grid/column-properties/#reference-editing). These params can be updated as other cell edits are made or [provided dynamically](https://www.ag-grid.com/javascript-grid-cell-editing/#dynamic-parameters) based on other cell values. See the demo for an example. Date values can be entered.
+     * Cells in the column will be edited as [SKY UX datepicker components](https://developer.blackbaud.com/skyux/components/datepicker). You can set any of the datepicker component's properties by passing `SkyCellEditorDatepickerParams` in the [column definition's `cellEditorParams` property](https://www.ag-grid.com/angular-data-grid/column-properties/#reference-editing). These params can be updated as other cell edits are made or [provided dynamically](https://www.ag-grid.com/angular-data-grid/cell-editing/) based on other cell values. See the demo for an example. Date values can be entered.
      *
      * **Read-only mode**
      *
-     * Cells in the column will display the currently selected date formatted as `MM-DD-YYYY`, or the date format of the locale passed to `getGridOptions()`. If you would like to overwrite this format, you can [define a `valueFormatter`](https://www.ag-grid.com/javascript-grid-value-formatters/) on the column definition. See the demo for an example.
+     * Cells in the column will display the currently selected date formatted as `MM-DD-YYYY`, or the date format of the locale passed to `getGridOptions()`. If you would like to overwrite this format, you can [define a `valueFormatter`](https://www.ag-grid.com/angular-data-grid/value-formatters/) on the column definition. See the demo for an example.
      */
     Date = "skyCellDate",
     /**
      * **Edit mode**
      *
-     * Cells in the column will be edited as [SKY UX lookup components](https://developer.blackbaud.com/skyux-v5/components/lookup). You can set any of the lookup component's properties by passing `SkyCellEditorLookupParams` in the [column definition's `cellEditorParams` property](https://www.ag-grid.com/angular-data-grid/column-properties/#reference-editing). These params can be updated as other cell edits are made or [provided dynamically](https://www.ag-grid.com/javascript-grid-cell-editing/#dynamic-parameters) based on other cell values. See the demo for an example. Text can be entered and a value selected from the provided list.
+     * Cells in the column will be edited as [SKY UX lookup components](https://developer.blackbaud.com/skyux-v5/components/lookup). You can set any of the lookup component's properties by passing `SkyCellEditorLookupParams` in the [column definition's `cellEditorParams` property](https://www.ag-grid.com/angular-data-grid/column-properties/#reference-editing). These params can be updated as other cell edits are made or [provided dynamically](https://www.ag-grid.com/angular-data-grid/cell-editing/) based on other cell values. See the demo for an example. Text can be entered and a value selected from the provided list.
      *
      * **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/javascript-grid-value-formatters/) on the column definition.
+     * 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.
      */
     Lookup = "skyCellLookup",
     /**
@@ -525,7 +541,7 @@ declare enum SkyCellType {
     /**
      * **Edit and read-only modes**
      *
-     * Cells in the column will render as [SKY UX checkbox components](https://developer.blackbaud.com/skyux/components/checkbox). It allows the user to select multiple rows, and adds a highlight to selected rows. The [Ag Grid `rowNode`](https://www.ag-grid.com/javascript-grid-row-node/) will be updated to reflect the selected state.
+     * Cells in the column will render as [SKY UX checkbox components](https://developer.blackbaud.com/skyux/components/checkbox). It allows the user to select multiple rows, and adds a highlight to selected rows. The [Ag Grid `rowNode`](https://www.ag-grid.com/angular-data-grid/row-object/) will be updated to reflect the selected state.
      */
     RowSelector = "skyCellRowSelector",
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyux/ag-grid",
-  "version": "13.11.4",
+  "version": "13.12.0",
   "author": "Blackbaud, Inc.",
   "keywords": [
     "blackbaud",
@@ -25,24 +25,29 @@
     ".": {
       "types": "./index.d.ts",
       "default": "./fesm2022/skyux-ag-grid.mjs"
+    },
+    "./testing": {
+      "types": "./testing/index.d.ts",
+      "default": "./fesm2022/skyux-ag-grid-testing.mjs"
     }
   },
   "peerDependencies": {
+    "@angular/cdk": "^20.2.14",
     "@angular/common": "^20.3.15",
     "@angular/core": "^20.3.15",
     "@angular/forms": "^20.3.15",
-    "@skyux/autonumeric": "13.11.4",
-    "@skyux/core": "13.11.4",
-    "@skyux/data-manager": "13.11.4",
-    "@skyux/datetime": "13.11.4",
-    "@skyux/forms": "13.11.4",
-    "@skyux/i18n": "13.11.4",
-    "@skyux/icon": "13.11.4",
-    "@skyux/indicators": "13.11.4",
-    "@skyux/layout": "13.11.4",
-    "@skyux/lookup": "13.11.4",
-    "@skyux/popovers": "13.11.4",
-    "@skyux/theme": "13.11.4",
+    "@skyux/autonumeric": "13.12.0",
+    "@skyux/core": "13.12.0",
+    "@skyux/data-manager": "13.12.0",
+    "@skyux/datetime": "13.12.0",
+    "@skyux/forms": "13.12.0",
+    "@skyux/i18n": "13.12.0",
+    "@skyux/icon": "13.12.0",
+    "@skyux/indicators": "13.12.0",
+    "@skyux/layout": "13.12.0",
+    "@skyux/lookup": "13.12.0",
+    "@skyux/popovers": "13.12.0",
+    "@skyux/theme": "13.12.0",
     "ag-grid-angular": "^34.3.1",
     "ag-grid-community": "^34.3.1"
   },

package/testing/index.d.ts

@@ -0,0 +1,39 @@
+import { HarnessPredicate } from '@angular/cdk/testing';
+import { SkyHarnessFilters, SkyComponentHarness } from '@skyux/core/testing';
+
+/**
+ * A set of criteria that can be used to filter a list of `SkyAgGridWrapperHarness` instances.
+ */
+interface SkyAgGridWrapperHarnessFilters extends SkyHarnessFilters {
+}
+
+/**
+ * Harness for interacting with SKY UX AG Grid components in tests.
+ */
+declare class SkyAgGridWrapperHarness extends SkyComponentHarness {
+    #private;
+    /**
+     * @internal
+     */
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyAgGridWrapperHarness` that meets certain criteria
+     */
+    static with(filters: SkyAgGridWrapperHarnessFilters): HarnessPredicate<SkyAgGridWrapperHarness>;
+    /**
+     * Checks whether the grid is ready.
+     */
+    isGridReady(): Promise<boolean>;
+    /**
+     * Retrieves the IDs of the currently displayed columns.
+     */
+    getDisplayedColumnIds(): Promise<string[]>;
+    /**
+     * Retrieves the header names of the currently displayed columns.
+     */
+    getDisplayedColumnHeaderNames(): Promise<string[]>;
+}
+
+export { SkyAgGridWrapperHarness };
+export type { SkyAgGridWrapperHarnessFilters };