@genesislcap/grid-pro 14.408.0-icon-renderer.4 → 14.409.0

package/dist/dts/cell-renderers/icon.renderer.d.ts

@@ -5,14 +5,10 @@ import { FoundationElement } from '@microsoft/fast-foundation';
  * @public
  */
 export declare const agIconRendererStyles: import("@microsoft/fast-element").ElementStyles;
-/**
- * Parameters for the {@link @genesislcap/grid-pro#GridPro} icon renderer.
- * @public
- */
-export type IconRendererParams = ICellRendererParams & ({
+type IconByNameParams = {
     /**
      * The name of the icon to display.
-     * @remarks Used when rendering an icon element (e.g., 'trash', 'edit', 'check').
+     * @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;
     /**
@@ -20,7 +16,8 @@ export type IconRendererParams = ICellRendererParams & ({
      * @remarks Size values depend on the design system (e.g., 'xs', 'sm', 'md', 'lg').
      */
     iconSize: string;
-} | {
+};
+type IconBySrcParams = {
     /**
      * The source URL of an image icon to display.
      * @remarks Used when rendering an image instead of an icon element.
@@ -31,7 +28,12 @@ export type IconRendererParams = ICellRendererParams & ({
      * @remarks Used when iconSrc is provided. Defaults to '14px'.
      */
     iconHeight: string;
-}) & {
+};
+/**
+ * Parameters for the {@link @genesislcap/grid-pro#GridPro} icon renderer.
+ * @public
+ */
+export type IconRendererParams = ICellRendererParams & (IconByNameParams | IconBySrcParams) & {
     /**
      * The color of the icon.
      * @remarks Can be a CSS color value (e.g., '#FF0000', 'red', 'var(--accent-foreground)').
@@ -106,4 +108,5 @@ export declare const foundationIconRenderer: (overrideDefinition?: import("@micr
     template: import("@microsoft/fast-element").ViewTemplate<IconRenderer, any>;
     styles: import("@microsoft/fast-element").ElementStyles;
 }, typeof IconRenderer>;
+export {};
 //# sourceMappingURL=icon.renderer.d.ts.map

package/dist/dts/cell-renderers/icon.renderer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"icon.renderer.d.ts","sourceRoot":"","sources":["../../../src/cell-renderers/icon.renderer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAEjF,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAG/D;;;GAGG;AACH,eAAO,MAAM,oBAAoB,iDAyChC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,mBAAmB,GAClD,CACI;IACE;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,GACD;IACE;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB,CACJ,GAAG;IACF;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,KAAK,IAAI,CAAC;IAEpD;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AA4BJ;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,GAAI,eAAc,MAAgB,sEAuDrE,CAAC;AAEF;;;;;GAKG;AACH,qBAAa,YAAa,SAAQ,iBAAkB,YAAW,iBAAiB;IAC3D,MAAM,EAAE,kBAAkB,CAAC;IAGvC,IAAI,CAAC,MAAM,EAAE,kBAAkB,GAAG,mBAAmB;IAIrD,MAAM,IAAI,WAAW;IAI5B,OAAO,CAAC,MAAM,KAAA;IAKd,OAAO,IAAI,IAAI;CAChB;AAED;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;uBAIjC,CAAC"}
+{"version":3,"file":"icon.renderer.d.ts","sourceRoot":"","sources":["../../../src/cell-renderers/icon.renderer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAEjF,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAG/D;;;GAGG;AACH,eAAO,MAAM,oBAAoB,iDAyChC,CAAC;AAEF,KAAK,gBAAgB,GAAG;IACtB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,KAAK,eAAe,GAAG;IACrB;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,mBAAmB,GAClD,CAAC,gBAAgB,GAAG,eAAe,CAAC,GAAG;IACrC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,KAAK,IAAI,CAAC;IAEpD;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAkBJ;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,GAAI,eAAc,MAAgB,sEAuDrE,CAAC;AAEF;;;;;GAKG;AACH,qBAAa,YAAa,SAAQ,iBAAkB,YAAW,iBAAiB;IAC3D,MAAM,EAAE,kBAAkB,CAAC;IAGvC,IAAI,CAAC,MAAM,EAAE,kBAAkB,GAAG,mBAAmB;IAIrD,MAAM,IAAI,WAAW;IAI5B,OAAO,CAAC,MAAM,KAAA;IAKd,OAAO,IAAI,IAAI;CAChB;AAED;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;uBAIjC,CAAC"}

package/dist/grid-pro.api.json

@@ -21999,7 +21999,25 @@
             },
             {
               "kind": "Content",
-              "text": " & ({\n    iconName: string;\n    iconSize: string;\n} | {\n    iconSrc: string;\n    iconHeight: string;\n}) & {\n    iconColor?: string;\n    variant?: string;\n    clickHandler?: (event: "
+              "text": " & ("
+            },
+            {
+              "kind": "Reference",
+              "text": "IconByNameParams",
+              "canonicalReference": "@genesislcap/grid-pro!~IconByNameParams:type"
+            },
+            {
+              "kind": "Content",
+              "text": " | "
+            },
+            {
+              "kind": "Reference",
+              "text": "IconBySrcParams",
+              "canonicalReference": "@genesislcap/grid-pro!~IconBySrcParams:type"
+            },
+            {
+              "kind": "Content",
+              "text": ") & {\n    iconColor?: string;\n    variant?: string;\n    clickHandler?: (event: "
             },
             {
               "kind": "Reference",
@@ -22020,7 +22038,7 @@
           "name": "IconRendererParams",
           "typeTokenRange": {
             "startIndex": 1,
-            "endIndex": 5
+            "endIndex": 9
           }
         },
         {

package/dist/grid-pro.d.ts

@@ -5443,28 +5443,10 @@ export declare type GrigProGenesisDatasourceSizeChangedEventDetail = {
     oldValue: number;
 };
 
-/**
- * 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 & ({
+declare type IconByNameParams = {
     /**
      * The name of the icon to display.
-     * @remarks Used when rendering an icon element (e.g., 'trash', 'edit', 'check').
+     * @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;
     /**
@@ -5472,7 +5454,9 @@ export declare type IconRendererParams = ICellRendererParams & ({
      * @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.
@@ -5483,7 +5467,27 @@ export declare type IconRendererParams = ICellRendererParams & ({
      * @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)').

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/grid-pro",
   "description": "Genesis Foundation AG Grid",
-  "version": "14.408.0-icon-renderer.4",
+  "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-icon-renderer.4",
-    "@genesislcap/genx": "14.408.0-icon-renderer.4",
-    "@genesislcap/rollup-builder": "14.408.0-icon-renderer.4",
-    "@genesislcap/ts-builder": "14.408.0-icon-renderer.4",
-    "@genesislcap/uvu-playwright-builder": "14.408.0-icon-renderer.4",
-    "@genesislcap/vite-builder": "14.408.0-icon-renderer.4",
-    "@genesislcap/webpack-builder": "14.408.0-icon-renderer.4"
+    "@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-icon-renderer.4",
-    "@genesislcap/foundation-criteria": "14.408.0-icon-renderer.4",
-    "@genesislcap/foundation-logger": "14.408.0-icon-renderer.4",
-    "@genesislcap/foundation-ui": "14.408.0-icon-renderer.4",
-    "@genesislcap/foundation-utils": "14.408.0-icon-renderer.4",
+    "@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": "b65e64c93f7e1cc6d5392ce633cb5f01372cd686"
+  "gitHead": "cbe0459d170f27c35a7de18cec415947aedf4da5"
 }