@genesislcap/grid-pro 14.283.2 → 14.284.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. package/dist/custom-elements.json +248 -1
  2. package/dist/dts/cell-renderers/index.d.ts +1 -0
  3. package/dist/dts/cell-renderers/index.d.ts.map +1 -1
  4. package/dist/dts/cell-renderers/status-pill.renderer.d.ts +60 -0
  5. package/dist/dts/cell-renderers/status-pill.renderer.d.ts.map +1 -0
  6. package/dist/dts/grid-components.d.ts +11 -0
  7. package/dist/dts/grid-components.d.ts.map +1 -1
  8. package/dist/dts/grid-pro.d.ts +6 -21
  9. package/dist/dts/grid-pro.d.ts.map +1 -1
  10. package/dist/dts/grid-pro.types.d.ts +1 -0
  11. package/dist/dts/grid-pro.types.d.ts.map +1 -1
  12. package/dist/esm/cell-renderers/index.js +1 -0
  13. package/dist/esm/cell-renderers/status-pill.renderer.js +67 -0
  14. package/dist/esm/grid-components.js +3 -1
  15. package/dist/esm/grid-pro.js +2 -1
  16. package/dist/esm/grid-pro.types.js +1 -0
  17. package/dist/grid-pro.api.json +508 -2
  18. package/dist/grid-pro.d.ts +79 -21
  19. package/docs/api/grid-pro.agstatuspillrendererstyles.md +13 -0
  20. package/docs/api/grid-pro.foundationgridcomponents.md +10 -0
  21. package/docs/api/grid-pro.foundationstatuspillrenderer.md +26 -0
  22. package/docs/api/grid-pro.getstatuspillrenderertemplate.md +13 -0
  23. package/docs/api/grid-pro.gridprorenderertypes.md +1 -0
  24. package/docs/api/grid-pro.md +5 -0
  25. package/docs/api/grid-pro.statuspillrenderer.destroy.md +15 -0
  26. package/docs/api/grid-pro.statuspillrenderer.getgui.md +15 -0
  27. package/docs/api/grid-pro.statuspillrenderer.init.md +22 -0
  28. package/docs/api/grid-pro.statuspillrenderer.md +32 -0
  29. package/docs/api/grid-pro.statuspillrenderer.params.md +11 -0
  30. package/docs/api/grid-pro.statuspillrenderer.refresh.md +22 -0
  31. package/docs/api/grid-pro.statuspillrendererparams.md +25 -0
  32. package/docs/api-report.md +58 -0
  33. package/package.json +13 -13
@@ -290,6 +290,12 @@ export declare const agSelectEditorStyles: ElementStyles;
290
290
  */
291
291
  export declare const agSelectRendererStyles: ElementStyles;
292
292
 
293
+ /**
294
+ * The Status Pill Renderer Styles.
295
+ * @public
296
+ */
297
+ export declare const agStatusPillRendererStyles: ElementStyles;
298
+
293
299
  /**
294
300
  * The AG String Renderer Styles.
295
301
  * @public
@@ -860,6 +866,16 @@ export declare const foundationGridComponents: {
860
866
  styles: ElementStyles;
861
867
  template: ViewTemplate<StringEditor, any>;
862
868
  }, StringEditor>;
869
+ foundationStatusPillRenderer: (overrideDefinition?: OverrideFoundationElementDefinition< {
870
+ baseName: string;
871
+ template: ViewTemplate<any, any>;
872
+ styles: ElementStyles;
873
+ }>) => FoundationElementRegistry< {
874
+ baseName: string;
875
+ template: ViewTemplate<any, any>;
876
+ styles: ElementStyles;
877
+ }, typeof StatusPillRenderer>;
878
+ StatusPillRenderer: typeof StatusPillRenderer;
863
879
  register(container?: Container, ...rest: any[]): void;
864
880
  };
865
881
 
@@ -977,6 +993,23 @@ styles: ElementStyles;
977
993
  template: ViewTemplate<SelectEditor, any>;
978
994
  }, typeof SelectEditor>;
979
995
 
996
+ /**
997
+ * A function that returns a Foundation Status Pill Renderer registration for configuring the component with a DesignSystem.
998
+ *
999
+ * @public
1000
+ * @remarks
1001
+ * HTML Element: \<foundation-status-pill-renderer\>
1002
+ */
1003
+ export declare const foundationStatusPillRenderer: (overrideDefinition?: OverrideFoundationElementDefinition< {
1004
+ baseName: string;
1005
+ template: ViewTemplate<any, any>;
1006
+ styles: ElementStyles;
1007
+ }>) => FoundationElementRegistry< {
1008
+ baseName: string;
1009
+ template: ViewTemplate<any, any>;
1010
+ styles: ElementStyles;
1011
+ }, typeof StatusPillRenderer>;
1012
+
980
1013
  /**
981
1014
  *
982
1015
  * @public
@@ -1516,6 +1549,14 @@ export declare const getSelectEditorTemplate: (designSystem?: string) => ViewTem
1516
1549
  */
