@skyux/ag-grid 11.19.0 → 11.19.2

package/lib/modules/ag-grid/types/header-group-info.d.ts

@@ -1,16 +1,25 @@
 import { ColumnGroup } from 'ag-grid-community';
 import * as i0 from "@angular/core";
 /**
- * To display a help button beside the column group header, create a component that includes the help button element,
- * such as `sky-help-inline`, include a `SkyAgGridHeaderGroupInfo` parameter in the constructor to access the column
- * group information, such as display name, and add the component to the `headerComponentParams.inlineHelpComponent`
- * property of the column definition.
+ * To display a help button beside the column group header, create a component containing
+ * [`sky-help-inline`](https://developer.blackbaud.com/skyux/components/help-inline),
+ * and use `inject(SkyAgGridHeaderGroupInfo)` to access the column group
+ * information, such as display name.
+ * Add the component to the `headerGroupComponentParams.inlineHelpComponent`
+ * property of the [column group definition](https://www.ag-grid.com/angular-data-grid/column-groups/).
+ * @see SkyAgGridHeaderGroupParams
  */
 export declare class SkyAgGridHeaderGroupInfo {
+    /**
+     * [Column group information from AG Grid](https://www.ag-grid.com/angular-data-grid/column-object-group/).
+     */
     columnGroup: ColumnGroup | undefined;
+    /**
+     * Display name of the column group.
+     */
     displayName: string | undefined;
     /**
-     * Application context as set on `gridOptions.context`.
+     * AG Grid's [`context` field](https://www.ag-grid.com/angular-data-grid/context/).
      */
     context: any;
     static ɵfac: i0.ɵɵFactoryDeclaration<SkyAgGridHeaderGroupInfo, never>;

package/lib/modules/ag-grid/types/header-group-params.d.ts

@@ -3,8 +3,12 @@ import { IHeaderGroupParams } from 'ag-grid-community';
 /**
  * Interface to use for the
  * [`headerGroupComponentParams`](https://www.ag-grid.com/angular-data-grid/column-properties/#reference-groupsHeader-headerGroupComponentParams)
- * property on `ColDef`.
+ * property on `ColGroupDef`.
  */
 export interface SkyAgGridHeaderGroupParams extends IHeaderGroupParams {
+    /**
+     * The component to display as inline help beside the column group header.
+     * @see SkyAgGridHeaderGroupInfo
+     */
     inlineHelpComponent?: Type<unknown>;
 }

package/lib/modules/ag-grid/types/header-info.d.ts

@@ -1,16 +1,25 @@
 import { Column } from 'ag-grid-community';
 import * as i0 from "@angular/core";
 /**
- * To display a help button beside the column header, create a component that includes the help button element,
- * such as `sky-help-inline`, include a `SkyAgGridHeaderInfo` parameter in the constructor to access the column
- * information, such as display name, and add the component to the `headerComponentParams.inlineHelpComponent` property
- * of the column definition.
+ * To display a help button beside the column header, create a component containing
+ * [`sky-help-inline`](https://developer.blackbaud.com/skyux/components/help-inline),
+ * and use `inject(SkyAgGridHeaderInfo)` to access the column information, such
+ * as display name.
+ * Add the component to the `headerComponentParams.inlineHelpComponent`
+ * property of the [column definition](https://www.ag-grid.com/angular-data-grid/column-definitions/).
+ * @see SkyAgGridHeaderParams
  */
 export declare class SkyAgGridHeaderInfo {
+    /**
+     * [Column information from AG Grid](https://www.ag-grid.com/angular-data-grid/column-object/).
+     */
     column: Column | undefined;
+    /**
+     * Display name of the column.
+     */
     displayName: string | undefined;
     /**
-     * Application context as set on `gridOptions.context`.
+     * AG Grid's [`context` field](https://www.ag-grid.com/angular-data-grid/context/).
      */
     context: any;
     static ɵfac: i0.ɵɵFactoryDeclaration<SkyAgGridHeaderInfo, never>;

package/lib/modules/ag-grid/types/header-params.d.ts

@@ -6,5 +6,15 @@ import { IHeaderParams } from 'ag-grid-community';
  * property on `ColDef`.
  */
 export interface SkyAgGridHeaderParams extends IHeaderParams {
+    /**
+     * Hides the column header text.
+     * Each column should have a `headerName` defined in the column definition for accessibility.
+     * This option allows that text to be hidden from view while still being available to screen readers.
+     */
+    headerHidden?: boolean;
+    /**
+     * The component to display as inline help beside the column header.
+     * @see SkyAgGridHeaderInfo
+     */
     inlineHelpComponent?: Type<unknown>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyux/ag-grid",
-  "version": "11.19.0",
+  "version": "11.19.2",
   "author": "Blackbaud, Inc.",
   "keywords": [
     "blackbaud",
@@ -36,18 +36,18 @@
     "@angular/common": "^18.2.8",
     "@angular/core": "^18.2.8",
     "@angular/forms": "^18.2.8",
-    "@skyux/autonumeric": "11.19.0",
-    "@skyux/core": "11.19.0",
-    "@skyux/data-manager": "11.19.0",
-    "@skyux/datetime": "11.19.0",
-    "@skyux/forms": "11.19.0",
-    "@skyux/i18n": "11.19.0",
-    "@skyux/icon": "11.19.0",
-    "@skyux/indicators": "11.19.0",
-    "@skyux/layout": "11.19.0",
-    "@skyux/lookup": "11.19.0",
-    "@skyux/popovers": "11.19.0",
-    "@skyux/theme": "11.19.0",
+    "@skyux/autonumeric": "11.19.2",
+    "@skyux/core": "11.19.2",
+    "@skyux/data-manager": "11.19.2",
+    "@skyux/datetime": "11.19.2",
+    "@skyux/forms": "11.19.2",
+    "@skyux/i18n": "11.19.2",
+    "@skyux/icon": "11.19.2",
+    "@skyux/indicators": "11.19.2",
+    "@skyux/layout": "11.19.2",
+    "@skyux/lookup": "11.19.2",
+    "@skyux/popovers": "11.19.2",
+    "@skyux/theme": "11.19.2",
     "ag-grid-angular": "^32.2.2",
     "ag-grid-community": "^32.2.2"
   },