@genesislcap/grid-pro 14.408.0 → 14.409.0

package/dist/grid-pro.d.ts

@@ -374,6 +374,12 @@ export declare enum AgGridTheme {
  */
 export declare const agHeadCSS: ElementStyles;
 
+/**
+ * The AG Icon Renderer Styles.
+ * @public
+ */
+export declare const agIconRendererStyles: ElementStyles;
+
 /**
  * The AG Select Renderer Styles.
  * @public
@@ -994,6 +1000,15 @@ template: ViewTemplate<DateEditor, any>;
  * @public
  */
 export declare const foundationGridComponents: {
+    foundationIconRenderer: (overrideDefinition?: OverrideFoundationElementDefinition<    {
+    baseName: string;
+    template: ViewTemplate<IconRenderer, any>;
+    styles: ElementStyles;
+    }>) => FoundationElementRegistry<    {
+    baseName: string;
+    template: ViewTemplate<IconRenderer, any>;
+    styles: ElementStyles;
+    }, IconRenderer>;
     foundationGridProActionRenderer: (overrideDefinition?: OverrideFoundationElementDefinition<    {
     baseName: string;
     styles: ElementStyles;
@@ -1055,17 +1070,6 @@ export declare const foundationGridComponents: {
     styles: ElementStyles;
     template: ViewTemplate<any, any>;
     }, SelectRenderer>;
-    foundationGridPro: (overrideDefinition?: OverrideFoundationElementDefinition<    {
-    shadowOptions: any;
-    baseName: string;
-    styles: ElementStyles;
-    template: ViewTemplate<any, any>;
-    }>) => FoundationElementRegistry<    {
-    shadowOptions: any;
-    baseName: string;
-    styles: ElementStyles;
-    template: ViewTemplate<any, any>;
-    }, GridPro>;
     foundationSelectEditor: (overrideDefinition?: OverrideFoundationElementDefinition<    {
     baseName: string;
     styles: ElementStyles;
@@ -1130,6 +1134,17 @@ export declare const foundationGridComponents: {
     styles: ElementStyles;
     }, typeof StatusPillRenderer>;
     StatusPillRenderer: typeof StatusPillRenderer;
+    foundationGridPro: (overrideDefinition?: OverrideFoundationElementDefinition<    {
+    shadowOptions: any;
+    baseName: string;
+    styles: ElementStyles;
+    template: ViewTemplate<any, any>;
+    }>) => FoundationElementRegistry<    {
+    shadowOptions: any;
+    baseName: string;
+    styles: ElementStyles;
+    template: ViewTemplate<any, any>;
+    }, GridPro>;
     register(container?: Container, ...rest: any[]): void;
 };
 
@@ -1199,6 +1214,23 @@ export declare const foundationGridProShadowOptions: ShadowRootInit;
  */
 export declare const foundationGridProStyles: ElementStyles;
 
+/**
+ * A function that returns a Foundation Icon Renderer registration for configuring the component with a DesignSystem.
+ *
+ * @public
+ * @remarks
+ * HTML Element: \<foundation-icon-renderer\>
+ */
+export declare const foundationIconRenderer: (overrideDefinition?: OverrideFoundationElementDefinition<    {
+baseName: string;
+template: ViewTemplate<IconRenderer, any>;
+styles: ElementStyles;
+}>) => FoundationElementRegistry<    {
+baseName: string;
+template: ViewTemplate<IconRenderer, any>;
+styles: ElementStyles;
+}, typeof IconRenderer>;
+
 /**
  * A function that returns a Multicolumn Dropdown registration for configuring the component with a DesignSystem.
  *
@@ -1918,6 +1950,14 @@ export declare function getErrorHandlerDialogTemplate(prefix: string, gridErrorI
  */
 export declare const getGridProTemplate: (prefix?: string) => ViewTemplate<GridPro, any>;
 
+/**
+ * Get a Design System prefixed Icon template.
+ * @param designSystem - The design system prefix to use. Defaults to 'foundation'.
+ * @returns An Icon component template prefixed with the correct design system.
+ * @public
+ */
+export declare const getIconRendererTemplate: (designSystem?: string) => ViewTemplate<IconRenderer, any>;
+
 /**
  * Get a Design System prefixed Multicolumn Dropdown template.
  * @param designSystem - The design system prefix to use. Defaults to 'foundation'.
@@ -2578,13 +2618,7 @@ declare const GridPro_base: (new (...args: any[]) => {
     scrollBy(options?: ScrollToOptions): void;
     scrollBy(x: number, y: number): void;
     scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void;
-    scrollTo(options? /**
-    * Custom error handler dialog template function.
-    * @remarks
-    * When provided, this function will be used to render custom error dialogs instead of the default error handler.
-    * The function should accept a prefix string and an array of grid error items and return a ViewTemplate.
-    * If not provided, the default error handler dialog template will be used.
-    */: ScrollToOptions): void;
+    scrollTo(options?: ScrollToOptions): void;
     scrollTo(x: number, y: number): void;
     setAttribute(qualifiedName: string, value: string): void;
     setAttributeNS(namespace: string | null, qualifiedName: string, value: string): void;
@@ -3649,10 +3683,7 @@ declare const GridProBeta_base: (new (...args: any[]) => {
     querySelectorAll<K extends keyof MathMLElementTagNameMap>(selectors: K): NodeListOf<MathMLElementTagNameMap[K]>;
     querySelectorAll<K extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K): NodeListOf<HTMLElementDeprecatedTagNameMap[K]>;
     querySelectorAll<E extends Element = Element>(selectors: string): NodeListOf<E>;
-    replaceChildren(... /**
-    * Handles datasource initialization
-    * @internal
-    */nodes: (Node | string)[]): void;
+    replaceChildren(...nodes: (Node | string)[]): void;
     readonly assignedSlot: HTMLSlotElement | null;
     readonly attributeStyleMap: StylePropertyMap;
     get style(): CSSStyleDeclaration;
@@ -4782,6 +4813,7 @@ export declare enum GridProRendererTypes {
     actionsMenu = "actionsMenu",
     boolean = "boolean",
     editable = "editable",
+    icon = "icon",
     text = "text",// TODO: textField :(
     select = "select",
     statusPill = "statusPill",
@@ -5411,6 +5443,90 @@ export declare type GrigProGenesisDatasourceSizeChangedEventDetail = {
     oldValue: number;
 };
 
+declare type IconByNameParams = {
+    /**
+     * The name of the icon to display.
+     * @remarks a string for the icon. Valid values are from the free set of font awesome icons which can be found here https://fontawesome.com/search?ic=free
+     */
+    iconName: string;
+    /**
+     * The size of the icon.
+     * @remarks Size values depend on the design system (e.g., 'xs', 'sm', 'md', 'lg').
+     */
+    iconSize: string;
+};
+
+declare type IconBySrcParams = {
+    /**
+     * The source URL of an image icon to display.
+     * @remarks Used when rendering an image instead of an icon element.
+     */
+    iconSrc: string;
+    /**
+     * The height of an image icon.
+     * @remarks Used when iconSrc is provided. Defaults to '14px'.
+     */
+    iconHeight: string;
+};
+
+/**
+ * Plain ag-Grid cell renderer for icons.
+ * This renderer creates the FAST custom element using document.createElement.
+ *
+ * @public
+ */
+export declare class IconRenderer extends FoundationElement implements ICellRendererComp {
+    params: IconRendererParams;
+    init(params: IconRendererParams & ICellRendererParams): void;
+    getGui(): HTMLElement;
+    refresh(params: any): boolean;
+    destroy(): void;
+}
+
+/**
+ * Parameters for the {@link @genesislcap/grid-pro#GridPro} icon renderer.
+ * @public
+ */
+export declare type IconRendererParams = ICellRendererParams & (IconByNameParams | IconBySrcParams) & {
+    /**
+     * The color of the icon.
+     * @remarks Can be a CSS color value (e.g., '#FF0000', 'red', 'var(--accent-foreground)').
+     */
+    iconColor?: string;
+    /**
+     * The variant of the icon.
+     * @remarks Variant values depend on the design system (e.g., 'solid', 'regular', 'outline').
+     */
+    variant?: string;
+    /**
+     * Callback function triggered when the icon is clicked.
+     * @param event - The click event.
+     * @param rowData - The data associated with the row.
+     */
+    clickHandler?: (event: Event, rowData: any) => void;
+    /**
+     * Whether to show hover effects on the icon.
+     * @remarks When true, adds padding, border-radius, and hover background color.
+     */
+    showHover?: boolean;
+    /**
+     * The name of a secondary icon to display.
+     * @remarks Rendered as a small icon positioned at the bottom-right of the primary icon.
+     */
+    secondaryIcon?: string;
+    /**
+     * The color of the secondary icon.
+     * @remarks Can be a CSS color value.
+     */
+    secondaryIconColor?: string;
+    /**
+     * Function to determine whether the icon should be disabled for a specific row.
+     * @param rowData - The data associated with the row.
+     * @returns A boolean indicating whether the icon should be disabled.
+     */
+    disabled?: boolean;
+};
+
 /**
  * Event detail for datasource initialization
  */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/grid-pro",
   "description": "Genesis Foundation AG Grid",
-  "version": "14.408.0",
+  "version": "14.409.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -40,20 +40,20 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.408.0",
-    "@genesislcap/genx": "14.408.0",
-    "@genesislcap/rollup-builder": "14.408.0",
-    "@genesislcap/ts-builder": "14.408.0",
-    "@genesislcap/uvu-playwright-builder": "14.408.0",
-    "@genesislcap/vite-builder": "14.408.0",
-    "@genesislcap/webpack-builder": "14.408.0"
+    "@genesislcap/foundation-testing": "14.409.0",
+    "@genesislcap/genx": "14.409.0",
+    "@genesislcap/rollup-builder": "14.409.0",
+    "@genesislcap/ts-builder": "14.409.0",
+    "@genesislcap/uvu-playwright-builder": "14.409.0",
+    "@genesislcap/vite-builder": "14.409.0",
+    "@genesislcap/webpack-builder": "14.409.0"
   },
   "dependencies": {
-    "@genesislcap/foundation-comms": "14.408.0",
-    "@genesislcap/foundation-criteria": "14.408.0",
-    "@genesislcap/foundation-logger": "14.408.0",
-    "@genesislcap/foundation-ui": "14.408.0",
-    "@genesislcap/foundation-utils": "14.408.0",
+    "@genesislcap/foundation-comms": "14.409.0",
+    "@genesislcap/foundation-criteria": "14.409.0",
+    "@genesislcap/foundation-logger": "14.409.0",
+    "@genesislcap/foundation-ui": "14.409.0",
+    "@genesislcap/foundation-utils": "14.409.0",
     "@microsoft/fast-colors": "5.3.1",
     "@microsoft/fast-components": "2.30.6",
     "@microsoft/fast-element": "1.14.0",
@@ -80,5 +80,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "26b08831fd001b4ee95c8a0d3364a18c0ec4005b"
+  "gitHead": "cbe0459d170f27c35a7de18cec415947aedf4da5"
 }

package/docs/api/grid-pro.actionheightmultiplier.md

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [actionHeightMultiplier](./grid-pro.actionheightmultiplier.md)
-
-## actionHeightMultiplier variable
-
-The base height multiplier for the action renderer.
-
-**Signature:**
-
-```typescript
-actionHeightMultiplier: import("@microsoft/fast-foundation").CSSDesignToken<string>
-```
-
-## Remarks
-
-Results in `--action-height-multiplier`<!-- -->. This is a DesignToken [https://www.fast.design/docs/design-systems/design-tokens/\#what-is-a-design-token](https://www.fast.design/docs/design-systems/design-tokens/#what-is-a-design-token) value. Defaults to `0.6px`<!-- -->. May have other values depending on the design system or can be set to a different value.
-

package/docs/api/grid-pro.actionrenderer.clickhandler.md

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [ActionRenderer](./grid-pro.actionrenderer.md) &gt; [clickHandler](./grid-pro.actionrenderer.clickhandler.md)
-
-## ActionRenderer.clickHandler() method
-
-**Signature:**
-
-```typescript
-clickHandler(): Promise<void>;
-```
-**Returns:**
-
-Promise&lt;void&gt;
-

package/docs/api/grid-pro.actionrenderer.datatestid.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [ActionRenderer](./grid-pro.actionrenderer.md) &gt; [dataTestId](./grid-pro.actionrenderer.datatestid.md)
-
-## ActionRenderer.dataTestId property
-
-**Signature:**
-
-```typescript
-get dataTestId(): string;
-```

package/docs/api/grid-pro.actionrenderer.getgui.md

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [ActionRenderer](./grid-pro.actionrenderer.md) &gt; [getGui](./grid-pro.actionrenderer.getgui.md)
-
-## ActionRenderer.getGui() method
-
-**Signature:**
-
-```typescript
-getGui(): HTMLElement;
-```
-**Returns:**
-
-HTMLElement
-

package/docs/api/grid-pro.actionrenderer.init.md

@@ -1,50 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [ActionRenderer](./grid-pro.actionrenderer.md) &gt; [init](./grid-pro.actionrenderer.init.md)
-
-## ActionRenderer.init() method
-
-**Signature:**
-
-```typescript
-init(params: ICellRendererParams & ActionRendererParams): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-params
-
-
-</td><td>
-
-ICellRendererParams &amp; [ActionRendererParams](./grid-pro.actionrendererparams.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-

package/docs/api/grid-pro.actionrenderer.isdisabled.md

@@ -1,50 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [ActionRenderer](./grid-pro.actionrenderer.md) &gt; [isDisabled](./grid-pro.actionrenderer.isdisabled.md)
-
-## ActionRenderer.isDisabled() method
-
-**Signature:**
-
-```typescript
-isDisabled(data: any): boolean;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-data
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-boolean
-

package/docs/api/grid-pro.actionrenderer.md

@@ -1,175 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [ActionRenderer](./grid-pro.actionrenderer.md)
-
-## ActionRenderer class
-
-The AG Action Renderer element.
-
-**Signature:**
-
-```typescript
-export declare class ActionRenderer extends FoundationElement implements ICellRendererComp 
-```
-**Extends:** FoundationElement
-
-**Implements:** ICellRendererComp
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[dataTestId](./grid-pro.actionrenderer.datatestid.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[params](./grid-pro.actionrenderer.params.md)
-
-
-</td><td>
-
-
-</td><td>
-
-ICellRendererParams &amp; [ActionRendererParams](./grid-pro.actionrendererparams.md)
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[pendingAction](./grid-pro.actionrenderer.pendingaction.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[clickHandler()](./grid-pro.actionrenderer.clickhandler.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[getGui()](./grid-pro.actionrenderer.getgui.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[init(params)](./grid-pro.actionrenderer.init.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[isDisabled(data)](./grid-pro.actionrenderer.isdisabled.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[refresh(params)](./grid-pro.actionrenderer.refresh.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/grid-pro.actionrenderer.params.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [ActionRenderer](./grid-pro.actionrenderer.md) &gt; [params](./grid-pro.actionrenderer.params.md)
-
-## ActionRenderer.params property
-
-**Signature:**
-
-```typescript
-params: ICellRendererParams & ActionRendererParams;
-```

package/docs/api/grid-pro.actionrenderer.pendingaction.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [ActionRenderer](./grid-pro.actionrenderer.md) &gt; [pendingAction](./grid-pro.actionrenderer.pendingaction.md)
-
-## ActionRenderer.pendingAction property
-
-**Signature:**
-
-```typescript
-pendingAction: boolean;
-```

package/docs/api/grid-pro.actionrenderer.refresh.md

@@ -1,50 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [ActionRenderer](./grid-pro.actionrenderer.md) &gt; [refresh](./grid-pro.actionrenderer.refresh.md)
-
-## ActionRenderer.refresh() method
-
-**Signature:**
-
-```typescript
-refresh(params: ICellRendererParams): boolean;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-params
-
-
-</td><td>
-
-ICellRendererParams
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-boolean
-