@genesislcap/grid-pro 14.18.0 → 14.19.0

package/dist/dts/external/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/external/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAC;AACxE,OAAO,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAC;AACxE,OAAO,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAC;AAE5E,cAAc,SAAS,CAAC;AAExB,eAAO,MAAM,qBAAqB,iDAMjC,CAAC;AAEF,OAAO,EACL,SAAS,EACT,SAAS,EACT,uBAAuB,EACvB,uBAAuB,EACvB,yBAAyB,GAC1B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/external/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAC;AACxE,OAAO,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAC;AACxE,OAAO,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAC;AAE5E,cAAc,SAAS,CAAC;AAExB;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,iDAMjC,CAAC;AAEF;;;GAGG;AACH,OAAO,EACL,SAAS,EACT,SAAS,EACT,uBAAuB,EACvB,uBAAuB,EACvB,yBAAyB,GAC1B,CAAC"}

package/dist/dts/grid-components.d.ts

@@ -1,4 +1,9 @@
 import type { Container } from '@microsoft/fast-foundation';
+/**
+ * The Grid Pro Components.
+ * @remarks Contains all available components, from Grid Pro itself to the cell renderers.
+ * @public
+ */
 export declare const foundationGridComponents: {
     foundationGridProActionRenderer: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
         baseName: string;
@@ -28,12 +33,21 @@ export declare const foundationGridComponents: {
     foundationAgTextRenderer: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
         baseName: string;
         styles: import("@microsoft/fast-element").ElementStyles;
-        template: import("@microsoft/fast-element").ViewTemplate<import("./cell-renderers").AgTextRenderer, any>;
+        template: import("@microsoft/fast-element").ViewTemplate<import("./cell-renderers").AgTextFieldRenderer, any>;
     }>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
         baseName: string;
         styles: import("@microsoft/fast-element").ElementStyles;
-        template: import("@microsoft/fast-element").ViewTemplate<import("./cell-renderers").AgTextRenderer, any>;
+        template: import("@microsoft/fast-element").ViewTemplate<import("./cell-renderers").AgTextFieldRenderer, any>;
     }, typeof import("./cell-renderers").AgTextRenderer>;
+    foundationAgTextFieldRenderer: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
+        baseName: string;
+        styles: import("@microsoft/fast-element").ElementStyles;
+        template: import("@microsoft/fast-element").ViewTemplate<import("./cell-renderers").AgTextFieldRenderer, any>;
+    }>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
+        baseName: string;
+        styles: import("@microsoft/fast-element").ElementStyles;
+        template: import("@microsoft/fast-element").ViewTemplate<import("./cell-renderers").AgTextFieldRenderer, any>;
+    }, typeof import("./cell-renderers").AgTextFieldRenderer>;
     foundationAgSelectRenderer: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
         baseName: string;
         styles: import("@microsoft/fast-element").ElementStyles;

