@skyux/ag-grid 5.1.0 → 5.1.4

package/modules/ag-grid/ag-grid-data-manager-adapter.directive.d.ts

@@ -3,6 +3,9 @@ import { AgGridAngular } from 'ag-grid-angular';
 import { SkyDataManagerService } from '@skyux/data-manager';
 import { SkyAgGridWrapperComponent } from './ag-grid-wrapper.component';
 import * as i0 from "@angular/core";
+/**
+ * @internal
+ */
 export declare class SkyAgGridDataManagerAdapterDirective implements AfterContentInit, OnDestroy {
     private changeDetector;
     private dataManagerSvc;
@@ -24,6 +27,8 @@ export declare class SkyAgGridDataManagerAdapterDirective implements AfterConten
     private unregisterSkyAgGridWrapper;
     private registerSkyAgGridWrapper;
     private registerAgGrid;
+    private updateColumnsInCurrentDataState;
+    private getColumnOrder;
     private displayColumns;
     private selectAll;
     private clearAll;

package/modules/ag-grid/ag-grid-row-delete.directive.d.ts

@@ -3,9 +3,12 @@ import { SkyAffixService, SkyOverlayService } from '@skyux/core';
 import { AgGridAngular } from 'ag-grid-angular';
 import { RowNode } from 'ag-grid-community';
 import { SkyAgGridRowDeleteCancelArgs } from './types/ag-grid-row-delete-cancel-args';
-import { SkyAgGridRowDeleteConfig } from './types/ag-gird-row-delete-config';
+import { SkyAgGridRowDeleteConfig } from './types/ag-grid-row-delete-config';
 import { SkyAgGridRowDeleteConfirmArgs } from './types/ag-grid-row-delete-confirm-args';
 import * as i0 from "@angular/core";
+/**
+ * @internal
+ */
 export declare class SkyAgGridRowDeleteDirective implements AfterContentInit, OnDestroy {
     private affixService;
     private changeDetector;

package/modules/ag-grid/ag-grid-wrapper.component.d.ts

@@ -2,6 +2,9 @@ import { AfterContentInit, ChangeDetectorRef, ElementRef } from '@angular/core';
 import { AgGridAngular } from 'ag-grid-angular';
 import { SkyAgGridAdapterService } from './ag-grid-adapter.service';
 import * as i0 from "@angular/core";
+/**
+ * @internal
+ */
 export declare class SkyAgGridWrapperComponent implements AfterContentInit {
     private adapterService;
     private changeDetector;

package/modules/ag-grid/ag-grid.service.d.ts

@@ -6,21 +6,30 @@ import { SkyGetGridOptionsArgs } from './types/sky-grid-options';
 import { SkyAgGridAdapterService } from './ag-grid-adapter.service';
 import * as i0 from "@angular/core";
 /**
- * A service that provides default styling and behavior for agGrids in SKY UX SPAs.
+ * `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.
  */
 export declare class SkyAgGridService implements OnDestroy {
     private agGridAdapterService;
     private themeSvc?;
     private resources?;
+    /**
+     * @internal
+     */
     currentTheme: SkyThemeSettings;
     private ngUnsubscribe;
     constructor(agGridAdapterService: SkyAgGridAdapterService, themeSvc?: SkyThemeService, resources?: SkyLibResourcesService);
     ngOnDestroy(): void;
     /**
-     * Get SKY UX gridOptions to create your agGrid with default SKY styling and behavior.
-     * @param args options to be applied to the default SKY UX agGrid gridOptions.
+     * 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.
+     * @param args
+     * @returns
      */
     getGridOptions(args: SkyGetGridOptionsArgs): GridOptions;
+    /**
+     * 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.
+     * @param args
+     * @returns
+     */
     getEditableGridOptions(args: SkyGetGridOptionsArgs): GridOptions;
     private mergeGridOptions;
     private getDefaultGridOptions;

package/modules/ag-grid/cell-editors/cell-editor-autocomplete/cell-editor-autocomplete.component.d.ts

@@ -3,6 +3,9 @@ import { ICellEditorAngularComp } from 'ag-grid-angular';
 import { SkyCellEditorAutocompleteParams } from '../../types/cell-editor-autocomplete-params';
 import { SkyAutocompleteProperties } from '../../types/autocomplete-properties';
 import * as i0 from "@angular/core";
+/**
+ * @internal
+ */
 export declare class SkyAgGridCellEditorAutocompleteComponent implements ICellEditorAngularComp {
     currentSelection: any;
     columnHeader: string;

package/modules/ag-grid/cell-editors/cell-editor-currency/cell-editor-currency.component.d.ts

@@ -2,6 +2,9 @@ import { ICellEditorAngularComp } from 'ag-grid-angular';
 import { SkyCellEditorCurrencyParams } from '../../types/cell-editor-currency-params';
 import { SkyCurrencyProperties } from '../../types/currency-properties';
 import * as i0 from "@angular/core";
+/**
+ * @internal
+ */
 export declare class SkyAgGridCellEditorCurrencyComponent implements ICellEditorAngularComp {
     value: number;
     skyComponentProperties: SkyCurrencyProperties;

package/modules/ag-grid/cell-editors/cell-editor-datepicker/cell-editor-datepicker.component.d.ts

@@ -4,6 +4,9 @@ import { PopupComponent } from 'ag-grid-community';
 import { SkyCellEditorDatepickerParams } from '../../types/cell-editor-datepicker-params';
 import { SkyDatepickerProperties } from '../../types/datepicker-properties';
 import * as i0 from "@angular/core";
+/**
+ * @internal
+ */
 export declare class SkyAgGridCellEditorDatepickerComponent extends PopupComponent implements ICellEditorAngularComp {
     private themeSvc?;
     columnWidth: number;

package/modules/ag-grid/cell-editors/cell-editor-number/cell-editor-number.component.d.ts

@@ -1,6 +1,9 @@
 import { ICellEditorAngularComp } from 'ag-grid-angular';
 import { ICellEditorParams } from 'ag-grid-community';
 import * as i0 from "@angular/core";
+/**
+ * @internal
+ */
 export declare class SkyAgGridCellEditorNumberComponent implements ICellEditorAngularComp {
     value: number;
     columnHeader: string;

package/modules/ag-grid/cell-editors/cell-editor-text/cell-editor-text.component.d.ts

@@ -1,6 +1,9 @@
 import { ICellEditorAngularComp } from 'ag-grid-angular';
 import { ICellEditorParams } from 'ag-grid-community';
 import * as i0 from "@angular/core";
+/**
+ * @internal
+ */
 export declare class SkyAgGridCellEditorTextComponent implements ICellEditorAngularComp {
     value: string;
     textInputLabel: string;

package/modules/ag-grid/cell-renderers/cell-renderer-currency/cell-renderer-currency-validator.component.d.ts

@@ -2,6 +2,9 @@ import { ChangeDetectorRef } from '@angular/core';
 import { ICellRendererAngularComp } from 'ag-grid-angular';
 import { SkyCellRendererCurrencyParams } from '../../types/cell-renderer-currency-params';
 import * as i0 from "@angular/core";
+/**
+ * @internal
+ */
 export declare class SkyAgGridCellRendererCurrencyValidatorComponent implements ICellRendererAngularComp {
     private changeDetector;
     set parameters(value: SkyCellRendererCurrencyParams);

package/modules/ag-grid/cell-renderers/cell-renderer-currency/cell-renderer-currency.component.d.ts

@@ -3,6 +3,9 @@ import { ICellRendererAngularComp } from 'ag-grid-angular';
 import { SkyCellRendererCurrencyParams } from '../../types/cell-renderer-currency-params';
 import { ValidatorOptions } from '../../types/validator-options';
 import * as i0 from "@angular/core";
+/**
+ * @internal
+ */
 export declare class SkyAgGridCellRendererCurrencyComponent implements ICellRendererAngularComp {
     set params(value: SkyCellRendererCurrencyParams);
     columnHeader: string;

package/modules/ag-grid/cell-renderers/cell-renderer-row-selector/cell-renderer-row-selector.component.d.ts

@@ -2,6 +2,9 @@ import { ChangeDetectorRef } from '@angular/core';
 import { ICellRendererAngularComp } from 'ag-grid-angular';
 import { ICellRendererParams, RowNode } from 'ag-grid-community';
 import * as i0 from "@angular/core";
+/**
+ * @internal
+ */
 export declare class SkyAgGridCellRendererRowSelectorComponent implements ICellRendererAngularComp {
     private changeDetection;
     checked: boolean;

package/modules/ag-grid/cell-renderers/cell-renderer-validator-tooltip/cell-renderer-validator-tooltip.component.d.ts

@@ -2,6 +2,9 @@ import { ChangeDetectorRef } from '@angular/core';
 import { ICellRendererAngularComp } from 'ag-grid-angular';
 import { SkyCellRendererValidatorParams } from '../../types/cell-renderer-validator-params';
 import * as i0 from "@angular/core";
+/**
+ * @internal
+ */
 export declare class SkyAgGridCellRendererValidatorTooltipComponent implements ICellRendererAngularComp {
     private changeDetector;
     set params(value: SkyCellRendererValidatorParams);

package/modules/ag-grid/cell-validator/ag-grid-cell-validator-tooltip.component.d.ts

@@ -3,6 +3,9 @@ import { SkyPopoverMessage } from '@skyux/popovers';
 import { Subject } from 'rxjs';
 import { SkyCellRendererValidatorParams } from '../types/cell-renderer-validator-params';
 import * as i0 from "@angular/core";
+/**
+ * @internal
+ */
 export declare class SkyAgGridCellValidatorTooltipComponent {
     private changeDetector;
     private zone;

package/modules/ag-grid/types/ag-grid-row-delete-cancel-args.d.ts

@@ -1,5 +1,6 @@
 /**
  * Information regarding a row whose deletion has been cancelled.
+ * @internal
  */
 export interface SkyAgGridRowDeleteCancelArgs {
     /**

package/modules/ag-grid/types/ag-grid-row-delete-confirm-args.d.ts

@@ -1,5 +1,6 @@
 /**
  * Information regarding a row whose deletion has been confirmed.
+ * @internal
  */
 export interface SkyAgGridRowDeleteConfirmArgs {
     /**

package/modules/ag-grid/types/autocomplete-properties.d.ts

@@ -1,4 +1,7 @@
 import { TemplateRef } from '@angular/core';
+/**
+ * @internal
+ */
 export interface SkyAutocompleteProperties {
     data?: any[];
     debounceTime?: number;

package/modules/ag-grid/types/cell-class.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export declare enum SkyCellClass {
     Autocomplete = "sky-ag-grid-cell-autocomplete",
     Currency = "sky-ag-grid-cell-currency",

package/modules/ag-grid/types/cell-type.d.ts

@@ -1,12 +1,82 @@
+/**
+ * These column types can be used by setting the AG Grid [column definition `type`](https://www.ag-grid.com/javascript-grid-column-properties/) to one of the following values.
+ * <br/>
+ * 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://developer.blackbaud.com/skyux/contribute/contribution-process) to the SKY UX data entry grid module, or [file an issue](https://developer.blackbaud.com/skyux/contribute/contribution-process/file-issue) in the [`@skyux/ag-grid` repo](https://github.com/blackbaud/skyux-ag-grid).
+ */
 export declare enum SkyCellType {
+    /**
+     * **Edit mode**
+     * <br/>
+     * Specifies that 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 them in the [column definition's `cellEditorParams` property](https://www.ag-grid.com/javascript-grid-column-properties/). 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.
+     * <br/><br/>
+     * **Read-only mode**
+     * <br/>
+     * Specifies that 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.
+     */
     Autocomplete = "skyCellAutocomplete",
+    /**
+     * **Edit mode**
+     * <br/>
+     * Specifies that cells in the column will be edited as a currency amount.
+     * <br/><br/>
+     * **Read-only mode**
+     * <br/>
+     * Formats the display as currency using [SKY UX numeric components](https://developer.blackbaud.com/skyux/components/numeric).
+     */
     Currency = "skyCellCurrency",
+    /**
+     * **Edit and read-only modes**
+     * <br/>
+     * Combines SkyCellType.Currency and SkyCellType.Validator, where the value is displayed as a currency and passed to a validator function.
+     */
     CurrencyValidator = "skyCellCurrencyValidator",
+    /**
+     * **Edit mode**
+     * <br/>
+     * Specifies that 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 them in the [column definition's `cellEditorParams` property](https://www.ag-grid.com/javascript-grid-column-properties/). 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.
+     * <br/><br/>
+     * **Read-only mode**
+     * <br/>
+     * Specifies that 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.
+     */
     Date = "skyCellDate",
     Lookup = "skyCellLookup",
+    /**
+     * **Edit mode**
+     * <br/>
+     * Specifies that cells in the column will be edited as HTML number `inputs`. Only numbers can be entered.
+     * <br/><br/>
+     * **Read-only mode**
+     * <br/>
+     * Specifies that cells in the column will render as the number value.
+     */
     Number = "skyCellNumber",
+    /**
+     * **Edit and read-only modes**
+     * <br/>
+     * Combines SkyCellType.Number and SkyCellType.Validator, where the value is displayed as a number and passed to a validator function.
+     */
     NumberValidator = "skyCellNumberValidator",
+    /**
+     * **Edit and read-only modes**
+     * <br/>
+     * Specifies that 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.
+     */
     RowSelector = "skyCellRowSelector",
+    /**
+     * **Edit mode**
+     * <br/>
+     * Specifies that cells in the column will be edited as HTML text `inputs`. Any characters can be entered.
+     * <br/><br/>
+     * **Read-only mode**
+     * <br/>
+     * Specifies cells in the column will render as their string value.
+     */
     Text = "skyCellText",
+    /**
+     * **Edit and read-only modes**
+     * <br/>
+     * Specifies cell in the column will be passed to a validator function which flags erroneous entries. You can set the validator function and message by passing them to [column definition's `cellRendererParams` property](https://www.ag-grid.com/javascript-grid-column-properties/) as `skyComponentProperties.validator` and `skyComponentProperties.validatorMessage`. SkyCellType.Validator can be combined with other cell types, such as SkyCellType.Autocomplete or SkyCellType.Date, by using the array syntax for the [column definition's `type` property](https://www.ag-grid.com/javascript-grid-column-properties/).
+     */
     Validator = "skyCellValidator"
 }

package/modules/ag-grid/types/datepicker-properties.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export interface SkyDatepickerProperties {
     dateFormat?: string;
     disabled?: boolean;

package/modules/ag-grid/types/header-class.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export declare enum SkyHeaderClass {
     RightAligned = "sky-ag-grid-header-right-aligned"
 }

package/modules/ag-grid/types/sky-grid-options.d.ts

@@ -1,11 +1,11 @@
 import { GridOptions } from 'ag-grid-community';
 export interface SkyGetGridOptionsArgs {
     /**
-     * agGrid gridOptions to override the default SKY UX grid options.
+     * Specifies the [AG Grid `gridOptions`](https://www.ag-grid.com/javascript-grid-properties/) used to override default SKY UX gridOptions. SKY UX column types for components and column `cellClassRules` enforce required cell styling and cannot be overridden.
      */
     gridOptions: GridOptions;
     /**
-     * the locale used in the date value formatter.
+     * Specifies the locale used for location-specific formatting, such as date values for the `SkyCellType.Date` column. This property accepts string values.
      */
     locale?: string;
 }

package/package.json

@@ -1,20 +1,20 @@
 {
   "name": "@skyux/ag-grid",
-  "version": "5.1.0",
+  "version": "5.1.4",
   "peerDependencies": {
-    "@angular/common": "^12.2.11",
-    "@angular/core": "^12.2.11",
+    "@angular/common": "^12.2.14",
+    "@angular/core": "^12.2.14",
     "ag-grid-angular": "^26.0.0",
     "ag-grid-community": "^26.0.0",
-    "@skyux/autonumeric": "^5.0.0",
-    "@skyux/data-manager": "^5.0.0",
-    "@skyux/datetime": "^5.0.0",
-    "@skyux/forms": "^5.0.0",
-    "@skyux/i18n": "^5.0.0",
-    "@skyux/indicators": "^5.0.0",
-    "@skyux/layout": "^5.0.0",
-    "@skyux/lookup": "^5.0.3",
-    "@skyux/popovers": "^5.0.0"
+    "@skyux/autonumeric": "^5.0.2",
+    "@skyux/data-manager": "^5.0.2",
+    "@skyux/datetime": "^5.0.2",
+    "@skyux/forms": "^5.0.1",
+    "@skyux/i18n": "^5.0.1",
+    "@skyux/indicators": "^5.0.3",
+    "@skyux/layout": "^5.1.0",
+    "@skyux/lookup": "^5.0.4",
+    "@skyux/popovers": "^5.0.1"
   },
   "dependencies": {
     "tslib": "^2.3.1"