1517
1550
  export declare const getSelectRendererTemplate: (designSystem?: string) => ViewTemplate<any, any>;
1518
1551
 
1552
+ /**
1553
+ * Get a Design System prefixed Status Pill template.
1554
+ * @param designSystem - The design system prefix to use. Defaults to 'rapid'.
1555
+ * @returns A Staus Pill component template prefixed with the correct design system.
1556
+ * @public
1557
+ */
1558
+ export declare const getStatusPillRendererTemplate: (designSystem?: string) => ViewTemplate<any, any>;
1559
+
1519
1560
  /**
1520
1561
  * Get a Design System prefixed String template.
1521
1562
  * @param designSystem - The design system prefix to use. Defaults to 'foundation'.
@@ -1831,10 +1872,7 @@ declare const GridPro_base: (new (...args: any[]) => {
1831
1872
  accessKey: string;
1832
1873
  readonly accessKeyLabel: string;
1833
1874
  autocapitalize: string;
1834
- dir: string; /**
1835
- * If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef
1836
- * @remarks Defaults to true
1837
- */
1875
+ dir: string;
1838
1876
  draggable: boolean;
1839
1877
  hidden: boolean;
1840
1878
  inert: boolean;
@@ -1849,6 +1887,9 @@ declare const GridPro_base: (new (...args: any[]) => {
1849
1887
  spellcheck: boolean;
1850
1888
  title: string;
1851
1889
  translate: boolean;
1890
+ /**
1891
+ * If true, will enable row flashing for all rows for `add` async transactions
1892
+ */
1852
1893
  attachInternals(): ElementInternals;
1853
1894
  click(): void;
1854
1895
  addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
@@ -1859,11 +1900,6 @@ declare const GridPro_base: (new (...args: any[]) => {
1859
1900
  readonly classList: DOMTokenList;
1860
1901
  className: string;
1861
1902
  readonly clientHeight: number;
1862
- /**
1863
- * The row data to display in the grid.
1864
- * @remarks For scenarios where you want to set data manually, without relying on `<grid-pro-client-side-datasource>`.
1865
- * @public
1866
- */
1867
1903
  readonly clientLeft: number;
1868
1904
  readonly clientTop: number;
1869
1905
  readonly clientWidth: number;
@@ -1955,14 +1991,7 @@ declare const GridPro_base: (new (...args: any[]) => {
1955
1991
  lookupPrefix(namespace: string): string;
1956
1992
  normalize(): void;
1957
1993
  removeChild<T_3 extends Node>(child: T_3): T_3;
1958
- replaceChild<T_4 extends Node>(node: Node, child: T_4): T_4; /**
1959
- * Adds an event listener to the grid element.
1960
- * @param eventType - The event type to listen for. Recommened to use the `Events` from AG Grid.
1961
- * @param listener - The event listener to call when the event is fired.
1962
- * @param options - An options object that specifies characteristics about the event listener.
1963
- * @privateRemarks
1964
- * This will change once we do the AG Upgrade and `eventType` will be correctly typed.
1965
- */
1994
+ replaceChild<T_4 extends Node>(node: Node, child: T_4): T_4;
1966
1995
  readonly ATTRIBUTE_NODE: number;
1967
1996
  readonly CDATA_SECTION_NODE: number;
1968
1997
  readonly COMMENT_NODE: number;
@@ -2141,10 +2170,7 @@ declare const GridPro_base: (new (...args: any[]) => {
2141
2170
  onwaiting: (this: GlobalEventHandlers, ev: Event) => any;
2142
2171
  onwebkitanimationend: (this: GlobalEventHandlers, ev: Event) => any;
2143
2172
  onwebkitanimationiteration: (this: GlobalEventHandlers, ev: Event) => any;
2144
- onwebkitanimationstart: (this: GlobalEventHandlers, ev: Event) => any; /**
2145
- * Clears the local grid options, this is used to clear the grid options when the grid is restarted.
2146
- * @public
2147
- */
2173
+ onwebkitanimationstart: (this: GlobalEventHandlers, ev: Event) => any;
2148
2174
  onwebkittransitionend: (this: GlobalEventHandlers, ev: Event) => any;
2149
2175
  onwheel: (this: GlobalEventHandlers, ev: WheelEvent) => any;
2150
2176
  autofocus: boolean;
@@ -3131,6 +3157,7 @@ export declare enum GridProRendererTypes {
3131
3157
  editable = "editable",
3132
3158
  text = "text",
3133
3159
  select = "select",
3160
+ statusPill = "statusPill",
3134
3161
  dateEditor = "dateEditor",
3135
3162
  selectEditor = "selectEditor",
3136
3163
  numberEditor = "numberEditor",
@@ -4011,6 +4038,37 @@ export declare interface StatePersistence {
4011
4038
  */
4012
4039
  export declare const StatePersistence: InterfaceSymbol<StatePersistence>;
4013
4040
 
4041
+ /**
4042
+ * The AG Status Pill Renderer element.
4043
+ * @public
4044
+ * @tagname %%prefix%%-status-pill-renderer
4045
+ */
4046
+ export declare class StatusPillRenderer extends FoundationElement implements ICellRendererComp {
4047
+ params: StatusPillRendererParams;
4048
+ init(params: StatusPillRendererParams): void;
4049
+ getGui(): this;
4050
+ refresh(params: any): boolean;
4051
+ destroy(): void;
4052
+ }
4053
+
4054
+ /**
4055
+ * Parameters used to configure {@link StatusPillRenderer}
4056
+ * @public
4057
+ */
4058
+ export declare type StatusPillRendererParams = ICellRendererParams & {
4059
+ backgroundColor?: string;
4060
+ iconName?: string;
4061
+ iconSrc?: string;
4062
+ iconInitial?: string;
4063
+ iconInitialBackgroundColor?: string;
4064
+ justifyContent?: string;
4065
+ iconSize?: string;
4066
+ textColor?: string;
4067
+ text?: string;
4068
+ dateCountdown?: number;
4069
+ dateCountdownCompletedMessage?: string;
4070
+ };
4071
+
4014
4072
  /**
4015
4073
  * The AG String Editor element.
4016
4074
  * @public
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [agStatusPillRendererStyles](./grid-pro.agstatuspillrendererstyles.md)
4
+
5
+ ## agStatusPillRendererStyles variable
6
+
7
+ The Status Pill Renderer Styles.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ agStatusPillRendererStyles: import("@microsoft/fast-element").ElementStyles
13
+ ```
@@ -127,6 +127,16 @@ foundationGridComponents: {
127
127
  styles: import("@microsoft/fast-element").ElementStyles;
128
128
  template: import("@microsoft/fast-element").ViewTemplate<import("./cell-editors").StringEditor, any>;
129
129
  }, typeof import("./cell-editors").StringEditor>;
130
+ foundationStatusPillRenderer: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
131
+ baseName: string;
132
+ template: import("@microsoft/fast-element").ViewTemplate<any, any>;
133
+ styles: import("@microsoft/fast-element").ElementStyles;
134
+ }>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
135
+ baseName: string;
136
+ template: import("@microsoft/fast-element").ViewTemplate<any, any>;
137
+ styles: import("@microsoft/fast-element").ElementStyles;
138
+ }, typeof StatusPillRenderer>;
139
+ StatusPillRenderer: typeof StatusPillRenderer;
130
140
  register(container?: Container, ...rest: any[]): void;
131
141
  }
132
142
  ```
@@ -0,0 +1,26 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [foundationStatusPillRenderer](./grid-pro.foundationstatuspillrenderer.md)
4
+
5
+ ## foundationStatusPillRenderer variable
6
+
7
+ A function that returns a Foundation Status Pill Renderer registration for configuring the component with a DesignSystem.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ foundationStatusPillRenderer: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
13
+ baseName: string;
14
+ template: import("@microsoft/fast-element").ViewTemplate<any, any>;
15
+ styles: import("@microsoft/fast-element").ElementStyles;
16
+ }>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
17
+ baseName: string;
18
+ template: import("@microsoft/fast-element").ViewTemplate<any, any>;
19
+ styles: import("@microsoft/fast-element").ElementStyles;
20
+ }, typeof StatusPillRenderer>
21
+ ```
22
+
23
+ ## Remarks
24
+
25
+ HTML Element: &lt;<!-- -->foundation-status-pill-renderer<!-- -->&gt;
26
+
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [getStatusPillRendererTemplate](./grid-pro.getstatuspillrenderertemplate.md)
4
+
5
+ ## getStatusPillRendererTemplate variable
6
+
7
+ Get a Design System prefixed Status Pill template.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ getStatusPillRendererTemplate: (designSystem?: string) => import("@microsoft/fast-element").ViewTemplate<any, any>
13
+ ```
@@ -25,6 +25,7 @@ export declare enum GridProRendererTypes
25
25
  | numberEditor | <code>&quot;numberEditor&quot;</code> | |
26
26
  | select | <code>&quot;select&quot;</code> | |
27
27
  | selectEditor | <code>&quot;selectEditor&quot;</code> | |
28
+ | statusPill | <code>&quot;statusPill&quot;</code> | |
28
29
  | stringEditor | <code>&quot;stringEditor&quot;</code> | |
29
30
  | text | <code>&quot;text&quot;</code> | |
30
31
 
@@ -32,6 +32,7 @@
32
32
  | [ReloadStatusBarComponent](./grid-pro.reloadstatusbarcomponent.md) | A status bar component that shows a refresh icon to reload the grid data |
33
33
  | [SelectEditor](./grid-pro.selecteditor.md) | The AG Select Editor element. |
34
34
  | [SelectRenderer](./grid-pro.selectrenderer.md) | The AG Select Renderer element. |
35
+ | [StatusPillRenderer](./grid-pro.statuspillrenderer.md) | The AG Status Pill Renderer element. |
35
36
  | [StringEditor](./grid-pro.stringeditor.md) | The AG String Editor element. |
36
37
 
37
38
  ## Enumerations
@@ -92,6 +93,7 @@
92
93
  | [agNumberEditorStyles](./grid-pro.agnumbereditorstyles.md) | The AG Number Editor Styles. |
93
94
  | [agSelectEditorStyles](./grid-pro.agselecteditorstyles.md) | The AG Select Renderer Styles. |
94
95
  | [agSelectRendererStyles](./grid-pro.agselectrendererstyles.md) | The AG Select Renderer Styles. |
96
+ | [agStatusPillRendererStyles](./grid-pro.agstatuspillrendererstyles.md) | The Status Pill Renderer Styles. |
95
97
  | [agStringEditorStyles](./grid-pro.agstringeditorstyles.md) | The AG String Renderer Styles. |
96
98
  | [agThemeAlpineNofontsCSS](./grid-pro.agthemealpinenofontscss.md) | AG Alpine Theme (no fonts) CSS. |
97
99
  | [agThemeBalhamNofontsCSS](./grid-pro.agthemebalhamnofontscss.md) | AG Balham Theme (no fonts) CSS. |
@@ -127,6 +129,7 @@
127
129
  | [foundationMultiselectEditor](./grid-pro.foundationmultiselecteditor.md) | |
128
130
  | [foundationNumberEditor](./grid-pro.foundationnumbereditor.md) | |
129
131
  | [foundationSelectEditor](./grid-pro.foundationselecteditor.md) | |
132
+ | [foundationStatusPillRenderer](./grid-pro.foundationstatuspillrenderer.md) | A function that returns a Foundation Status Pill Renderer registration for configuring the component with a DesignSystem. |
130
133
  | [foundationStringEditor](./grid-pro.foundationstringeditor.md) | |
131
134
  | [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). |
132
135
  | [getAgBooleanRendererTemplate](./grid-pro.getagbooleanrenderertemplate.md) | Get a Design System prefixed Checkbox template. |
@@ -137,6 +140,7 @@
137
140
  | [getNumberEditorTemplate](./grid-pro.getnumbereditortemplate.md) | Get a Design System prefixed Select template. |
138
141
  | [getSelectEditorTemplate](./grid-pro.getselecteditortemplate.md) | Get a Design System prefixed Select template. |
139
142
  | [getSelectRendererTemplate](./grid-pro.getselectrenderertemplate.md) | Get a Design System prefixed Select template. |
143
+ | [getStatusPillRendererTemplate](./grid-pro.getstatuspillrenderertemplate.md) | Get a Design System prefixed Status Pill template. |
140
144
  | [getStringEditorTemplate](./grid-pro.getstringeditortemplate.md) | Get a Design System prefixed String template. |
141
145
  | [getTextFieldRendererTemplate](./grid-pro.gettextfieldrenderertemplate.md) | Get a Design System prefixed Text Field template. |
142
146
  | [getTextRendererTemplate](./grid-pro.gettextrenderertemplate.md) | |
@@ -169,4 +173,5 @@
169
173
  | [LoadMoreStatusBarParams](./grid-pro.loadmorestatusbarparams.md) | The parameters for the load more status bar component. |
170
174
  | [MoreRowsDetail](./grid-pro.morerowsdetail.md) | The Genesis Datasource event payload types. |
171
175
  | [ReloadStatusBarParams](./grid-pro.reloadstatusbarparams.md) | The parameters for the reload status bar component. |
176
+ | [StatusPillRendererParams](./grid-pro.statuspillrendererparams.md) | Parameters used to configure [StatusPillRenderer](./grid-pro.statuspillrenderer.md) |
172
177
 
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StatusPillRenderer](./grid-pro.statuspillrenderer.md) &gt; [destroy](./grid-pro.statuspillrenderer.destroy.md)
4
+
5
+ ## StatusPillRenderer.destroy() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ destroy(): void;
11
+ ```
12
+ **Returns:**
13
+
14
+ void
15
+
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StatusPillRenderer](./grid-pro.statuspillrenderer.md) &gt; [getGui](./grid-pro.statuspillrenderer.getgui.md)
4
+
5
+ ## StatusPillRenderer.getGui() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ getGui(): this;
11
+ ```
12
+ **Returns:**
13
+
14
+ this
15
+
@@ -0,0 +1,22 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StatusPillRenderer](./grid-pro.statuspillrenderer.md) &gt; [init](./grid-pro.statuspillrenderer.init.md)
4
+
5
+ ## StatusPillRenderer.init() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ init(params: StatusPillRendererParams): void;
11
+ ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | params | [StatusPillRendererParams](./grid-pro.statuspillrendererparams.md) | |
18
+
19
+ **Returns:**
20
+
21
+ void
22
+
@@ -0,0 +1,32 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StatusPillRenderer](./grid-pro.statuspillrenderer.md)
4
+
5
+ ## StatusPillRenderer class
6
+
7
+ The AG Status Pill Renderer element.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare class StatusPillRenderer extends FoundationElement implements ICellRendererComp
13
+ ```
14
+ **Extends:** FoundationElement
15
+
16
+ **Implements:** ICellRendererComp
17
+
18
+ ## Properties
19
+
20
+ | Property | Modifiers | Type | Description |
21
+ | --- | --- | --- | --- |
22
+ | [params](./grid-pro.statuspillrenderer.params.md) | | [StatusPillRendererParams](./grid-pro.statuspillrendererparams.md) | |
23
+
24
+ ## Methods
25
+
26
+ | Method | Modifiers | Description |
27
+ | --- | --- | --- |
28
+ | [destroy()](./grid-pro.statuspillrenderer.destroy.md) | | |
29
+ | [getGui()](./grid-pro.statuspillrenderer.getgui.md) | | |
30
+ | [init(params)](./grid-pro.statuspillrenderer.init.md) | | |
31
+ | [refresh(params)](./grid-pro.statuspillrenderer.refresh.md) | | |
32
+
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StatusPillRenderer](./grid-pro.statuspillrenderer.md) &gt; [params](./grid-pro.statuspillrenderer.params.md)
4
+
5
+ ## StatusPillRenderer.params property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ params: StatusPillRendererParams;
11
+ ```
@@ -0,0 +1,22 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StatusPillRenderer](./grid-pro.statuspillrenderer.md) &gt; [refresh](./grid-pro.statuspillrenderer.refresh.md)
4
+
5
+ ## StatusPillRenderer.refresh() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ refresh(params: any): boolean;
11
+ ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | params | any | |
18
+
19
+ **Returns:**
20
+
21
+ boolean
22
+
@@ -0,0 +1,25 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StatusPillRendererParams](./grid-pro.statuspillrendererparams.md)
4
+
5
+ ## StatusPillRendererParams type
6
+
7
+ Parameters used to configure [StatusPillRenderer](./grid-pro.statuspillrenderer.md)
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export type StatusPillRendererParams = ICellRendererParams & {
13
+ backgroundColor?: string;
14
+ iconName?: string;
15
+ iconSrc?: string;
16
+ iconInitial?: string;
17
+ iconInitialBackgroundColor?: string;
18
+ justifyContent?: string;
19
+ iconSize?: string;
20
+ textColor?: string;
21
+ text?: string;
22
+ dateCountdown?: number;
23
+ dateCountdownCompletedMessage?: string;
24
+ };
25
+ ```
@@ -258,6 +258,9 @@ export const agSelectEditorStyles: ElementStyles;
258
258
  // @public
259
259
  export const agSelectRendererStyles: ElementStyles;
260
260
 
261
+ // @public
262
+ export const agStatusPillRendererStyles: ElementStyles;
263
+
261
264
  // @public
262
265
  export const agStringEditorStyles: ElementStyles;
263
266
 
@@ -663,6 +666,16 @@ export const foundationGridComponents: {
663
666
  styles: ElementStyles;
664
667
  template: ViewTemplate<StringEditor, any>;
665
668
  }, StringEditor>;
669
+ foundationStatusPillRenderer: (overrideDefinition?: OverrideFoundationElementDefinition< {
670
+ baseName: string;
671
+ template: ViewTemplate<any, any>;
672
+ styles: ElementStyles;
673
+ }>) => FoundationElementRegistry< {
674
+ baseName: string;
675
+ template: ViewTemplate<any, any>;
676
+ styles: ElementStyles;
677
+ }, typeof StatusPillRenderer>;
678
+ StatusPillRenderer: typeof StatusPillRenderer;
666
679
  register(container?: Container, ...rest: any[]): void;
667
680
  };
668
681
 
@@ -738,6 +751,17 @@ styles: ElementStyles;
738
751
  template: ViewTemplate<SelectEditor, any>;
739
752
  }, typeof SelectEditor>;
740
753
 
754
+ // @public
755
+ export const foundationStatusPillRenderer: (overrideDefinition?: OverrideFoundationElementDefinition< {
756
+ baseName: string;
757
+ template: ViewTemplate<any, any>;
758
+ styles: ElementStyles;
759
+ }>) => FoundationElementRegistry< {
760
+ baseName: string;
761
+ template: ViewTemplate<any, any>;
762
+ styles: ElementStyles;
763
+ }, typeof StatusPillRenderer>;
764
+
741
765
  // @public (undocumented)
742
766
  export const foundationStringEditor: (overrideDefinition?: OverrideFoundationElementDefinition< {
743
767
  baseName: string;
@@ -853,6 +877,9 @@ export const getSelectEditorTemplate: (designSystem?: string) => ViewTemplate<Se
853
877
  // @public
854
878
  export const getSelectRendererTemplate: (designSystem?: string) => ViewTemplate<any, any>;
855
879
 
880
+ // @public
881
+ export const getStatusPillRendererTemplate: (designSystem?: string) => ViewTemplate<any, any>;
882
+
856
883
  // @public
857
884
  export const getStringEditorTemplate: (designSystem?: string) => ViewTemplate<StringEditor, any>;
858
885
 
@@ -1231,6 +1258,8 @@ export enum GridProRendererTypes {
1231
1258
  // (undocumented)
1232
1259
  selectEditor = "selectEditor",
1233
1260
  // (undocumented)
1261
+ statusPill = "statusPill",
1262
+ // (undocumented)
1234
1263
  stringEditor = "stringEditor",
1235
1264
  // (undocumented)
1236
1265
  text = "text"
@@ -1648,6 +1677,35 @@ export interface StatePersistence {
1648
1677
  // @internal
1649
1678
  export const StatePersistence: InterfaceSymbol<StatePersistence>;
1650
1679
 
1680
+ // @public
1681
+ export class StatusPillRenderer extends FoundationElement implements ICellRendererComp {
1682
+ // (undocumented)
1683
+ destroy(): void;
1684
+ // (undocumented)
1685
+ getGui(): this;
1686
+ // (undocumented)
1687
+ init(params: StatusPillRendererParams): void;
1688
+ // (undocumented)
1689
+ params: StatusPillRendererParams;
1690
+ // (undocumented)
1691
+ refresh(params: any): boolean;
1692
+ }
1693
+
1694
+ // @public
1695
+ export type StatusPillRendererParams = ICellRendererParams & {
1696
+ backgroundColor?: string;
1697
+ iconName?: string;
1698
+ iconSrc?: string;
1699
+ iconInitial?: string;
1700
+ iconInitialBackgroundColor?: string;
1701
+ justifyContent?: string;
1702
+ iconSize?: string;
1703
+ textColor?: string;
1704
+ text?: string;
1705
+ dateCountdown?: number;
1706
+ dateCountdownCompletedMessage?: string;
1707
+ };
1708
+
1651
1709
  // @public
1652
1710
  export class StringEditor extends FoundationElement implements ICellEditorComp {
1653
1711
  // (undocumented)
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@genesislcap/grid-pro",
3
3
  "description": "Genesis Foundation AG Grid",
4
- "version": "14.283.2",
4
+ "version": "14.284.0",
5
5
  "sideEffects": false,
6
6
  "license": "SEE LICENSE IN license.txt",
7
7
  "main": "dist/esm/index.js",
@@ -38,20 +38,20 @@
38
38
  }
39
39
  },
40
40
  "devDependencies": {
41
- "@genesislcap/foundation-testing": "14.283.2",
42
- "@genesislcap/genx": "14.283.2",
43
- "@genesislcap/rollup-builder": "14.283.2",
44
- "@genesislcap/ts-builder": "14.283.2",
45
- "@genesislcap/uvu-playwright-builder": "14.283.2",
46
- "@genesislcap/vite-builder": "14.283.2",
47
- "@genesislcap/webpack-builder": "14.283.2",
41
+ "@genesislcap/foundation-testing": "14.284.0",
42
+ "@genesislcap/genx": "14.284.0",
43
+ "@genesislcap/rollup-builder": "14.284.0",
44
+ "@genesislcap/ts-builder": "14.284.0",
45
+ "@genesislcap/uvu-playwright-builder": "14.284.0",
46
+ "@genesislcap/vite-builder": "14.284.0",
47
+ "@genesislcap/webpack-builder": "14.284.0",
48
48
  "rimraf": "^5.0.0"
49
49
  },
50
50
  "dependencies": {
51
- "@genesislcap/foundation-comms": "14.283.2",
52
- "@genesislcap/foundation-logger": "14.283.2",
53
- "@genesislcap/foundation-ui": "14.283.2",
54
- "@genesislcap/foundation-utils": "14.283.2",
51
+ "@genesislcap/foundation-comms": "14.284.0",
52
+ "@genesislcap/foundation-logger": "14.284.0",
53
+ "@genesislcap/foundation-ui": "14.284.0",
54
+ "@genesislcap/foundation-utils": "14.284.0",
55
55
  "@microsoft/fast-colors": "5.3.1",
56
56
  "@microsoft/fast-components": "2.30.6",
57
57
  "@microsoft/fast-element": "1.14.0",
@@ -77,5 +77,5 @@
77
77
  "access": "public"
78
78
  },
79
79
  "customElements": "dist/custom-elements.json",
80
- "gitHead": "357e8a019efe0dfebe684827d6e844a4a8b249d7"
80
+ "gitHead": "a2b9ad74ad30820f7d9e2cbd1f88c8d89e182828"
81
81
  }