package/dist/dts/grid-components.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"grid-components.d.ts","sourceRoot":"","sources":["../../src/grid-components.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAU5D,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yBAOd,SAAS,WAAW,GAAG,EAAE;CAa/C,CAAC"}
+{"version":3,"file":"grid-components.d.ts","sourceRoot":"","sources":["../../src/grid-components.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAW5D;;;;GAIG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yBAQd,SAAS,WAAW,GAAG,EAAE;CAa/C,CAAC"}

package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts

@@ -369,9 +369,12 @@ export declare class GridProGenesisDatasource extends GridProGenesisDatasource_b
     deepClone(): Node;
     private get agGrid();
     init(): void;
+    /**
+     * @public
+     */
     deinit(): void;
     /**
-     * Use {@link deinit} instead
+     * Use {@link @genesislcap/grid-pro#GridProGenesisDatasource#deinit} instead
      * @deprecated
      */
     reset(): void;

package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"grid-pro-genesis-datasource.d.ts","sourceRoot":"","sources":["../../../src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,WAAW,EAAsB,MAAM,yBAAyB,CAAC;AAClF,OAAO,EACL,OAAO,EAEP,UAAU,EAWX,MAAM,+BAA+B,CAAC;AAGvC,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiB/D,qBAGa,wBAAyB,SAAQ,6BAAiC;IACpE,OAAO,EAAG,OAAO,CAAC;IACf,UAAU,EAAG,UAAU,CAAC;IAExB,mBAAmB,EAAE,WAAW,CAAC;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACgC,UAAU,UAAS;IACvC,OAAO,EAAE,MAAM,CAAmC;IAClD,OAAO,EAAE,MAAM,CAAoC;IAC/B,UAAU,UAAS;IACvC,OAAO,EAAE,MAAM,CAAC;IACrC,OAAO,EAAE,GAAG,CAAC;IACa,YAAY,EAAE,MAAM,CAAC;IAC3D,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAK3B,OAAO,UAAS;IACZ,KAAK,SAAa;IACgB,qBAAqB,UAAS;IAE/F,OAAO,CAAC,OAAO,CAAe;IAC9B,OAAO,CAAC,SAAS,CAAe;IAChC,OAAO,CAAC,aAAa,CAAe;IAEpC,OAAO,CAAC,6BAA6B,CAAQ;IAC7C,OAAO,CAAC,mBAAmB,CAAS;IAEpC,OAAO,CAAC,IAAI,CAA+B;IAC3C,OAAO,CAAC,aAAa,CAAqB;IAE1C,OAAO,CAAC,SAAS,CAAS;IAE1B,OAAO,CAAC,mBAAmB,CAAkC;IAC7D,OAAO,CAAC,MAAM,CAAwE;IAEtF,iBAAiB;IAsBjB,oBAAoB;IAQX,SAAS,IAAI,IAAI;IAO1B,OAAO,KAAK,MAAM,GAEjB;IAGD,IAAI;IAkCJ,MAAM;IAIN;;;OAGG;IACH,KAAK;IA8BL,OAAO;IAKP,OAAO,CAAC,YAAY;IAMpB,OAAO,CAAC,aAAa;YAUP,gBAAgB;IAiD9B,OAAO,CAAC,cAAc;IActB,OAAO,CAAC,iBAAiB;IAezB,OAAO,CAAC,kBAAkB;IAY1B,OAAO,CAAC,sBAAsB;IAmC9B,OAAO,CAAC,mBAAmB;IAqB3B,OAAO,CAAC,mBAAmB;IAgB3B,OAAO,CAAC,mBAAmB;IAO3B,OAAO,CAAC,mBAAmB;IAW3B,OAAO,CAAC,eAAe;IA0CvB,OAAO,CAAC,aAAa;IAMrB,eAAe,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;IASjD,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;IAK9C,YAAY,CAAC,SAAS,EAAE,MAAM;CAItC"}
+{"version":3,"file":"grid-pro-genesis-datasource.d.ts","sourceRoot":"","sources":["../../../src/grid-pro-genesis-datasource/grid-pro-genesis-datasource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,WAAW,EAAsB,MAAM,yBAAyB,CAAC;AAClF,OAAO,EACL,OAAO,EAEP,UAAU,EAWX,MAAM,+BAA+B,CAAC;AAGvC,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiB/D,qBAGa,wBAAyB,SAAQ,6BAAiC;IACpE,OAAO,EAAG,OAAO,CAAC;IACf,UAAU,EAAG,UAAU,CAAC;IAExB,mBAAmB,EAAE,WAAW,CAAC;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACgC,UAAU,UAAS;IACvC,OAAO,EAAE,MAAM,CAAmC;IAClD,OAAO,EAAE,MAAM,CAAoC;IAC/B,UAAU,UAAS;IACvC,OAAO,EAAE,MAAM,CAAC;IACrC,OAAO,EAAE,GAAG,CAAC;IACa,YAAY,EAAE,MAAM,CAAC;IAC3D,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAK3B,OAAO,UAAS;IACZ,KAAK,SAAa;IACgB,qBAAqB,UAAS;IAE/F,OAAO,CAAC,OAAO,CAAe;IAC9B,OAAO,CAAC,SAAS,CAAe;IAChC,OAAO,CAAC,aAAa,CAAe;IAEpC,OAAO,CAAC,6BAA6B,CAAQ;IAC7C,OAAO,CAAC,mBAAmB,CAAS;IAEpC,OAAO,CAAC,IAAI,CAA+B;IAC3C,OAAO,CAAC,aAAa,CAAqB;IAE1C,OAAO,CAAC,SAAS,CAAS;IAE1B,OAAO,CAAC,mBAAmB,CAAkC;IAC7D,OAAO,CAAC,MAAM,CAAwE;IAEtF,iBAAiB;IAsBjB,oBAAoB;IAQX,SAAS,IAAI,IAAI;IAO1B,OAAO,KAAK,MAAM,GAEjB;IAGD,IAAI;IAkCJ;;OAEG;IACH,MAAM;IAIN;;;OAGG;IACH,KAAK;IA8BL,OAAO;IAKP,OAAO,CAAC,YAAY;IAMpB,OAAO,CAAC,aAAa;YAUP,gBAAgB;IAiD9B,OAAO,CAAC,cAAc;IActB,OAAO,CAAC,iBAAiB;IAezB,OAAO,CAAC,kBAAkB;IAY1B,OAAO,CAAC,sBAAsB;IAmC9B,OAAO,CAAC,mBAAmB;IAqB3B,OAAO,CAAC,mBAAmB;IAgB3B,OAAO,CAAC,mBAAmB;IAO3B,OAAO,CAAC,mBAAmB;IAW3B,OAAO,CAAC,eAAe;IA0CvB,OAAO,CAAC,aAAa;IAMrB,eAAe,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;IASjD,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;IAK9C,YAAY,CAAC,SAAS,EAAE,MAAM;CAItC"}

package/dist/dts/grid-pro.d.ts

@@ -393,7 +393,7 @@ export declare class GridPro extends GridPro_base {
      */
     private debouncedColumnAutosize;
     /**
-     * If {@link gridAutosizingEnabled} is true, will remove the widths from the column states.
+     * If {@link @genesislcap/grid-pro#GridPro#gridAutosizingEnabled} is true, will remove the widths from the column states.
      * @internal
      */
     private removeConfigWidthsToAutosize;

package/dist/dts/grid-pro.definitions.d.ts

@@ -1,9 +1,49 @@
 import { ValueFormatterParams } from '@ag-grid-community/core';
+/**
+ * Returns a filter type based on the Grid Pro field/column type.
+ * @param type - The type of the field/column
+ * @returns The ag-grid filter type
+ * @remarks Currently only returns agTextColumnFilter
+ * @alpha
+ */
 export declare function getFilterByFieldType(type: string): any;
+/**
+ * Return a column type base on each field's metadata from the selected resource.
+ * @param metadataType - The type of the field/column
+ * @returns the column type
+ * @remarks Currently only handles numeric columns
+ * @alpha
+ */
 export declare function getColumnType(metadataType: string): any;
+/**
+ * Returns the filter params based on the Grid Pro field/column type.
+ * @param type - The type of the field/column
+ * @returns the filter params for the specified field type
+ * @remarks Currently only returns a default filter params object, for all field types
+ * @alpha
+ */
 export declare function getFilterParamsByFieldType(type: string): any;
+/**
+ * Returns a formatted date value from the Grid Pro cell value.
+ * @param param - A ValueFormatterParams object.
+ * @returns A formatted date value.
+ * @public
+ */
 export declare function dateValueFormatter({ value }: ValueFormatterParams): any;
+/**
+ * Returns a formatted date time value from the Grid Pro cell value.
+ * @param param - A ValueFormatterParams object.
+ * @returns A formatted date time value.
+ * @public
+ */
 export declare function dateTimeValueFormatter({ value }: ValueFormatterParams): any;
+/**
+ * Returns a formatted date value from an epoch number.
+ * @param epoch - A number representing the number of milliseconds since the Unix epoch (1 January 1970 00:00:00 UTC).
+ * @returns A formatted date value.
+ * @alpha
+ * @deprecated No longer used in the Grid Pro package.
+ */
 export declare function formatDateExtra(epoch: number): string;
 /**
  * The time between allowing the grids to automatically resize.

package/dist/dts/grid-pro.definitions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"grid-pro.definitions.d.ts","sourceRoot":"","sources":["../../src/grid-pro.definitions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAG/D,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CActD;AAED,wBAAgB,aAAa,CAAC,YAAY,EAAE,MAAM,GAAG,GAAG,CASvD;AAED,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAwC5D;AAED,wBAAgB,kBAAkB,CAAC,EAAE,KAAK,EAAE,EAAE,oBAAoB,GAAG,GAAG,CAEvE;AAED,wBAAgB,sBAAsB,CAAC,EAAE,KAAK,EAAE,EAAE,oBAAoB,GAAG,GAAG,CAE3E;AAID,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAMrD;AAED;;;GAGG;AACH,eAAO,MAAM,qBAAqB,IAAI,CAAC"}
+{"version":3,"file":"grid-pro.definitions.d.ts","sourceRoot":"","sources":["../../src/grid-pro.definitions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAG/D;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CActD;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,YAAY,EAAE,MAAM,GAAG,GAAG,CASvD;AAED;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAwC5D;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,EAAE,KAAK,EAAE,EAAE,oBAAoB,GAAG,GAAG,CAEvE;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,EAAE,KAAK,EAAE,EAAE,oBAAoB,GAAG,GAAG,CAE3E;AAKD;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAMrD;AAED;;;GAGG;AACH,eAAO,MAAM,qBAAqB,IAAI,CAAC"}

package/dist/dts/grid-pro.styles.d.ts

@@ -1,3 +1,8 @@
 import type { ElementStyles } from '@microsoft/fast-element';
+/**
+ * The Grid Pro styles.
+ * @public
+ * @remarks this is the default CSS, bundles Alpine/Balham/Material AG themes.
+ */
 export declare const foundationGridProStyles: ElementStyles;
 //# sourceMappingURL=grid-pro.styles.d.ts.map

package/dist/dts/grid-pro.styles.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"grid-pro.styles.d.ts","sourceRoot":"","sources":["../../src/grid-pro.styles.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAG7D,eAAO,MAAM,uBAAuB,EAAE,aA4BrC,CAAC"}
+{"version":3,"file":"grid-pro.styles.d.ts","sourceRoot":"","sources":["../../src/grid-pro.styles.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAG7D;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,EAAE,aA4BrC,CAAC"}

package/dist/dts/grid-pro.template.d.ts

@@ -1,3 +1,7 @@
 import type { ViewTemplate } from '@microsoft/fast-element';
+/**
+ * The Grid Pro Template.
+ * @public
+ */
 export declare const gridProTemplate: ViewTemplate;
 //# sourceMappingURL=grid-pro.template.d.ts.map

package/dist/dts/grid-pro.template.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"grid-pro.template.d.ts","sourceRoot":"","sources":["../../src/grid-pro.template.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAG5D,eAAO,MAAM,eAAe,EAAE,YAO7B,CAAC"}
+{"version":3,"file":"grid-pro.template.d.ts","sourceRoot":"","sources":["../../src/grid-pro.template.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAG5D;;;GAGG;AACH,eAAO,MAAM,eAAe,EAAE,YAO7B,CAAC"}

package/dist/dts/grid-pro.types.d.ts

@@ -1,4 +1,8 @@
 import { CSSVarTokenMap } from '@genesislcap/foundation-ui';
+/**
+ * All official AG CSS variables
+ * @public
+ */
 export declare enum AgGridCSSVars {
     foregroundColor = "--ag-foreground-color",
     dataColor = "--ag-data-color",
@@ -45,6 +49,10 @@ export declare enum AgGridCSSVars {
     inputFocusBoxShadow = "--ag-input-focus-box-shadow",
     inputFocusBorderColor = "--ag-input-focus-border-color"
 }
+/**
+ * The available Grid Pro themes.
+ * @public
+ */
 export declare enum AgGridTheme {
     alpine = "ag-theme-alpine",
     alpineDark = "ag-theme-alpine-dark",
@@ -52,12 +60,66 @@ export declare enum AgGridTheme {
     balhamDark = "ag-theme-balham-dark",
     material = "ag-theme-material"
 }
+/**
+ * Generates the class name for a given Grid Pro theme name.
+ * @param themeName - the Grid Pro theme name
+ * @returns the class name for the Grid Pro token map
+ * @public
+ * @example The result of this will be a class name that is applied to the grid part of GridPro template (actual content of the class comes from agThemeTokenMapCSS):
+ * ```html
+ * <span part="grid" class="ag-theme-genesis-rapid-dark">
+ * ```
+ */
 export declare const agThemeTokenMapClassname: (themeName: string) => string;
+/**
+ * Generates the id name for custom Grid Pro fonts.
+ * @param themeName - the Grid Pro theme name
+ * @returns the id name for the Grid Pro fonts
+ * @public
+ * @example The result of this is used in the id of style tag:
+ * ```html
+ * <style id="ag-theme-alpine-fonts"></style>
+ * ```
+ */
 export declare const agThemeFontsId: (themeName: string) => string;
+/**
+ * Generates the CSS for a given GridPro theme name and token map
+ * @param themeName - the GridPro theme name
+ * @param tokenMap - a map of CSS variables {@link @genesislcap/grid-pro#AgGridCSSVars} and custom token values
+ * @returns the CSS for the Grid Pro token map
+ * @public
+ * @example
+ * ```ts
+ * export const agThemeGenesisRapidTokens = {
+ *  backgroundColor: create<Swatch>('rapid-ag-background-color').withDefault((elem: HTMLElement) =>
+ *    baseLayerLuminance.getValueFor(elem) === StandardLuminance.LightMode
+ *      ? lightColors.backgroundSwatch
+ *      : darkColors.backgroundSwatch
+ *  ),
+ *  foregroundColor: create<Swatch>('rapid-ag-foreground-color').withDefault((elem: HTMLElement) =>
+ *    baseLayerLuminance.getValueFor(elem) === StandardLuminance.LightMode
+ *      ? lightColors.foregroundSwatch
+ *      : darkColors.foregroundSwatch
+ *  ),
+ * };
+ * export const agThemeGenesisRapidTokenMap: CSSVarTokenMap<AgGridCSSVars | string> = {
+ *  [AgGridCSSVars.backgroundColor]: agThemeGenesisRapidTokens.backgroundColor,
+ *  [AgGridCSSVars.foregroundColor]: agThemeGenesisRapidTokens.foregroundColor,
+ * };
+ * ```
+ */
 export declare const agThemeTokenMapCSS: (themeName: string, tokenMap: CSSVarTokenMap<any>) => import("@microsoft/fast-element").ElementStyles;
+/**
+ * Grid Pro Components type, used to define the custom components that will be registered in the grid
+ * @public
+ */
 export type GridComponents = {
     [componentName: string]: any;
 };
+/**
+ * The available Grid Pro Renderer Types
+ * @public
+ */
 export declare enum GridProRendererTypes {
     action = "action",
     actionsMenu = "actionsMenu",

package/dist/dts/grid-pro.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"grid-pro.types.d.ts","sourceRoot":"","sources":["../../src/grid-pro.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAGhF,oBAAY,aAAa;IACvB,eAAe,0BAA0B;IACzC,SAAS,oBAAoB;IAC7B,wBAAwB,oCAAoC;IAC5D,qBAAqB,iCAAiC;IACtD,uBAAuB,mCAAmC;IAC1D,eAAe,0BAA0B;IACzC,qBAAqB,iCAAiC;IACtD,wBAAwB,oCAAoC;IAC5D,+BAA+B,4CAA4C;IAC3E,2BAA2B,wCAAwC;IACnE,0BAA0B,uCAAuC;IACjE,qBAAqB,kCAAkC;IACvD,aAAa,yBAAyB;IACtC,yBAAyB,sCAAsC;IAC/D,6BAA6B,0CAA0C;IACvE,yBAAyB,sCAAsC;IAC/D,0CAA0C,yDAAyD;IACnG,kCAAkC,gDAAgD;IAClF,8BAA8B,4CAA4C;IAC1E,+BAA+B,6CAA6C;IAC5E,mBAAmB,+BAA+B;IAClD,WAAW,sBAAsB;IACjC,oBAAoB,gCAAgC;IACpD,cAAc,0BAA0B;IACxC,0BAA0B,uCAAuC;IACjE,6BAA6B,2CAA2C;IACxE,gBAAgB,4BAA4B;IAC5C,wBAAwB,qCAAqC;IAC7D,4BAA4B,yCAAyC;IACrE,uBAAuB,mCAAmC;IAC1D,oBAAoB,gCAAgC;IACpD,sBAAsB,kCAAkC;IACxD,0BAA0B,sCAAsC;IAChE,0BAA0B,wCAAwC;IAClE,8BAA8B,4CAA4C;IAC1E,yBAAyB,uCAAuC;IAChE,6BAA6B,2CAA2C;IACxE,iCAAiC,+CAA+C;IAChF,6BAA6B,2CAA2C;IACxE,2BAA2B,wCAAwC;IACnE,0BAA0B,uCAAuC;IACjE,2BAA2B,wCAAwC;IACnE,mBAAmB,gCAAgC;IACnD,qBAAqB,kCAAkC;CACxD;AAED,oBAAY,WAAW;IACrB,MAAM,oBAAoB;IAC1B,UAAU,yBAAyB;IACnC,MAAM,oBAAoB;IAC1B,UAAU,yBAAyB;IACnC,QAAQ,sBAAsB;CAC/B;AAED,eAAO,MAAM,wBAAwB,cAAe,MAAM,WAA6B,CAAC;AACxF,eAAO,MAAM,cAAc,cAAe,MAAM,WAAyB,CAAC;AAE1E,eAAO,MAAM,kBAAkB,cAAe,MAAM,YAAY,eAAe,GAAG,CAAC,oDAIlF,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAAE,CAAC,aAAa,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,CAAC;AAE9D,oBAAY,oBAAoB;IAC9B,MAAM,WAAW;IACjB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,MAAM,WAAW;CAClB"}
+{"version":3,"file":"grid-pro.types.d.ts","sourceRoot":"","sources":["../../src/grid-pro.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAGhF;;;GAGG;AACH,oBAAY,aAAa;IACvB,eAAe,0BAA0B;IACzC,SAAS,oBAAoB;IAC7B,wBAAwB,oCAAoC;IAC5D,qBAAqB,iCAAiC;IACtD,uBAAuB,mCAAmC;IAC1D,eAAe,0BAA0B;IACzC,qBAAqB,iCAAiC;IACtD,wBAAwB,oCAAoC;IAC5D,+BAA+B,4CAA4C;IAC3E,2BAA2B,wCAAwC;IACnE,0BAA0B,uCAAuC;IACjE,qBAAqB,kCAAkC;IACvD,aAAa,yBAAyB;IACtC,yBAAyB,sCAAsC;IAC/D,6BAA6B,0CAA0C;IACvE,yBAAyB,sCAAsC;IAC/D,0CAA0C,yDAAyD;IACnG,kCAAkC,gDAAgD;IAClF,8BAA8B,4CAA4C;IAC1E,+BAA+B,6CAA6C;IAC5E,mBAAmB,+BAA+B;IAClD,WAAW,sBAAsB;IACjC,oBAAoB,gCAAgC;IACpD,cAAc,0BAA0B;IACxC,0BAA0B,uCAAuC;IACjE,6BAA6B,2CAA2C;IACxE,gBAAgB,4BAA4B;IAC5C,wBAAwB,qCAAqC;IAC7D,4BAA4B,yCAAyC;IACrE,uBAAuB,mCAAmC;IAC1D,oBAAoB,gCAAgC;IACpD,sBAAsB,kCAAkC;IACxD,0BAA0B,sCAAsC;IAChE,0BAA0B,wCAAwC;IAClE,8BAA8B,4CAA4C;IAC1E,yBAAyB,uCAAuC;IAChE,6BAA6B,2CAA2C;IACxE,iCAAiC,+CAA+C;IAChF,6BAA6B,2CAA2C;IACxE,2BAA2B,wCAAwC;IACnE,0BAA0B,uCAAuC;IACjE,2BAA2B,wCAAwC;IACnE,mBAAmB,gCAAgC;IACnD,qBAAqB,kCAAkC;CACxD;AAED;;;GAGG;AACH,oBAAY,WAAW;IACrB,MAAM,oBAAoB;IAC1B,UAAU,yBAAyB;IACnC,MAAM,oBAAoB;IAC1B,UAAU,yBAAyB;IACnC,QAAQ,sBAAsB;CAC/B;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,wBAAwB,cAAe,MAAM,WAA6B,CAAC;AAExF;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc,cAAe,MAAM,WAAyB,CAAC;AAE1E;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,kBAAkB,cAAe,MAAM,YAAY,eAAe,GAAG,CAAC,oDAIlF,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAAE,CAAC,aAAa,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,CAAC;AAE9D;;;GAGG;AACH,oBAAY,oBAAoB;IAC9B,MAAM,WAAW;IACjB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,MAAM,WAAW;CAClB"}

package/dist/dts/index.d.ts

@@ -1,3 +1,7 @@
+import * as AgcCore from '@ag-grid-community/core';
+import * as AgcCsvExport from '@ag-grid-community/csv-export';
+import * as AgeCore from '@ag-grid-enterprise/core';
+import * as AgeExcelExport from '@ag-grid-enterprise/excel-export';
 export * from './grid-pro.definitions';
 export * from './grid-pro.styles';
 export * from './grid-pro.template';
@@ -11,10 +15,28 @@ export * from './column';
 export * from './grid-pro-genesis-datasource';
 export * from './grid-components';
 export * from './utils';
-export * as AgcCore from '@ag-grid-community/core';
+/**
+ * Re-export of entire @ag-grid-community/core
+ */
+export { AgcCore };
+/**
+ * Re-export of ClientSideRowModelModule from @ag-grid-community/client-side-row-model
+ */
 export { ClientSideRowModelModule as AgcCSRMModule } from '@ag-grid-community/client-side-row-model';
-export * as AgcCsvExport from '@ag-grid-community/csv-export';
-export * as AgeCore from '@ag-grid-enterprise/core';
+/**
+ * Re-export of entire @ag-grid-community/csv-export
+ */
+export { AgcCsvExport };
+/**
+ * Re-export of entire @ag-grid-enterprise/core
+ */
+export { AgeCore };
+/**
+ * Re-export of ServerSideRowModelModule from @ag-grid-enterprise/server-side-row-model
+ */
 export { ServerSideRowModelModule as AgeSSRMModule } from '@ag-grid-enterprise/server-side-row-model';
-export * as AgeExcelExport from '@ag-grid-enterprise/excel-export';
+/**
+ * Re-export of entire @ag-grid-enterprise/excel-export
+ */
+export { AgeExcelExport };
 //# sourceMappingURL=index.d.ts.map

package/dist/dts/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AAExB,cAAc,QAAQ,CAAC;AACvB,cAAc,kBAAkB,CAAC;AACjC,cAAc,UAAU,CAAC;AACzB,cAAc,+BAA+B,CAAC;AAE9C,cAAc,mBAAmB,CAAC;AAElC,cAAc,SAAS,CAAC;AAExB,OAAO,KAAK,OAAO,MAAM,yBAAyB,CAAC;AACnD,OAAO,EAAE,wBAAwB,IAAI,aAAa,EAAE,MAAM,0CAA0C,CAAC;AACrG,OAAO,KAAK,YAAY,MAAM,+BAA+B,CAAC;AAE9D,OAAO,KAAK,OAAO,MAAM,0BAA0B,CAAC;AACpD,OAAO,EAAE,wBAAwB,IAAI,aAAa,EAAE,MAAM,2CAA2C,CAAC;AACtG,OAAO,KAAK,cAAc,MAAM,kCAAkC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,yBAAyB,CAAC;AACnD,OAAO,KAAK,YAAY,MAAM,+BAA+B,CAAC;AAC9D,OAAO,KAAK,OAAO,MAAM,0BAA0B,CAAC;AACpD,OAAO,KAAK,cAAc,MAAM,kCAAkC,CAAC;AAEnE,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AAExB,cAAc,QAAQ,CAAC;AACvB,cAAc,kBAAkB,CAAC;AACjC,cAAc,UAAU,CAAC;AACzB,cAAc,+BAA+B,CAAC;AAE9C,cAAc,mBAAmB,CAAC;AAElC,cAAc,SAAS,CAAC;AAExB;;GAEG;AACH,OAAO,EAAE,OAAO,EAAE,CAAC;AAEnB;;GAEG;AACH,OAAO,EAAE,wBAAwB,IAAI,aAAa,EAAE,MAAM,0CAA0C,CAAC;AAErG;;GAEG;AACH,OAAO,EAAE,YAAY,EAAE,CAAC;AAExB;;GAEG;AACH,OAAO,EAAE,OAAO,EAAE,CAAC;AAEnB;;GAEG;AACH,OAAO,EAAE,wBAAwB,IAAI,aAAa,EAAE,MAAM,2CAA2C,CAAC;AAEtG;;GAEG;AACH,OAAO,EAAE,cAAc,EAAE,CAAC"}

package/dist/dts/style/colors.d.ts

@@ -1,4 +1,14 @@
 import { SwatchRGB } from '@microsoft/fast-components';
+/**
+ * The background color swatch.
+ * @deprecated - only used in the deprecated ag-theme-material theme
+ * @internal
+ */
 export declare const backgroundSwatch: SwatchRGB;
+/**
+ * The foreground color swatch.
+ * @deprecated - only used in the deprecated ag-theme-material theme
+ * @internal
+ */
 export declare const foregroundSwatch: SwatchRGB;
 //# sourceMappingURL=colors.d.ts.map

package/dist/dts/style/colors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"colors.d.ts","sourceRoot":"","sources":["../../../src/style/colors.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAEvD,eAAO,MAAM,gBAAgB,WAA8C,CAAC;AAC5E,eAAO,MAAM,gBAAgB,WAA8C,CAAC"}
+{"version":3,"file":"colors.d.ts","sourceRoot":"","sources":["../../../src/style/colors.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAEvD;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,WAA8C,CAAC;AAE5E;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,WAA8C,CAAC"}

package/dist/dts/style/tokens.d.ts

@@ -1,4 +1,9 @@
 import { Swatch } from '@microsoft/fast-components';
+/**
+ * The design tokens for the ag-theme-material theme.
+ * @deprecated - use no usage in the codebase
+ * @internal
+ */
 export declare const agThemeMaterialCustomTokens: {
     foregroundColor: import("@microsoft/fast-foundation").CSSDesignToken<Swatch>;
     backgroundColor: import("@microsoft/fast-foundation").CSSDesignToken<Swatch>;

package/dist/dts/style/tokens.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["../../../src/style/tokens.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAMpD,eAAO,MAAM,2BAA2B;;;CAGvC,CAAC"}
+{"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["../../../src/style/tokens.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAMpD;;;;GAIG;AACH,eAAO,MAAM,2BAA2B;;;CAGvC,CAAC"}

package/dist/dts/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.34.4"
+    }
+  ]
+}

package/dist/dts/utils/logger.d.ts

@@ -1,2 +1,6 @@
+/**
+ * Logger for the grid-pro package
+ * @public
+ */
 export declare const logger: import("@genesislcap/foundation-utils").Logger;
 //# sourceMappingURL=logger.d.ts.map

package/dist/dts/utils/logger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../../src/utils/logger.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,MAAM,gDAA2B,CAAC"}
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../../src/utils/logger.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,eAAO,MAAM,MAAM,gDAA2B,CAAC"}

package/dist/esm/cell/cell.js

@@ -2,6 +2,11 @@ import { __decorate } from "tslib";
 import { customElement, observable } from '@microsoft/fast-element';
 import { FoundationElement } from '@microsoft/fast-foundation';
 import { CellTemplate as template } from './cell.template';
+/**
+ * The Grid Pro Cell element.
+ * @remarks Used inside the Grid Pro Column element, to define a cell renderer from the template.
+ * @public
+ */
 let GridProCell = class GridProCell extends FoundationElement {
     connectedCallback() {
         super.connectedCallback();

package/dist/esm/cell/cell.template.js

@@ -1,4 +1,8 @@
 import { html, slotted } from '@microsoft/fast-element';
+/**
+ * The Grid Pro Cell Template.
+ * @public
+ */
 export const CellTemplate = html `
   <template>
     <slot ${slotted('slottedRenderer')} @slotchange="${(x) => x.slottedAgRendererChanged()}"></slot>

package/dist/esm/cell-renderers/action.renderer.js

@@ -3,6 +3,8 @@ import { css, html, observable } from '@microsoft/fast-element';
 import { DesignToken, FoundationElement } from '@microsoft/fast-foundation';
 import { logger } from '../utils';
 /**
+ * The AG Action Renderer element.
+ * @public
  * @tagname %%prefix%%-grid-pro-action-renderer
  */
 export class ActionRenderer extends FoundationElement {
@@ -14,7 +16,6 @@ export class ActionRenderer extends FoundationElement {
     getGui() {
         return this;
     }
-    destroy() { }
     refresh(params) {
         this.params = params;
         return true;
@@ -53,7 +54,16 @@ __decorate([
     observable
 ], ActionRenderer.prototype, "pendingAction", void 0);
 const { create } = DesignToken;
+/**
+ * The base height multiplier for the action renderer.
+ * @remarks Results in `--action-height-multiplier`. This is a DesignToken {@link 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.
+ * @public
+ */
 export const actionHeightMultiplier = create('action-height-multiplier').withDefault('0.6px');
+/**
+ * The AG Action Renderer Styles.
+ * @public
+ */
 export const agActionRendererStyles = css `
   .action-container {
     align-items: center;
@@ -71,7 +81,7 @@ export const agActionRendererStyles = css `
   }
 `;
 /**
- * The Foundation Action Renderer
+ * The Foundation Action Renderer registry.
  *
  * @public
  * @remarks

package/dist/esm/cell-renderers/actions-menu.renderer.js

@@ -3,6 +3,9 @@ import { html, observable } from '@microsoft/fast-element';
 import { FoundationElement } from '@microsoft/fast-foundation';
 import { GridProRendererTypes } from '../grid-pro.types';
 /**
+ * The Actions Menu Renderer element.
+ * @remarks For multiple actions scenarios.
+ * @public
  * @tagname %%prefix%%-grid-pro-actions-menu-renderer
  */
 export class ActionsMenuRenderer extends FoundationElement {
@@ -14,7 +17,6 @@ export class ActionsMenuRenderer extends FoundationElement {
     getGui() {
         return this;
     }
-    destroy() { }
     refresh(params) {
         return false;
     }
@@ -23,11 +25,11 @@ __decorate([
     observable
 ], ActionsMenuRenderer.prototype, "params", void 0);
 /**
- * The Foundation Actions Menu Renderer
+ * The Foundation Actions Menu Renderer registry.
  *
  * @public
  * @remarks
- * HTML Element: \<grid-pro-actions-menu-renderer\>
+ * HTML Element: \<foundation-grid-pro-actions-menu-renderer\>
  */
 export const foundationGridProActionsMenuRenderer = ActionsMenuRenderer.compose({
     baseName: 'grid-pro-actions-menu-renderer',
@@ -38,6 +40,39 @@ export const foundationGridProActionsMenuRenderer = ActionsMenuRenderer.compose(
     ></foundation-actions-menu>
   `,
 });
+/**
+ * Helper function to get ColDef {@link https://www.ag-grid.com/javascript-data-grid/column-properties/} for Actions Menu Renderer.
+ * Will take the parameter values for a base ColDef and merge them with the overrideDef (if specified).
+ * @param actions - Array of {@link @genesislcap/foundation-ui#ActionMenuItem} to be displayed in the menu.
+ * @param overrideDef - Optional override for the ColDef. Will override any of the default values. Default is an empty object.
+ * @param customActionsOpenerName - Optional custom name for the button that opens the menu. Default is '⋮'.
+ * @param isVertical - Optional flag to display the menu vertically. Default is false (displays the menu horizontally, follow the rowHeight).
+ * @param buttonAppearance - Optional appearance for the button that opens the menu. Default is 'outline'.
+ * @returns Merged ColDef (base ColDef created from the parameters + overrideDef) for Actions Menu Renderer.
+ * @example
+ * ```ts
+ * public exampleActionsMenuDef: AgcCore.ColDef = getActionsMenuDef(
+ *  [
+ *    {
+ *      name: 'View',
+ *      callback: (rowData) => logger.debug('VIEWW!!!', rowData),
+ *    },
+ *      {
+ *      name: 'Delete',
+ *      callback: (rowData) => logger.debug('DELETE!!!', rowData),
+ *    },
+ *  ],
+ *  {
+ *    headerName: 'Instrument Actions',
+ *    width: 180,
+ *  },
+ *  '+',
+ *  true,
+ *  'primary-gradient'
+ * );
+ * ```
+ * @public
+ */
 export const getActionsMenuDef = (actions, overrideDef = {}, customActionsOpenerName = '⋮', isVertical = false, buttonAppearance) => {
     const actionsMenuDef = {
         cellRenderer: GridProRendererTypes.actionsMenu,

package/dist/esm/cell-renderers/boolean.renderer.js

@@ -2,6 +2,8 @@ import { __decorate } from "tslib";
 import { css, html, observable } from '@microsoft/fast-element';
 import { FoundationElement } from '@microsoft/fast-foundation';
 /**
+ * The AG Boolean Renderer element.
+ * @public
  * @tagname %%prefix%%-boolean-renderer
  */
 export class BooleanRenderer extends FoundationElement {
@@ -21,6 +23,10 @@ export class BooleanRenderer extends FoundationElement {
 __decorate([
     observable
 ], BooleanRenderer.prototype, "params", void 0);
+/**
+ * The AG Boolean Renderer Styles.
+ * @public
+ */
 export const agBooleanRendererStyles = css `
   :host {
     align-center: center;
@@ -28,6 +34,12 @@ export const agBooleanRendererStyles = css `
     height: 100%;
   }
 `;
+/**
+ * Get a Design System prefixed Checkbox template.
+ * @param designSystem - The design system prefix to use. Defaults to 'foundation'.
+ * @returns A Checkbox component template prefixed with the correct design system.
+ * @public
+ */
 export const getAgBooleanRendererTemplate = (designSystem = 'foundation') => {
     const checkboxComponent = `${designSystem}-checkbox`;
     return html `
@@ -39,7 +51,7 @@ export const getAgBooleanRendererTemplate = (designSystem = 'foundation') => {
   `;
 };
 /**
- * The Foundation Boolean Renderer
+ * The Foundation Boolean Renderer registry.
  *
  * @public
  * @remarks

package/dist/esm/cell-renderers/index.js

@@ -2,4 +2,5 @@ export * from './action.renderer';
 export * from './actions-menu.renderer';
 export * from './boolean.renderer';
 export * from './text.renderer';
+export * from './text-field.renderer';
 export * from './select.renderer';

package/dist/esm/cell-renderers/select.renderer.js

@@ -3,6 +3,8 @@ import { css, html, observable, repeat } from '@microsoft/fast-element';
 import { FoundationElement } from '@microsoft/fast-foundation';
 import { setValueWithAccessor } from './utils';
 /**
+ * The AG Select Renderer element.
+ * @public
  * @tagname %%prefix%%-select-renderer
  */
 export class SelectRenderer extends FoundationElement {
@@ -34,6 +36,10 @@ __decorate([
 __decorate([
     observable
 ], SelectRenderer.prototype, "value", void 0);
+/**
+ * The AG Select Renderer Styles.
+ * @public
+ */
 export const agSelectRendererStyles = css `
   :host,
   .select-renderer,
@@ -44,6 +50,12 @@ export const agSelectRendererStyles = css `
     min-width: 100%;
   }
 `;
+/**
+ * Get a Design System prefixed Select template.
+ * @param designSystem - The design system prefix to use. Defaults to 'foundation'.
+ * @returns A Select component template prefixed with the correct design system.
+ * @public
+ */
 export const getSelectRendererTemplate = (designSystem = 'foundation') => {
     const selectComponent = `${designSystem}-select`;
     const optionComponent = `${designSystem}-option`;
@@ -65,6 +77,13 @@ export const getSelectRendererTemplate = (designSystem = 'foundation') => {
     </${selectComponent}>
   `;
 };
+/**
+ * The Foundation Select Renderer registry.
+ *
+ * @public
+ * @remarks
+ * HTML Element: \<foundation-select-renderer\>
+ */
 export const foundationAgSelectRenderer = SelectRenderer.compose({
     baseName: 'select-renderer',
     styles: agSelectRendererStyles,