@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
@@ -2270,6 +2270,34 @@
2270
2270
  "endIndex": 3
2271
2271
  }
2272
2272
  },
2273
+ {
2274
+ "kind": "Variable",
2275
+ "canonicalReference": "@genesislcap/grid-pro!agStatusPillRendererStyles:var",
2276
+ "docComment": "/**\n * The Status Pill Renderer Styles.\n *\n * @public\n */\n",
2277
+ "excerptTokens": [
2278
+ {
2279
+ "kind": "Content",
2280
+ "text": "agStatusPillRendererStyles: "
2281
+ },
2282
+ {
2283
+ "kind": "Content",
2284
+ "text": "import(\"@microsoft/fast-element\")."
2285
+ },
2286
+ {
2287
+ "kind": "Reference",
2288
+ "text": "ElementStyles",
2289
+ "canonicalReference": "@microsoft/fast-element!ElementStyles:class"
2290
+ }
2291
+ ],
2292
+ "fileUrlPath": "src/cell-renderers/status-pill.renderer.ts",
2293
+ "isReadonly": true,
2294
+ "releaseTag": "Public",
2295
+ "name": "agStatusPillRendererStyles",
2296
+ "variableTypeTokenRange": {
2297
+ "startIndex": 1,
2298
+ "endIndex": 3
2299
+ }
2300
+ },
2273
2301
  {
2274
2302
  "kind": "Variable",
2275
2303
  "canonicalReference": "@genesislcap/grid-pro!agStringEditorStyles:var",
@@ -6195,7 +6223,79 @@
6195
6223
  },
6196
6224
  {
6197
6225
  "kind": "Content",
6198
- "text": ">;\n register(container?: "
6226
+ "text": ">;\n foundationStatusPillRenderer: (overrideDefinition?: import(\"@microsoft/fast-foundation\")."
6227
+ },
6228
+ {
6229
+ "kind": "Reference",
6230
+ "text": "OverrideFoundationElementDefinition",
6231
+ "canonicalReference": "@microsoft/fast-foundation!OverrideFoundationElementDefinition:type"
6232
+ },
6233
+ {
6234
+ "kind": "Content",
6235
+ "text": "<{\n baseName: string;\n template: import(\"@microsoft/fast-element\")."
6236
+ },
6237
+ {
6238
+ "kind": "Reference",
6239
+ "text": "ViewTemplate",
6240
+ "canonicalReference": "@microsoft/fast-element!ViewTemplate:class"
6241
+ },
6242
+ {
6243
+ "kind": "Content",
6244
+ "text": "<any, any>;\n styles: import(\"@microsoft/fast-element\")."
6245
+ },
6246
+ {
6247
+ "kind": "Reference",
6248
+ "text": "ElementStyles",
6249
+ "canonicalReference": "@microsoft/fast-element!ElementStyles:class"
6250
+ },
6251
+ {
6252
+ "kind": "Content",
6253
+ "text": ";\n }>) => import(\"@microsoft/fast-foundation\")."
6254
+ },
6255
+ {
6256
+ "kind": "Reference",
6257
+ "text": "FoundationElementRegistry",
6258
+ "canonicalReference": "@microsoft/fast-foundation!FoundationElementRegistry:class"
6259
+ },
6260
+ {
6261
+ "kind": "Content",
6262
+ "text": "<{\n baseName: string;\n template: import(\"@microsoft/fast-element\")."
6263
+ },
6264
+ {
6265
+ "kind": "Reference",
6266
+ "text": "ViewTemplate",
6267
+ "canonicalReference": "@microsoft/fast-element!ViewTemplate:class"
6268
+ },
6269
+ {
6270
+ "kind": "Content",
6271
+ "text": "<any, any>;\n styles: import(\"@microsoft/fast-element\")."
6272
+ },
6273
+ {
6274
+ "kind": "Reference",
6275
+ "text": "ElementStyles",
6276
+ "canonicalReference": "@microsoft/fast-element!ElementStyles:class"
6277
+ },
6278
+ {
6279
+ "kind": "Content",
6280
+ "text": ";\n }, typeof "
6281
+ },
6282
+ {
6283
+ "kind": "Reference",
6284
+ "text": "StatusPillRenderer",
6285
+ "canonicalReference": "@genesislcap/grid-pro!StatusPillRenderer:class"
6286
+ },
6287
+ {
6288
+ "kind": "Content",
6289
+ "text": ">;\n StatusPillRenderer: typeof "
6290
+ },
6291
+ {
6292
+ "kind": "Reference",
6293
+ "text": "StatusPillRenderer",
6294
+ "canonicalReference": "@genesislcap/grid-pro!StatusPillRenderer:class"
6295
+ },
6296
+ {
6297
+ "kind": "Content",
6298
+ "text": ";\n register(container?: "
6199
6299
  },
