@genesislcap/grid-pro 14.20.1 → 14.20.2-alpha-a84fed585.0

package/dist/grid-pro.d.ts

@@ -364,8 +364,8 @@ export declare const agThemeTokenMapCSS: (themeName: string, tokenMap: CSSVarTok
 
 /**
  * The background color swatch.
- * @deprecated - only used in the deprecated ag-theme-material theme
  * @internal
+ * @deprecated - only used in the deprecated ag-theme-material theme
  */
 export declare const backgroundSwatch: SwatchRGB;
 
@@ -423,14 +423,18 @@ export declare const DEBOUNCED_RESIZE_TIME = 5;
  */
 export declare const defaultAgGridFontFace = "\n  @font-face {\n    font-family: \"agGridAlpine\";\n    src: url(data:font/woff2;charset=utf-8;base64,d09GMgABAAAAABGYAAsAAAAAJUAAABFHAAEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAHIh2BmAAixwKpXCfGwE2AiQDgiwLgRgABCAFhEYHhRYbjiBFIbBxQJhBP8IiqifF7P9DAp1DWLRF/YtGkJpOTafDolO66hq923HLpBjtKhEisuawXiIEoOjQaGO9OOdNmM/k7y5DCZMHau317e0FCManAAiSyCaunoRkkLFl1/9/c+VPMsnNEtBMGFedLLAjUjWiUlf3+d7r9jXZ9QR298S0qL4ULfAzmTVNTp0mtPCuUzXkB9rmv+OwOMJMsBBtenrY+GctjprYgZGc8X+zSHSRfcvw1zpZ98C2kVXG2W5VN1e6FQaG8JwEf+HchRXcb/Z2hfQ8dNS65LeVddel9vIEBkLLAG+YnEKJNWojAGE6V6EkgmyIn4SZ/+fnUtsboqwa/IGs0PNzOvCvzXv/pcBZSpRymlLWAZIFgrumAmgArDY7BSznJvyER6Hm7NyE1oMAmTOP2W4ovkxHhBjDKOYx0rGd6gY9HsC1iTrjjQhAvisbO3rs5NnKm1fs3qoPidYOoKweNm9YtwIO46CaAQG+y6kDZXNP/PIvsNmO0J44x/o4N66Ot+LG+FSETZ0xCmh8diIJRcgUKg1LIC5GV+kMnGkwBUV1HbzQOxJrQ0SKWJvX3t1aFRHoqOtzRWTyveVTZfGGblRq755mi6egbDIkb+zKVJeTkPgMFsIIrr8G88QITUASqOJ5TBJLAyetqNuvUi9cwsEiSVfknTKJKFwXJEifKEg4TRaVoTf9KidqWxWTaM4Qhckx5sC9WV2VzEdYip117wlE4pFNoTH6pLaKlnSP3jkqCOWFb04+eok58yIR6Fpbc7h7VYskIzvBi/sbie0gREpS0BX75I92Tzz1WaffwH8gR5tNGv6Ou1SeWdaN1SV9UZTp7rskIKhKTKO2KKdINUyJyBebzykRFeRxykSE2WFRIO9B1isS0hgQYcL5JAPPxDZCJCtZJhixKBq5KJYoW69I7cDZt0UMtHEbtDRUHyXnQxNdkxUZZL0p82U+RlTWTIM51d59R0MY4VFM5LyTjGEtU2yJkYKpidT3fINprI68kbyhLdEKti+RzoyqEcMcPwhTspwVIrUtc4FTtliCZlwiUFiTJVoyQlQoYZSR2S1kszlNlkBoGxeSQcn+MEUWSA4mj3A5ffvhux4hAUjwEaKLmr52zGp/dflBYicWpiPxr0NTYFYDQcMRaANSkOTWZ4cEuLyoDScvqoX8RyGuh4WcvPfN7x89Mxl08dZHP36EtfDICIqxc2hNBvPNdJl2K7K5M4rCYRGaDXBjQMR3hzpP4o7B4iA8wQMsJ6+gqKSsoqqmrqGppa2jq6dvYGhkbGJqZm5haWVtY2tn7+Do5Gzi4uoGQjZEY3mkpnoONwMpo7YCzpBQU5/p33+QHKUDvWQiqhYC4hVKJgFdEuVWXwHrCaxkw4FVbDCwmo0C1rA+wFo2AVjHegHr2VBgA+sHbGLDgM1sCLCFjQa2sgHANtYf2M7GAjtZb2AXGwTsZn2BPWwMsJeNB/axgcB+NgI4wMYBB4dPBD9AlBIEgmAQhIAgFARhIAgHQQQIIkEQBYJoEMSAIBYEcSCIB0ECCBJBkASCZBCkgCAVBGkgSAdBBggyQZAFgmwQ5IAgFwR5IMgHQQEICkFQBIJiEJSAoBQEZSAoB0EFCCpBUAWCahDUgKAWBHUgqEcdOg2gbRpB0ATAPwtb4hrOkjUW5HTc5QqbZQn410jBxkUchHndThUwJRfzV20FHctyFSXU8yVnqnjVcqKMwuymhqcMPqkwZdzE7MqlETtSgja1jksLx8X8Ff1H+YGVe2V2Y1zRXllFWHa6TjV57rS1Fpe51MTab1Fp5+GvYSoCnSw+q0Knyg3wYwBdueM78aTNaQ6ZMGc2sJhDyi2UWFKajVUkKlSCUnUildsYqNCuRvJ8qsPqsaZHw1imHnAcswGXqBhwQuXfwCWekgGpGpIvQ0HnSkC+ETQedsQnNkKTvfsVG5ec3sJyonvfOjWhwcfj1Lch7WGTfXN4F1q0h6Nj3YR4YOJK97Vg/47/j0SrZ4f1sK3aBzlN9CTRon4b4djoIDxCx/QHGkSji1mm/Yu5skEao3+MPsfKXW/0BJd6VBlN4SGVVxfdQVMDX/tT7+fInmYWHpk0CyvoG7ZHrlzhFy9dO3bsFDtx/vZzcenpTbAH4kOTZ6/mF++APXk1uT5jaCg5iPbGE35x8eC1vNb40aMHxaXr7MSxS5OXr74V3b6+zItXjx4UeHB2fAXswYOTgi66mP8VCOnwFETZftDCRDnjQL11aLLadfIxMo+GgRzPxihvzAwxhtRR3QOXxaWr01SaKb2Ru7KBXUqoDrZoXYgvTVZrvbMX+MVr7MRmbXyJ64MqXixIsvOqSRPvnItPKAXn8tP8gnrylPsXVU/S6PPKxBIKno8rv4BEVfXo53Ll+leqLs7LmWPanhSZkZ4jpKJLCvLjaCnQpAGG9ooBL6T/6/ZIIKKacTYgjA2a7YoCiVrQOHFEYLIwm9bDhsBkI8BmXT4GCti6DdIBN80cQOmfxcpZF9zRBKNjNeXmRe//xRryXqh55q9DCFp7fSMcCpKfB88fGGag9rWQ0c7rxXns3uip2oiDuBsSoBI2bsOgWIKBCrAcm+hxaZxdx/CeM1ZnSVTPjogm4PXn7ZvdSpZJhVJVUTN3YldHhTwR9SeU7cvL4xyv3JuBbTTRIT4y/6lp2JthwV04Z8cc39G/0rR6YE012woDFoJVqt2G4pdhg3JHmmZ+1JoRK9zKQ9eG7hQTLmaPReFrpYFqAq9d6jzTxYM4JjwSWu62xm8O11PjYsbMNSu8NKl7HmbnfS5rT6TnhLdKHuUXfK/knS4uSu4Wt9Ezevzf72KdnTTvf1EQWzfxpcCYDP1SMYyql4r7XJ74UXJcsMavoX8eFlTaigWK4z/eBIaIEcBmnzojLlnKewNGn/KhYPd0KKPnPve5L/ux+2MzqB5eMo367GnTpPGpWXTqw+QTbzhQdB2nt9+5t7RD8XpB5wMzqfzo2IjRPea2GdyhaUAYu1teYrTbIsaDk6lw9Ol3SHBkyVWiGb+8hrNnSHT/d4gK8MlVexbaI+9GvB32KcrC3w4dTI1BeHwBS+xJHYpLEKxc1ODgfI1GqyFJYbOnnyAhOCx/M9ti+UJ8eWhZnUUj4JdiNhRJC8TiAmnRnUiz7QJxkfTOlnQlzzLPMMwi0pxfAXiVsshYkvpEfibb28kOEiTTLQzfiDO+O/1MhC/vTgCP4eKSnX382LJl2Tn11gRBeFO4OLqLofVFL2ysDQyPDy5cOLukhEZLiD/uqzt+7PiGhLVrJz5WeXAhDbgexJOJEPvfZ0OcYZtxGLFU+zKkowDcWiKkGii5/uksQYDu+80DrpJQvjWOOc0FnpIL3DSDq+SBA84+rTwNb0RaXXKyrmRfRiklaFqcFYjPPKwsb2scSN2EhFSGxIRUhIiT/xtpf275z+tue+dfyLnc0ET7K0jjwgvMSU1nnO0rYz7fT3XhHmlDndxGBDvazS/qim+N47htifXfXe6v0Xj0suc9YHu4u7j6sE/9dsQmFndXNT1hOqgd2Qtr3vVdDJHOd1wdjfQOlwWsannObV9Hlt24lcmurkuPOc4dMTFsN59yDwOXLqw9i2HlLjzr3jDE2bnEPfbvSFvGgnIDCB3eTvMs6f2TO3Nc2zmyZmLdSFcFx4H7YZBOoZv/P3HElhPFdMjKrhvbuW+G40R3Z3eRplfdJfrDypbjz3GEJkqiOOnzU/ziuC0ZppRKVWihek5KS7d3Lj9MnKI/9DdVro+tVcOc1JYur1y5LDO7rMh2eNSYGI/EopJ+ccboDN6q+SJBBp+fLhAxbAo74saWQZVEnFKZLeeNc08sliiYCKi7cqRHOnmoTU5OUYlHovrE8nteuS3dc1LWdbkE37vq8MqV/T4nTJsUaaJUuQHizX3OmLub0naBYsNo/IpqP5t7+Qq8F+7fZ1w9GtupN8RbAubdpCROGRWkYrcxX14svj2GBLmFRgy4FJdQiliFcRupIJWJk5+MmX19u0KqMH6qwra96fByc4fY4VUUOvp+6bSsmjxY9b9sFBa/4Xlu5i3PXS4rlEgKmiMNyNYa4m325K3i5xA57csW6ZAW1qR3oSEAeGYJs/4Mev+3ojBsGaZCFy/MEm7JjNW3rMc9Fu+JifuvUeOwDe/o0F5HkKQkBLmec7bi00d3Ldg1sf/LDLiBNCiSLXED4NvcNftuvHCQjdvYiNXfotFXSSVwz+dlT+pIkuC3Ypa8Al3u3oV54VmCzExBVnierJK36MwZT15llhNRsn1NQcwvtevPfRv17cgGLnDnJJSR2tId/uD9weX5Fz7LmEOQC0kCRpFTp9p6ynPGH59tqSkpmrIyHve95OOTue1OenplmRXdPVCee6zGbL57l7o3KWryZvLdnDn5zY4MD4+2UlebFocZ5pbp2K23bq9enYUYp1VNqXx+qg3qbc2G0gtN2XzQ7bvY9UUmeW71LDcgztH22b9hB45jXMDLQ7vYMx8SxFiC+rMplJ+eFmZo/ZOq3iWCmvVS6DrtvJ3YJ93G2Nu9F36ik334x96ZbXQo6FYo9vQYuxHl5n1oGwdMMfbtMzYpe/tg3avVr3rGqm/fTm5gS4U+WBtkMgVpg/XDkSbaZDrXrw8eFgS2Lv21Xi/WCYU6sf5KSbVtnVAvvrJVG948S21OTm7+kxKj/sz/uJRP3WT7pSSteinzXwjpcM9y9jTmrd2o2Ch9hsficG82O9uZwN+CrkLZkHUv7l6W4NyqPT/8S06Wy3x9k5KASjIUGODVOruMmS0xUiocPnwReWDi1NnDcrw4XjZnPid0mX7sWFtl7UD/kLIqUXa53UrAxeQ3KpUf0VyQn5GxfHnczl1g7PuR+Zp5IypXnseIH1/cIz4bBZgxWU01M/x1gr1udqJlaBGlimhjGsr+uF+bwiOA+zU2oE91TLEeIauP1xWe6rUM/pA81yOYpihiSB7JUXB/oI+iZaGt9tQq2n9Q0derrnU/2o8lgXVDNY1oD9p6TyUb0YWZhdYyCKXNkXqpiKbholwui05d6ymOvr4rvfbvnEuD/2Lt6UJO/LtcDLUAjLO7+6TfmdLsqQ1oX9N1GBdZaqb1U6z/q75SrwQ8/Q0nP38sYCya/8Olal7o7hJgPz+nTjjmCEjw0ihgE3KAue6Ez7v6sQAMBCBRVzH0QE+m7QFOUA8oIHQ7QMAd+l1GAzbMBJSuy4FO132so8Klf1DS9T/b9TcUX2zPj/AL+0JO3/nkAvwE23tJm1M5r/MXKLsYquvmateVvUAAkgy6aucqD/aG2VSGIlbPMayL8j5WieIXKG465nS7Whn3qhsVcU2yXhBHu+MlTgB+gvDA9TyJJGbIMf6CADLvWhRUrjWuJH0vSqp0AYxdq7Tmf+5sYN3g2DCqxCIR5uJZqyIJPoZ4J5LY+gKUazY6BSu5tYrnZWTNhtLC560Aq5pu1Hxm2ADhCAgVDfnVHfDFWv3a/K+boiQrqqYbpmU7rucHYRQnaZYXZVU3bdcP4zQv67Yf53U/r/fn6869B4+ePHvx6s27D59rb8W2BFayi6GUQ3HMm/KqUkVQ4IU6kvi4naC+2zjVWTroy40OXNDAQOiCZDjdldAHKfe+ah+pTq7Sk7buUo8h76oOTFIx6EJ1moWamPOmukOhMysBX7vadsckqTmo3oEf6uxl7jbzzNKUb00TU5syF3ZcEjsz9qnYqzHsabj0FTo92y3fUrtgtzEmh26BAjP024Pka2cbcuIidIC90FxL7+MIWiQNZwmbqYJINUTeTgODi30+piO9mVi3PXMMdTTmaKOpIKhsx0WOAXbzc19S6ziGQukT7aE2oe1becDAJ2Ubp0wARhQ7m5VjgrDdv2N5JuuSRQBzomCUKV7nW2tS/6FeMhsYy1oDAA==);\n    font-weight: normal;\n    font-style: normal;\n  }\n";
 
+/**
+ * Grid Pro default configuration.
+ * @public
+ */
 export declare const defaultGridProConfig: {
     shadowOptions: any;
 };
 
 /**
  * The foreground color swatch.
- * @deprecated - only used in the deprecated ag-theme-material theme
  * @internal
+ * @deprecated - only used in the deprecated ag-theme-material theme
  */
 export declare const foregroundSwatch: SwatchRGB;
 
@@ -444,7 +448,7 @@ export declare const foregroundSwatch: SwatchRGB;
 export declare function formatDateExtra(epoch: number): string;
 
 /**
- * The Foundation Boolean Renderer registry.
+ * A function that returns a Foundation Boolean Renderer registration for configuring the component with a DesignSystem.
  *
  * @public
  * @remarks
@@ -461,7 +465,7 @@ template: ViewTemplate<any, any>;
 }, typeof BooleanRenderer>;
 
 /**
- * The Foundation Select Renderer registry.
+ * A function that returns a Foundation Select Renderer registration for configuring the component with a DesignSystem.
  *
  * @public
  * @remarks
@@ -478,7 +482,7 @@ template: ViewTemplate<any, any>;
 }, typeof SelectRenderer>;
 
 /**
- * The Foundation Text Field Renderer registry.
+ * A function that returns a Foundation Text Field Renderer registration for configuring the component with a DesignSystem.
  *
  * @public
  * @remarks
@@ -495,12 +499,12 @@ template: ViewTemplate<AgTextFieldRenderer, any>;
 }, typeof AgTextFieldRenderer>;
 
 /**
- * The Foundation Text Renderer registry.
+ * A function that returns a Foundation Text Renderer registration for configuring the component with a DesignSystem.
  *
  * @public
- * @deprecated - Use foundationAgTextFieldRenderer instead
  * @remarks
  * HTML Element: \<foundation-grid-text-renderer\>
+ * @deprecated - Use foundationAgTextFieldRenderer instead
  */
 export declare const foundationAgTextRenderer: (overrideDefinition?: OverrideFoundationElementDefinition<    {
 baseName: string;
@@ -585,7 +589,7 @@ export declare const foundationGridComponents: {
 };
 
 /**
- * The Foundation AgGrid
+ * A function that returns a Foundation Grid Pro registration for configuring the component with a DesignSystem.
  *
  * @public
  * @remarks
@@ -604,7 +608,7 @@ template: ViewTemplate<any, any>;
 }, typeof GridPro>;
 
 /**
- * The Foundation Action Renderer registry.
+ * A function that returns a Foundation Action Renderer for configuring the component with a DesignSystem.
  *
  * @public
  * @remarks
@@ -621,7 +625,7 @@ template: ViewTemplate<ActionRenderer, any>;
 }, typeof ActionRenderer>;
 
 /**
- * The Foundation Actions Menu Renderer registry.
+ * A function that returns a Foundation Actions Menu for configuring the component with a DesignSystem.
  *
  * @public
  * @remarks
@@ -635,6 +639,12 @@ baseName: string;
 template: ViewTemplate<any, any>;
 }, typeof ActionsMenuRenderer>;
 
+/**
+ * GridPro shadow root options.
+ * @public
+ * @remarks
+ * For extensibility, this can be used to set the shadow root mode and delegatesFocus
+ */
 export declare const foundationGridProShadowOptions: ShadowRootInit;
 
 /**
@@ -765,6 +775,9 @@ export declare type GridComponents = {
 };
 
 /**
+ * The Grid Pro element.
+ * @remarks Grid Pro is a Web Component wrapper around the AG Grid Community library.
+ * @public
  * @tagname %%prefix%%-grid-pro
  */
 export declare class GridPro extends GridPro_base {
@@ -803,8 +816,8 @@ export declare class GridPro extends GridPro_base {
     gridComponents: {
         [componentName: string]: any;
     };
-    protected agAttributes: any;
-    protected agPropertiesMap: any;
+    protected agAttributes: Record<string, string>;
+    protected agPropertiesMap: Record<string, string>;
     protected agGridOptions: GridOptions;
     protected initialised: boolean;
     private rehydrationAttempted;
@@ -820,12 +833,23 @@ export declare class GridPro extends GridPro_base {
      */
     private debouncedColumnAutosize;
     /**
-     * If {@link @genesislcap/grid-pro#GridPro#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;
-    private serialiseStoreTableConfig;
-    private rehydrateTableConfig;
+    private saveColumnState;
+    /**
+     * Gets the saved grid ColDefs from local storage
+     * @remarks This is used to restore the grid state when the grid is rehydrated
+     * @privateRemarks Not using `columnApi.get|setColumnState()` for these flows as it doesn't work setting new columnDefs vs different ordering.
+     * @public
+     */
+    get savedColumnState(): ColDef[];
+    private restoreColumnState;
+    /**
+     * @public
+     */
+    get gridOptions(): GridOptions;
     set gridOptions(options: GridOptions);
     private enableFlashingRows;
     applyTemplateDefinitions(columnDefs?: ColDef[]): ColDef<any>[];
@@ -919,6 +943,11 @@ declare const GridPro_base: (new (...args: any[]) => {
     getAttribute(qualifiedName: string): string;
     getAttributeNS(namespace: string, localName: string): string;
     getAttributeNames(): string[];
+    /**
+     * Because we try and resize the grid to fit using callbacks on events, this will cause
+     * a stack overflow of calls to resize, so we need to debounce it.
+     * @internal
+     */
     getAttributeNode(qualifiedName: string): Attr;
     getAttributeNodeNS(namespace: string, localName: string): Attr;
     getBoundingClientRect(): DOMRect;
@@ -1200,6 +1229,11 @@ export declare class GridProCell extends FoundationElement implements ICellRende
  */
 export declare function gridProColumns<TSource = any>(itemsBinding: Binding<TSource, readonly ColDef[]> | readonly ColDef[], includeRenderers?: boolean): CaptureType<TSource>;
 
+/**
+ * The Genesis Datasource element, for CSRM-compatible data fetching and used exclusively by the GridPro element.
+ * @remarks Only supports Client-Side Row Model.
+ * @public
+ */
 export declare class GridProGenesisDatasource extends GridProGenesisDatasource_base {
     connect: Connect;
     datasource: Datasource;
@@ -1231,16 +1265,27 @@ export declare class GridProGenesisDatasource extends GridProGenesisDatasource_b
     disconnectedCallback(): void;
     deepClone(): Node;
     private get agGrid();
+    /**
+     * Initializes the datasource.
+     * @public
+     * @remarks This method is called automatically when the element is connected to the DOM.
+     */
     init(): void;
     /**
+     * Deinitialises the datasource, resetting it to its initial state.
      * @public
      */
     deinit(): void;
     /**
-     * Use {@link @genesislcap/grid-pro#GridProGenesisDatasource#deinit} instead
-     * @deprecated
+     * Resets the datasource to its initial state.
+     * @public
+     * @deprecated Use `deinit` instead
      */
     reset(): void;
+    /**
+     * Restarts the datasource, uses `deinit` and `init` in sequence.
+     * @public
+     */
     restart(): void;
     private clearRowData;
     private updateRowData;
@@ -1597,6 +1642,11 @@ declare const GridProGenesisDatasource_base: (new (...args: any[]) => {
     focus(options?: FocusOptions): void;
 }) & typeof FoundationElement;
 
+/**
+ * The Genesis Datasource (Next) element, for SSRM-compatible data fetching and used exclusively by the GridPro element.
+ * @remarks Intended to be the "next version" of the `grid-pro-genesis-datasource` element, supporting SSRM.
+ * @alpha
+ */
 export declare class GridProGenesisDatasourceNext extends GridProGenesisDatasourceNext_base {
     connect: Connect;
     criteria: string;
@@ -1980,6 +2030,14 @@ export declare enum GridProRendererTypes {
  */
 export declare const gridProTemplate: ViewTemplate;
 
+/**
+ * A function to convert string values from 'camelCase' to 'hyphenated-lowercase'.
+ * @param value - The value to hyphenate and lowercase.
+ * @returns The hyphenated and lowercased result.
+ * @public
+ */
+export declare const hyphenateAndLowercase: (value: string) => string;
+
 /**
  * Logger for the grid-pro package
  * @public
@@ -2013,6 +2071,10 @@ export declare class SelectRenderer extends FoundationElement implements ICellRe
     selectionChanged: (e: any) => void;
 }
 
+/**
+ * The IServerSideDatasource implementation, used for SSRM (Server-Side Row Model) in the grid.
+ * @alpha
+ */
 export declare class StreamDatasource implements IServerSideDatasource {
     connect: Connect;
     dataserverStream: SocketObservable<FilteredDataServerResult>;
@@ -2041,6 +2103,12 @@ export declare class StreamDatasource implements IServerSideDatasource {
     private getFiltersByType;
 }
 
+/**
+ * Type definition for configuration options used for streams.
+ * @remarks
+ * Used by {@link @genesislcap/grid-pro#StreamDatasource} constructor to configure options for the stream.
+ * @alpha
+ */
 export declare type StreamDatasourceOptions = {
     stream: SocketObservable<FilteredDataServerResult>;
     resourceName: string;

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

@@ -4,6 +4,8 @@
 
 ## defaultGridProConfig variable
 
+Grid Pro default configuration.
+
 **Signature:**
 
 ```typescript

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

@@ -4,7 +4,7 @@
 
 ## foundationAgBooleanRenderer variable
 
-The Foundation Boolean Renderer registry.
+A function that returns a Foundation Boolean Renderer registration for configuring the component with a DesignSystem.
 
 **Signature:**
 

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

@@ -4,7 +4,7 @@
 
 ## foundationAgSelectRenderer variable
 
-The Foundation Select Renderer registry.
+A function that returns a Foundation Select Renderer registration for configuring the component with a DesignSystem.
 
 **Signature:**
 

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

@@ -4,7 +4,7 @@
 
 ## foundationAgTextFieldRenderer variable
 
-The Foundation Text Field Renderer registry.
+A function that returns a Foundation Text Field Renderer registration for configuring the component with a DesignSystem.
 
 **Signature:**
 

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

@@ -9,7 +9,7 @@
 > - Use foundationAgTextFieldRenderer instead
 > 
 
-The Foundation Text Renderer registry.
+A function that returns a Foundation Text Renderer registration for configuring the component with a DesignSystem.
 
 **Signature:**
 

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

@@ -4,7 +4,7 @@
 
 ## foundationGridPro variable
 
-The Foundation AgGrid
+A function that returns a Foundation Grid Pro registration for configuring the component with a DesignSystem.
 
 **Signature:**
 

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

@@ -4,7 +4,7 @@
 
 ## foundationGridProActionRenderer variable
 
-The Foundation Action Renderer registry.
+A function that returns a Foundation Action Renderer for configuring the component with a DesignSystem.
 
 **Signature:**
 

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

@@ -4,7 +4,7 @@
 
 ## foundationGridProActionsMenuRenderer variable
 
-The Foundation Actions Menu Renderer registry.
+A function that returns a Foundation Actions Menu for configuring the component with a DesignSystem.
 
 **Signature:**
 

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

@@ -4,8 +4,15 @@
 
 ## foundationGridProShadowOptions variable
 
+GridPro shadow root options.
+
 **Signature:**
 
 ```typescript
 foundationGridProShadowOptions: ShadowRootInit
 ```
+
+## Remarks
+
+For extensibility, this can be used to set the shadow root mode and delegatesFocus
+

package/docs/api/grid-pro.gridpro.agattributes.md

@@ -7,5 +7,5 @@
 **Signature:**
 
 ```typescript
-protected agAttributes: any;
+protected agAttributes: Record<string, string>;
 ```

package/docs/api/grid-pro.gridpro.agpropertiesmap.md

@@ -7,5 +7,5 @@
 **Signature:**
 
 ```typescript
-protected agPropertiesMap: any;
+protected agPropertiesMap: Record<string, string>;
 ```

package/docs/api/grid-pro.gridpro.gridoptions.md

@@ -4,8 +4,11 @@
 
 ## GridPro.gridOptions property
 
+
 **Signature:**
 
 ```typescript
+get gridOptions(): GridOptions;
+
 set gridOptions(options: GridOptions);
 ```

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

@@ -4,6 +4,8 @@
 
 ## GridPro class
 
+The Grid Pro element.
+
 **Signature:**
 
 ```typescript
@@ -11,6 +13,10 @@ export declare class GridPro extends GridPro_base
 ```
 **Extends:** GridPro\_base
 
+## Remarks
+
+Grid Pro is a Web Component wrapper around the AG Grid Community library.
+
 ## Constructors
 
 |  Constructor | Modifiers | Description |
@@ -21,10 +27,10 @@ export declare class GridPro extends GridPro_base
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [agAttributes](./grid-pro.gridpro.agattributes.md) | <code>protected</code> | any |  |
+|  [agAttributes](./grid-pro.gridpro.agattributes.md) | <code>protected</code> | Record&lt;string, string&gt; |  |
 |  [agGrid](./grid-pro.gridpro.aggrid.md) |  | Grid |  |
 |  [agGridOptions](./grid-pro.gridpro.aggridoptions.md) | <code>protected</code> | GridOptions |  |
-|  [agPropertiesMap](./grid-pro.gridpro.agpropertiesmap.md) | <code>protected</code> | any |  |
+|  [agPropertiesMap](./grid-pro.gridpro.agpropertiesmap.md) | <code>protected</code> | Record&lt;string, string&gt; |  |
 |  [autoCellRendererByType](./grid-pro.gridpro.autocellrendererbytype.md) |  | boolean |  |
 |  [classNames](./grid-pro.gridpro.classnames.md) |  | string |  |
 |  [columnApi](./grid-pro.gridpro.columnapi.md) |  | ColumnApi |  |
@@ -44,6 +50,7 @@ export declare class GridPro extends GridPro_base
 |  [onlyTemplateColDefs](./grid-pro.gridpro.onlytemplatecoldefs.md) |  | boolean |  |
 |  [persistColumnStateKey](./grid-pro.gridpro.persistcolumnstatekey.md) |  | string |  |
 |  [rowHeight](./grid-pro.gridpro.rowheight.md) |  | number |  |
+|  [savedColumnState](./grid-pro.gridpro.savedcolumnstate.md) | <code>readonly</code> | ColDef\[\] | Gets the saved grid ColDefs from local storage |
 |  [theme](./grid-pro.gridpro.theme.md) |  | string |  |
 
 ## Methods

package/docs/api/grid-pro.gridpro.savedcolumnstate.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridPro](./grid-pro.gridpro.md) &gt; [savedColumnState](./grid-pro.gridpro.savedcolumnstate.md)
+
+## GridPro.savedColumnState property
+
+Gets the saved grid ColDefs from local storage
+
+**Signature:**
+
+```typescript
+get savedColumnState(): ColDef[];
+```
+
+## Remarks
+
+This is used to restore the grid state when the grid is rehydrated
+

package/docs/api/grid-pro.gridprogenesisdatasource.deinit.md

@@ -4,6 +4,7 @@
 
 ## GridProGenesisDatasource.deinit() method
 
+Deinitialises the datasource, resetting it to its initial state.
 
 **Signature:**
 

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

@@ -4,6 +4,8 @@
 
 ## GridProGenesisDatasource.init() method
 
+Initializes the datasource.
+
 **Signature:**
 
 ```typescript
@@ -13,3 +15,7 @@ init(): void;
 
 void
 
+## Remarks
+
+This method is called automatically when the element is connected to the DOM.
+

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

@@ -4,6 +4,8 @@
 
 ## GridProGenesisDatasource class
 
+The Genesis Datasource element, for CSRM-compatible data fetching and used exclusively by the GridPro element.
+
 **Signature:**
 
 ```typescript
@@ -11,6 +13,10 @@ export declare class GridProGenesisDatasource extends GridProGenesisDatasource_b
 ```
 **Extends:** GridProGenesisDatasource\_base
 
+## Remarks
+
+Only supports Client-Side Row Model.
+
 ## Properties
 
 |  Property | Modifiers | Type | Description |
@@ -38,12 +44,12 @@ export declare class GridProGenesisDatasource extends GridProGenesisDatasource_b
 |  [connectedCallback()](./grid-pro.gridprogenesisdatasource.connectedcallback.md) |  |  |
 |  [criteriaChanged(oldCriteria, newCriteria)](./grid-pro.gridprogenesisdatasource.criteriachanged.md) |  |  |
 |  [deepClone()](./grid-pro.gridprogenesisdatasource.deepclone.md) |  |  |
-|  [deinit()](./grid-pro.gridprogenesisdatasource.deinit.md) |  |  |
+|  [deinit()](./grid-pro.gridprogenesisdatasource.deinit.md) |  | Deinitialises the datasource, resetting it to its initial state. |
 |  [disconnectedCallback()](./grid-pro.gridprogenesisdatasource.disconnectedcallback.md) |  |  |
-|  [init()](./grid-pro.gridprogenesisdatasource.init.md) |  |  |
+|  [init()](./grid-pro.gridprogenesisdatasource.init.md) |  | Initializes the datasource. |
 |  [removeFilter(fieldName)](./grid-pro.gridprogenesisdatasource.removefilter.md) |  |  |
-|  [reset()](./grid-pro.gridprogenesisdatasource.reset.md) |  | Use  instead |
+|  [reset()](./grid-pro.gridprogenesisdatasource.reset.md) |  | Resets the datasource to its initial state. |
 |  [resourceNameChanged(oldValue, newValue)](./grid-pro.gridprogenesisdatasource.resourcenamechanged.md) |  |  |
-|  [restart()](./grid-pro.gridprogenesisdatasource.restart.md) |  |  |
+|  [restart()](./grid-pro.gridprogenesisdatasource.restart.md) |  | Restarts the datasource, uses <code>deinit</code> and <code>init</code> in sequence. |
 |  [setFilter(fieldName, newFilter)](./grid-pro.gridprogenesisdatasource.setfilter.md) |  |  |
 

package/docs/api/grid-pro.gridprogenesisdatasource.reset.md

@@ -6,9 +6,10 @@
 
 > Warning: This API is now obsolete.
 > 
+> Use `deinit` instead
 > 
 
-Use  instead
+Resets the datasource to its initial state.
 
 **Signature:**
 

package/docs/api/grid-pro.gridprogenesisdatasource.restart.md

@@ -4,6 +4,8 @@
 
 ## GridProGenesisDatasource.restart() method
 
+Restarts the datasource, uses `deinit` and `init` in sequence.
+
 **Signature:**
 
 ```typescript

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [hyphenateAndLowercase](./grid-pro.hyphenateandlowercase.md)
+
+## hyphenateAndLowercase variable
+
+A function to convert string values from 'camelCase' to 'hyphenated-lowercase'.
+
+**Signature:**
+
+```typescript
+hyphenateAndLowercase: (value: string) => string
+```

package/docs/api/grid-pro.md

@@ -14,12 +14,10 @@
 |  [AgTextRenderer](./grid-pro.agtextrenderer.md) |  |
 |  [BooleanRenderer](./grid-pro.booleanrenderer.md) | The AG Boolean Renderer element. |
 |  [GridColumn](./grid-pro.gridcolumn.md) | The Grid Pro Column element. |
-|  [GridPro](./grid-pro.gridpro.md) |  |
+|  [GridPro](./grid-pro.gridpro.md) | The Grid Pro element. |
 |  [GridProCell](./grid-pro.gridprocell.md) | The Grid Pro Cell element. |
-|  [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) |  |
-|  [GridProGenesisDatasourceNext](./grid-pro.gridprogenesisdatasourcenext.md) |  |
+|  [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) | The Genesis Datasource element, for CSRM-compatible data fetching and used exclusively by the GridPro element. |
 |  [SelectRenderer](./grid-pro.selectrenderer.md) | The AG Select Renderer element. |
-|  [StreamDatasource](./grid-pro.streamdatasource.md) |  |
 
 ## Enumerations
 
@@ -61,16 +59,16 @@
 |  [CellTemplate](./grid-pro.celltemplate.md) | The Grid Pro Cell Template. |
 |  [ColumnTemplate](./grid-pro.columntemplate.md) | The Grid Pro Column Template. |
 |  [defaultAgGridFontFace](./grid-pro.defaultaggridfontface.md) | The default font face for Grid Pro (agGridAlpine). |
-|  [defaultGridProConfig](./grid-pro.defaultgridproconfig.md) |  |
-|  [foundationAgBooleanRenderer](./grid-pro.foundationagbooleanrenderer.md) | The Foundation Boolean Renderer registry. |
-|  [foundationAgSelectRenderer](./grid-pro.foundationagselectrenderer.md) | The Foundation Select Renderer registry. |
-|  [foundationAgTextFieldRenderer](./grid-pro.foundationagtextfieldrenderer.md) | The Foundation Text Field Renderer registry. |
-|  [foundationAgTextRenderer](./grid-pro.foundationagtextrenderer.md) | The Foundation Text Renderer registry. |
+|  [defaultGridProConfig](./grid-pro.defaultgridproconfig.md) | Grid Pro default configuration. |
+|  [foundationAgBooleanRenderer](./grid-pro.foundationagbooleanrenderer.md) | A function that returns a Foundation Boolean Renderer registration for configuring the component with a DesignSystem. |
+|  [foundationAgSelectRenderer](./grid-pro.foundationagselectrenderer.md) | A function that returns a Foundation Select Renderer registration for configuring the component with a DesignSystem. |
+|  [foundationAgTextFieldRenderer](./grid-pro.foundationagtextfieldrenderer.md) | A function that returns a Foundation Text Field Renderer registration for configuring the component with a DesignSystem. |
+|  [foundationAgTextRenderer](./grid-pro.foundationagtextrenderer.md) | A function that returns a Foundation Text Renderer registration for configuring the component with a DesignSystem. |
 |  [foundationGridComponents](./grid-pro.foundationgridcomponents.md) | The Grid Pro Components. |
-|  [foundationGridPro](./grid-pro.foundationgridpro.md) | The Foundation AgGrid |
-|  [foundationGridProActionRenderer](./grid-pro.foundationgridproactionrenderer.md) | The Foundation Action Renderer registry. |
-|  [foundationGridProActionsMenuRenderer](./grid-pro.foundationgridproactionsmenurenderer.md) | The Foundation Actions Menu Renderer registry. |
-|  [foundationGridProShadowOptions](./grid-pro.foundationgridproshadowoptions.md) |  |
+|  [foundationGridPro](./grid-pro.foundationgridpro.md) | A function that returns a Foundation Grid Pro registration for configuring the component with a DesignSystem. |
+|  [foundationGridProActionRenderer](./grid-pro.foundationgridproactionrenderer.md) | A function that returns a Foundation Action Renderer for configuring the component with a DesignSystem. |
+|  [foundationGridProActionsMenuRenderer](./grid-pro.foundationgridproactionsmenurenderer.md) | A function that returns a Foundation Actions Menu for configuring the component with a DesignSystem. |
+|  [foundationGridProShadowOptions](./grid-pro.foundationgridproshadowoptions.md) | GridPro shadow root options. |
 |  [foundationGridProStyles](./grid-pro.foundationgridprostyles.md) | The Grid Pro styles. |
 |  [getActionsMenuDef](./grid-pro.getactionsmenudef.md) | Helper function to get ColDef [https://www.ag-grid.com/javascript-data-grid/column-properties/](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). |
 |  [getAgBooleanRendererTemplate](./grid-pro.getagbooleanrenderertemplate.md) | Get a Design System prefixed Checkbox template. |
@@ -78,6 +76,7 @@
 |  [getTextFieldRendererTemplate](./grid-pro.gettextfieldrenderertemplate.md) | Get a Design System prefixed Text Field template. |
 |  [getTextRendererTemplate](./grid-pro.gettextrenderertemplate.md) |  |
 |  [gridProTemplate](./grid-pro.gridprotemplate.md) | The Grid Pro Template. |
+|  [hyphenateAndLowercase](./grid-pro.hyphenateandlowercase.md) | A function to convert string values from 'camelCase' to 'hyphenated-lowercase'. |
 |  [logger](./grid-pro.logger.md) | Logger for the grid-pro package |
 |  [textFieldRendererStyles](./grid-pro.textfieldrendererstyles.md) | The AG Text Field Renderer Styles. |
 |  [textRendererStyles](./grid-pro.textrendererstyles.md) |  |
@@ -89,5 +88,4 @@
 |  [ActionRendererParams](./grid-pro.actionrendererparams.md) | Parameters for the [GridPro](./grid-pro.gridpro.md) action renderer. |
 |  [AgThemeFontFaceMap](./grid-pro.agthemefontfacemap.md) | Type for mapping of a [AgGridTheme](./grid-pro.aggridtheme.md) to a font face. |
 |  [GridComponents](./grid-pro.gridcomponents.md) | Grid Pro Components type, used to define the custom components that will be registered in the grid |
-|  [StreamDatasourceOptions](./grid-pro.streamdatasourceoptions.md) |  |