6200
6300
  {
6201
6301
  "kind": "Reference",
@@ -6213,7 +6313,7 @@
6213
6313
  "name": "foundationGridComponents",
6214
6314
  "variableTypeTokenRange": {
6215
6315
  "startIndex": 1,
6216
- "endIndex": 222
6316
+ "endIndex": 238
6217
6317
  }
6218
6318
  },
6219
6319
  {
@@ -6834,6 +6934,92 @@
6834
6934
  "endIndex": 20
6835
6935
  }
6836
6936
  },
6937
+ {
6938
+ "kind": "Variable",
6939
+ "canonicalReference": "@genesislcap/grid-pro!foundationStatusPillRenderer:var",
6940
+ "docComment": "/**\n * A function that returns a Foundation Status Pill Renderer registration for configuring the component with a DesignSystem.\n *\n * @remarks\n *\n * HTML Element: \\<foundation-status-pill-renderer\\>\n *\n * @public\n */\n",
6941
+ "excerptTokens": [
6942
+ {
6943
+ "kind": "Content",
6944
+ "text": "foundationStatusPillRenderer: "
6945
+ },
6946
+ {
6947
+ "kind": "Content",
6948
+ "text": "(overrideDefinition?: import(\"@microsoft/fast-foundation\")."
6949
+ },
6950
+ {
6951
+ "kind": "Reference",
6952
+ "text": "OverrideFoundationElementDefinition",
6953
+ "canonicalReference": "@microsoft/fast-foundation!OverrideFoundationElementDefinition:type"
6954
+ },
6955
+ {
6956
+ "kind": "Content",
6957
+ "text": "<{\n baseName: string;\n template: import(\"@microsoft/fast-element\")."
6958
+ },
6959
+ {
6960
+ "kind": "Reference",
6961
+ "text": "ViewTemplate",
6962
+ "canonicalReference": "@microsoft/fast-element!ViewTemplate:class"
6963
+ },
6964
+ {
6965
+ "kind": "Content",
6966
+ "text": "<any, any>;\n styles: import(\"@microsoft/fast-element\")."
6967
+ },
6968
+ {
6969
+ "kind": "Reference",
6970
+ "text": "ElementStyles",
6971
+ "canonicalReference": "@microsoft/fast-element!ElementStyles:class"
6972
+ },
6973
+ {
6974
+ "kind": "Content",
6975
+ "text": ";\n}>) => import(\"@microsoft/fast-foundation\")."
6976
+ },
6977
+ {
6978
+ "kind": "Reference",
6979
+ "text": "FoundationElementRegistry",
6980
+ "canonicalReference": "@microsoft/fast-foundation!FoundationElementRegistry:class"
6981
+ },
6982
+ {
6983
+ "kind": "Content",
6984
+ "text": "<{\n baseName: string;\n template: import(\"@microsoft/fast-element\")."
6985
+ },
6986
+ {
6987
+ "kind": "Reference",
6988
+ "text": "ViewTemplate",
6989
+ "canonicalReference": "@microsoft/fast-element!ViewTemplate:class"
6990
+ },
6991
+ {
6992
+ "kind": "Content",
6993
+ "text": "<any, any>;\n styles: import(\"@microsoft/fast-element\")."
6994
+ },
6995
+ {
6996
+ "kind": "Reference",
6997
+ "text": "ElementStyles",
6998
+ "canonicalReference": "@microsoft/fast-element!ElementStyles:class"
6999
+ },
7000
+ {
7001
+ "kind": "Content",
7002
+ "text": ";\n}, typeof "
7003
+ },
7004
+ {
7005
+ "kind": "Reference",
7006
+ "text": "StatusPillRenderer",
7007
+ "canonicalReference": "@genesislcap/grid-pro!StatusPillRenderer:class"
7008
+ },
7009
+ {
7010
+ "kind": "Content",
7011
+ "text": ">"
7012
+ }
7013
+ ],
7014
+ "fileUrlPath": "src/cell-renderers/status-pill.renderer.ts",
7015
+ "isReadonly": true,
7016
+ "releaseTag": "Public",
7017
+ "name": "foundationStatusPillRenderer",
7018
+ "variableTypeTokenRange": {
7019
+ "startIndex": 1,
7020
+ "endIndex": 16
7021
+ }
7022
+ },
6837
7023
  {
6838
7024
  "kind": "Variable",
6839
7025
  "canonicalReference": "@genesislcap/grid-pro!foundationStringEditor:var",
@@ -8458,6 +8644,38 @@
8458
8644
  "endIndex": 4
8459
8645
  }
8460
8646
  },
8647
+ {
8648
+ "kind": "Variable",
8649
+ "canonicalReference": "@genesislcap/grid-pro!getStatusPillRendererTemplate:var",
8650
+ "docComment": "/**\n * Get a Design System prefixed Status Pill template.\n *\n * @param designSystem - The design system prefix to use. Defaults to 'rapid'.\n *\n * @returns A Staus Pill component template prefixed with the correct design system.\n *\n * @public\n */\n",
8651
+ "excerptTokens": [
8652
+ {
8653
+ "kind": "Content",
8654
+ "text": "getStatusPillRendererTemplate: "
8655
+ },
8656
+ {
8657
+ "kind": "Content",
8658
+ "text": "(designSystem?: string) => import(\"@microsoft/fast-element\")."
8659
+ },
8660
+ {
8661
+ "kind": "Reference",
8662
+ "text": "ViewTemplate",
8663
+ "canonicalReference": "@microsoft/fast-element!ViewTemplate:class"
8664
+ },
8665
+ {
8666
+ "kind": "Content",
8667
+ "text": "<any, any>"
8668
+ }
8669
+ ],
8670
+ "fileUrlPath": "src/cell-renderers/status-pill.renderer.ts",
8671
+ "isReadonly": true,
8672
+ "releaseTag": "Public",
8673
+ "name": "getStatusPillRendererTemplate",
8674
+ "variableTypeTokenRange": {
8675
+ "startIndex": 1,
8676
+ "endIndex": 4
8677
+ }
8678
+ },
8461
8679
  {
8462
8680
  "kind": "Variable",
8463
8681
  "canonicalReference": "@genesislcap/grid-pro!getStringEditorTemplate:var",
@@ -14375,6 +14593,27 @@
14375
14593
  "releaseTag": "Public",
14376
14594
  "name": "selectEditor"
14377
14595
  },
14596
+ {
14597
+ "kind": "EnumMember",
14598
+ "canonicalReference": "@genesislcap/grid-pro!GridProRendererTypes.statusPill:member",
14599
+ "docComment": "",
14600
+ "excerptTokens": [
14601
+ {
14602
+ "kind": "Content",
14603
+ "text": "statusPill = "
14604
+ },
14605
+ {
14606
+ "kind": "Content",
14607
+ "text": "\"statusPill\""
14608
+ }
14609
+ ],
14610
+ "initializerTokenRange": {
14611
+ "startIndex": 1,
14612
+ "endIndex": 2
14613
+ },
14614
+ "releaseTag": "Public",
14615
+ "name": "statusPill"
14616
+ },
14378
14617
  {
14379
14618
  "kind": "EnumMember",
14380
14619
  "canonicalReference": "@genesislcap/grid-pro!GridProRendererTypes.stringEditor:member",
@@ -19441,6 +19680,273 @@
19441
19680
  ],
19442
19681
  "extendsTokenRanges": []
19443
19682
  },
19683
+ {
19684
+ "kind": "Class",
19685
+ "canonicalReference": "@genesislcap/grid-pro!StatusPillRenderer:class",
19686
+ "docComment": "/**\n * The AG Status Pill Renderer element.\n *\n * @tagname\n *\n * %%prefix%%-status-pill-renderer\n *\n * @public\n */\n",
19687
+ "excerptTokens": [
19688
+ {
19689
+ "kind": "Content",
19690
+ "text": "export declare class StatusPillRenderer extends "
19691
+ },
19692
+ {
19693
+ "kind": "Reference",
19694
+ "text": "FoundationElement",
19695
+ "canonicalReference": "@microsoft/fast-foundation!FoundationElement:class"
19696
+ },
19697
+ {
19698
+ "kind": "Content",
19699
+ "text": " implements "
19700
+ },
19701
+ {
19702
+ "kind": "Reference",
19703
+ "text": "ICellRendererComp",
19704
+ "canonicalReference": "@ag-grid-community/core!ICellRendererComp:interface"
19705
+ },
19706
+ {
19707
+ "kind": "Content",
19708
+ "text": " "
19709
+ }
19710
+ ],
19711
+ "fileUrlPath": "src/cell-renderers/status-pill.renderer.ts",
19712
+ "releaseTag": "Public",
19713
+ "isAbstract": false,
19714
+ "name": "StatusPillRenderer",
19715
+ "preserveMemberOrder": false,
19716
+ "members": [
19717
+ {
19718
+ "kind": "Method",
19719
+ "canonicalReference": "@genesislcap/grid-pro!StatusPillRenderer#destroy:member(1)",
19720
+ "docComment": "",
19721
+ "excerptTokens": [
19722
+ {
19723
+ "kind": "Content",
19724
+ "text": "destroy(): "
19725
+ },
19726
+ {
19727
+ "kind": "Content",
19728
+ "text": "void"
19729
+ },
19730
+ {
19731
+ "kind": "Content",
19732
+ "text": ";"
19733
+ }
19734
+ ],
19735
+ "isStatic": false,
19736
+ "returnTypeTokenRange": {
19737
+ "startIndex": 1,
19738
+ "endIndex": 2
19739
+ },
19740
+ "releaseTag": "Public",
19741
+ "isProtected": false,
19742
+ "overloadIndex": 1,
19743
+ "parameters": [],
19744
+ "isOptional": false,
19745
+ "isAbstract": false,
19746
+ "name": "destroy"
19747
+ },
19748
+ {
19749
+ "kind": "Method",
19750
+ "canonicalReference": "@genesislcap/grid-pro!StatusPillRenderer#getGui:member(1)",
19751
+ "docComment": "",
19752
+ "excerptTokens": [
19753
+ {
19754
+ "kind": "Content",
19755
+ "text": "getGui(): "
19756
+ },
19757
+ {
19758
+ "kind": "Content",
19759
+ "text": "this"
19760
+ },
19761
+ {
19762
+ "kind": "Content",
19763
+ "text": ";"
19764
+ }
19765
+ ],
19766
+ "isStatic": false,
19767
+ "returnTypeTokenRange": {
19768
+ "startIndex": 1,
19769
+ "endIndex": 2
19770
+ },
19771
+ "releaseTag": "Public",
19772
+ "isProtected": false,
19773
+ "overloadIndex": 1,
19774
+ "parameters": [],
19775
+ "isOptional": false,
19776
+ "isAbstract": false,
19777
+ "name": "getGui"
19778
+ },
19779
+ {
19780
+ "kind": "Method",
19781
+ "canonicalReference": "@genesislcap/grid-pro!StatusPillRenderer#init:member(1)",
19782
+ "docComment": "",
19783
+ "excerptTokens": [
19784
+ {
19785
+ "kind": "Content",
19786
+ "text": "init(params: "
19787
+ },
19788
+ {
19789
+ "kind": "Reference",
19790
+ "text": "StatusPillRendererParams",
19791
+ "canonicalReference": "@genesislcap/grid-pro!StatusPillRendererParams:type"
19792
+ },
19793
+ {
19794
+ "kind": "Content",
19795
+ "text": "): "
19796
+ },
19797
+ {
19798
+ "kind": "Content",
19799
+ "text": "void"
19800
+ },
19801
+ {
19802
+ "kind": "Content",
19803
+ "text": ";"
19804
+ }
19805
+ ],
19806
+ "isStatic": false,
19807
+ "returnTypeTokenRange": {
19808
+ "startIndex": 3,
19809
+ "endIndex": 4
19810
+ },
19811
+ "releaseTag": "Public",
19812
+ "isProtected": false,
19813
+ "overloadIndex": 1,
19814
+ "parameters": [
19815
+ {
19816
+ "parameterName": "params",
19817
+ "parameterTypeTokenRange": {
19818
+ "startIndex": 1,
19819
+ "endIndex": 2
19820
+ },
19821
+ "isOptional": false
19822
+ }
19823
+ ],
19824
+ "isOptional": false,
19825
+ "isAbstract": false,
19826
+ "name": "init"
19827
+ },
19828
+ {
19829
+ "kind": "Property",
19830
+ "canonicalReference": "@genesislcap/grid-pro!StatusPillRenderer#params:member",
19831
+ "docComment": "",
19832
+ "excerptTokens": [
19833
+ {
19834
+ "kind": "Content",
19835
+ "text": "params: "
19836
+ },
19837
+ {
19838
+ "kind": "Reference",
19839
+ "text": "StatusPillRendererParams",
19840
+ "canonicalReference": "@genesislcap/grid-pro!StatusPillRendererParams:type"
19841
+ },
19842
+ {
19843
+ "kind": "Content",
19844
+ "text": ";"
19845
+ }
19846
+ ],
19847
+ "isReadonly": false,
19848
+ "isOptional": false,
19849
+ "releaseTag": "Public",
19850
+ "name": "params",
19851
+ "propertyTypeTokenRange": {
19852
+ "startIndex": 1,
19853
+ "endIndex": 2
19854
+ },
19855
+ "isStatic": false,
19856
+ "isProtected": false,
19857
+ "isAbstract": false
19858
+ },
19859
+ {
19860
+ "kind": "Method",
19861
+ "canonicalReference": "@genesislcap/grid-pro!StatusPillRenderer#refresh:member(1)",
19862
+ "docComment": "",
19863
+ "excerptTokens": [
19864
+ {
19865
+ "kind": "Content",
19866
+ "text": "refresh(params: "
19867
+ },
19868
+ {
19869
+ "kind": "Content",
19870
+ "text": "any"
19871
+ },
19872
+ {
19873
+ "kind": "Content",
19874
+ "text": "): "
19875
+ },
19876
+ {
19877
+ "kind": "Content",
19878
+ "text": "boolean"
19879
+ },
19880
+ {
19881
+ "kind": "Content",
19882
+ "text": ";"
19883
+ }
19884
+ ],
19885
+ "isStatic": false,
19886
+ "returnTypeTokenRange": {
19887
+ "startIndex": 3,
19888
+ "endIndex": 4
19889
+ },
19890
+ "releaseTag": "Public",
19891
+ "isProtected": false,
19892
+ "overloadIndex": 1,
19893
+ "parameters": [
19894
+ {
19895
+ "parameterName": "params",
19896
+ "parameterTypeTokenRange": {
19897
+ "startIndex": 1,
19898
+ "endIndex": 2
19899
+ },
19900
+ "isOptional": false
19901
+ }
19902
+ ],
19903
+ "isOptional": false,
19904
+ "isAbstract": false,
19905
+ "name": "refresh"
19906
+ }
19907
+ ],
19908
+ "extendsTokenRange": {
19909
+ "startIndex": 1,
19910
+ "endIndex": 2
19911
+ },
19912
+ "implementsTokenRanges": [
19913
+ {
19914
+ "startIndex": 3,
19915
+ "endIndex": 4
19916
+ }
19917
+ ]
19918
+ },
19919
+ {
19920
+ "kind": "TypeAlias",
19921
+ "canonicalReference": "@genesislcap/grid-pro!StatusPillRendererParams:type",
19922
+ "docComment": "/**\n * Parameters used to configure {@link StatusPillRenderer}\n *\n * @public\n */\n",
19923
+ "excerptTokens": [
19924
+ {
19925
+ "kind": "Content",
19926
+ "text": "export type StatusPillRendererParams = "
19927
+ },
19928
+ {
19929
+ "kind": "Reference",
19930
+ "text": "ICellRendererParams",
19931
+ "canonicalReference": "@ag-grid-community/core!ICellRendererParams:interface"
19932
+ },
19933
+ {
19934
+ "kind": "Content",
19935
+ "text": " & {\n backgroundColor?: string;\n iconName?: string;\n iconSrc?: string;\n iconInitial?: string;\n iconInitialBackgroundColor?: string;\n justifyContent?: string;\n iconSize?: string;\n textColor?: string;\n text?: string;\n dateCountdown?: number;\n dateCountdownCompletedMessage?: string;\n}"
19936
+ },
19937
+ {
19938
+ "kind": "Content",
19939
+ "text": ";"
19940
+ }
19941
+ ],
19942
+ "fileUrlPath": "src/cell-renderers/status-pill.renderer.ts",
19943
+ "releaseTag": "Public",
19944
+ "name": "StatusPillRendererParams",
19945
+ "typeTokenRange": {
19946
+ "startIndex": 1,
19947
+ "endIndex": 3
19948
+ }
19949
+ },
19444
19950
  {
19445
19951
  "kind": "Class",
19446
19952
  "canonicalReference": "@genesislcap/grid-pro!StringEditor:class",