zinggrid-metadata 1.0.1 → 1.0.3

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.
@@ -43,7 +43,7 @@
43
43
  "nextpage": "Navigates to the next page",
44
44
  "openrowdetails": "Displaying details section of the row",
45
45
  "openrowgroup": "Displays the descdendent rows of the row",
46
- "page": "Navigates to page specified by `page",
46
+ "page": "Navigates to page specified by `page-index`",
47
47
  "pastecell": "Pastes content into the selected cell",
48
48
  "prevpage": "Navidate to the previous page",
49
49
  "reload": "Reloads the grid content",
@@ -238,7 +238,7 @@
238
238
  "id": "editor",
239
239
  "scope": "zg-card",
240
240
  "description": "Sets the custom editor",
241
- "type": "Function",
241
+ "type": "String",
242
242
  "enumValues": {},
243
243
  "defaultValue": "\"\"",
244
244
  "enabledByDefault": false,
@@ -257,7 +257,7 @@
257
257
  "id": "editor-template",
258
258
  "scope": "zg-card",
259
259
  "description": "Points to an external template element to be used as the template for the card's editor.",
260
- "type": "Function",
260
+ "type": "String",
261
261
  "enumValues": {},
262
262
  "defaultValue": "\"\"",
263
263
  "enabledByDefault": false,
@@ -276,7 +276,7 @@
276
276
  "id": "renderer",
277
277
  "scope": "zg-card",
278
278
  "description": "The return value of the method is set as the innerHTML of `<zg-card>`. If nothing is returned,\nit will not change the currently rendered card. The method takes the parameters `data`, `domCard`, and `rowObject`.",
279
- "type": "Function",
279
+ "type": "String",
280
280
  "enumValues": {},
281
281
  "defaultValue": "\"\"",
282
282
  "enabledByDefault": false,
@@ -295,7 +295,7 @@
295
295
  "id": "renderer-template",
296
296
  "scope": "zg-card",
297
297
  "description": "Points to an external template element to be used as the template for the card's render.",
298
- "type": "Function",
298
+ "type": "String",
299
299
  "enumValues": {},
300
300
  "defaultValue": "\"\"",
301
301
  "enabledByDefault": false,
@@ -700,7 +700,7 @@
700
700
  "description": "Sets the style to use for the tooltips. Uses the `default` style by default. Can set to `system` to match the tooltips used on icons throughout `<zing-grid>`.",
701
701
  "type": "String",
702
702
  "enumValues": {
703
- "default": "The default styling applied to <zg",
703
+ "default": "The default styling applied to <zg-tooltip>, featuring a white background, gray border, and black text.",
704
704
  "system": "Features a dark background and white text."
705
705
  },
706
706
  "defaultValue": "default",
@@ -956,7 +956,7 @@
956
956
  "id": "filter-buttons",
957
957
  "scope": "zg-column",
958
958
  "description": "Comma separated list of buttons to display on the filter menu",
959
- "type": "String | Array",
959
+ "type": "String",
960
960
  "enumValues": {
961
961
  "reset": "Add button to reset filter condition(s)",
962
962
  "close": "Add button to close filter menu",
@@ -1306,7 +1306,7 @@
1306
1306
  "id": "filterer",
1307
1307
  "scope": "zg-column",
1308
1308
  "description": "Overrides the default filterer for the column. Can be set to a different built-in filterer or to a custom filterer<br>\nIf set to a custom filterer, the attribute value should either be set to the object that contains: `init`, `afterInit`, `value`, `setValue`, and `triggerEvent`\nOR it can be set to a function that will be used for the `value` method which will fire on filter change.\nNote that the custom filterer only applies to the inline filter and not the conditions or select box options (filter menu).",
1309
- "type": "Function",
1309
+ "type": "String",
1310
1310
  "enumValues": {},
1311
1311
  "defaultValue": false,
1312
1312
  "enabledByDefault": false,
@@ -1333,7 +1333,7 @@
1333
1333
  "avg": "computes the average value",
1334
1334
  "max": "displays the maximum value",
1335
1335
  "min": "displays the minimum value",
1336
- "count": "displays the number of non"
1336
+ "count": "displays the number of non-null values"
1337
1337
  },
1338
1338
  "defaultValue": "\"\"",
1339
1339
  "enabledByDefault": false,
@@ -1408,7 +1408,7 @@
1408
1408
  "avg": "computes the average value",
1409
1409
  "max": "displays the maximum value",
1410
1410
  "min": "displays the minimum value",
1411
- "count": "displays the number of non"
1411
+ "count": "displays the number of non-null values"
1412
1412
  },
1413
1413
  "defaultValue": "\"\"",
1414
1414
  "enabledByDefault": false,
@@ -1439,7 +1439,7 @@
1439
1439
  "avg": "computes the average value",
1440
1440
  "max": "displays the maximum value",
1441
1441
  "min": "displays the minimum value",
1442
- "count": "displays the number of non"
1442
+ "count": "displays the number of non-null values"
1443
1443
  },
1444
1444
  "defaultValue": "\"\"",
1445
1445
  "enabledByDefault": false,
@@ -1511,7 +1511,7 @@
1511
1511
  "enumValues": {
1512
1512
  "left": "Places icon left of header text",
1513
1513
  "right": "Places icon right of header text",
1514
- "\"after": "text\""
1514
+ "after-text": "Places icon right after header text"
1515
1515
  },
1516
1516
  "defaultValue": "\"left\"",
1517
1517
  "enabledByDefault": false,
@@ -1632,7 +1632,7 @@
1632
1632
  "enumValues": {
1633
1633
  "left": "Positions the icon to the left of the header",
1634
1634
  "right": "Positions the icon to the right of the header",
1635
- "\"after": "text\""
1635
+ "after-text": "Positions the icon after the header text"
1636
1636
  },
1637
1637
  "defaultValue": "\"right\"",
1638
1638
  "enabledByDefault": false,
@@ -1813,7 +1813,7 @@
1813
1813
  "description": "Sets the style to use for the tooltips. Uses the `default` style by default. Can set to `system` to match the tooltips used on icons throughout `<zing-grid>`.",
1814
1814
  "type": "String",
1815
1815
  "enumValues": {
1816
- "default": "The default styling applied to <zg",
1816
+ "default": "The default styling applied to <zg-tooltip>, featuring a white background, gray border, and black text.",
1817
1817
  "system": "Features a dark background and white text."
1818
1818
  },
1819
1819
  "defaultValue": "default",
@@ -1971,17 +1971,13 @@
1971
1971
  "defaultValue": "\"\"",
1972
1972
  "enabledByDefault": false,
1973
1973
  "eabledBy": [],
1974
- "alternativeAttributes": [
1975
- "renderer-template"
1976
- ],
1977
- "relatedAttributes": [
1978
- "editor-template"
1979
- ],
1974
+ "alternativeAttributes": [],
1975
+ "relatedAttributes": [],
1980
1976
  "analogousAttributes": [],
1981
1977
  "cascades": {},
1982
1978
  "deprecated": false,
1983
- "severity": "w",
1984
- "notes": "R"
1979
+ "severity": "warning",
1980
+ "notes": "Recommended to check and use built-in features, before using this for a custom solution."
1985
1981
  },
1986
1982
  {
1987
1983
  "id": "renderer-template",
@@ -2001,8 +1997,8 @@
2001
1997
  "analogousAttributes": [],
2002
1998
  "cascades": {},
2003
1999
  "deprecated": false,
2004
- "severity": "w",
2005
- "notes": "R"
2000
+ "severity": "info",
2001
+ "notes": ""
2006
2002
  },
2007
2003
  {
2008
2004
  "id": "required",
@@ -2045,7 +2041,7 @@
2045
2041
  "analogousAttributes": [],
2046
2042
  "cascades": {
2047
2043
  "from": [
2048
- "zing-grid:columnResizable"
2044
+ "zing-grid:column-resizable"
2049
2045
  ]
2050
2046
  },
2051
2047
  "deprecated": false,
@@ -2317,7 +2313,9 @@
2317
2313
  "radio": "Renders a text value that uses a radio editor",
2318
2314
  "range": "Renders a number value that uses a numeric stepper editor",
2319
2315
  "remover": "Displays a button to remove the row",
2320
- "\"row": "number\"",
2316
+ "row-details": "Renders an expandable/collapsible details section",
2317
+ "row-group": "Renders an expandable/collapsible group row",
2318
+ "row-number": "Displays the row index",
2321
2319
  "select": "Renders a text value that uses a select dropdown as an editor",
2322
2320
  "selector": "Displays checkbox for selecting the row",
2323
2321
  "tel": "Renders a telephone input",
@@ -2339,7 +2337,7 @@
2339
2337
  "cascades": {},
2340
2338
  "deprecated": false,
2341
2339
  "severity": "info",
2342
- "notes": "B"
2340
+ "notes": "By default, columns with all numeric values use the number type; otherwise, they use text."
2343
2341
  },
2344
2342
  {
2345
2343
  "id": "type-aggregate-omit",
@@ -2371,7 +2369,7 @@
2371
2369
  "avg": "computes the average value",
2372
2370
  "max": "displays the maximum value",
2373
2371
  "min": "displays the minimum value",
2374
- "count": "displays the number of non"
2372
+ "count": "displays the number of non-null values"
2375
2373
  },
2376
2374
  "defaultValue": "undefined",
2377
2375
  "enabledByDefault": false,
@@ -2387,7 +2385,7 @@
2387
2385
  "cascades": {},
2388
2386
  "deprecated": false,
2389
2387
  "severity": "info",
2390
- "notes": "T"
2388
+ "notes": "Tokens are enum values enclosed in square brackets (e.g., [[avg]])"
2391
2389
  },
2392
2390
  {
2393
2391
  "id": "type-button-disabled",
@@ -2408,7 +2406,7 @@
2408
2406
  "cascades": {},
2409
2407
  "deprecated": false,
2410
2408
  "severity": "info",
2411
- "notes": "T"
2409
+ "notes": "The related attributes listed are disabled when button is in disabled state."
2412
2410
  },
2413
2411
  {
2414
2412
  "id": "type-button-handler",
@@ -2469,7 +2467,7 @@
2469
2467
  "cascades": {},
2470
2468
  "deprecated": false,
2471
2469
  "severity": "info",
2472
- "notes": "B"
2470
+ "notes": "By default, the button label displays the data value. Use tokens to reference specific values. For example, \n[[index.INDEX]] references the index within index, and [[record.INDEX]] references the index within the record."
2473
2471
  },
2474
2472
  {
2475
2473
  "id": "type-button-tooltip",
@@ -2744,9 +2742,7 @@
2744
2742
  "scope": "zg-column",
2745
2743
  "description": "Sets a \"square\" ratio instead of the default \"16:9\"",
2746
2744
  "type": "String",
2747
- "enumValues": {
2748
- "": "Sets a \"square\" ratio on iframe"
2749
- },
2745
+ "enumValues": {},
2750
2746
  "defaultValue": "\"\"",
2751
2747
  "enabledByDefault": false,
2752
2748
  "eabledBy": [],
@@ -3075,7 +3071,7 @@
3075
3071
  "id": "type-select-options",
3076
3072
  "scope": "zg-column",
3077
3073
  "description": "To set the options for the select box for a `select` column when `editor` is enabled on `<zing-grid>`.\nCan also set as array of name/value pairs where the name is displayed for the given value",
3078
- "type": "String | Array",
3074
+ "type": "Array | String",
3079
3075
  "enumValues": {},
3080
3076
  "defaultValue": "\"Generate from unique column values\"",
3081
3077
  "enabledByDefault": false,
@@ -3091,7 +3087,7 @@
3091
3087
  "cascades": {},
3092
3088
  "deprecated": false,
3093
3089
  "severity": "info",
3094
- "notes": "O"
3090
+ "notes": "Options are generated from unique column values."
3095
3091
  },
3096
3092
  {
3097
3093
  "id": "type-selector-page-persist",
@@ -3155,7 +3151,7 @@
3155
3151
  "type": "String",
3156
3152
  "enumValues": {
3157
3153
  "link": "Displays a \"link\" icon, implying navigating within same site",
3158
- "outsidearrow": "Displays an \"outsidearrow\" icon, implying redirecting to third"
3154
+ "outsidearrow": "Displays an \"outsidearrow\" icon, implying redirecting to third-party site"
3159
3155
  },
3160
3156
  "defaultValue": "\"\"",
3161
3157
  "enabledByDefault": false,
@@ -3289,8 +3285,8 @@
3289
3285
  "fit": "Sets width of column to fit both the header and content",
3290
3286
  "fitheader": "Sets width of column to fit header",
3291
3287
  "fitcontent": "Sets width of column to fit content",
3292
- "\"max": "content\"",
3293
- "\"min": "content\"",
3288
+ "max-content": "Sets width of column to fit the maximum size of the content",
3289
+ "min-content": "Sets width of column to fit the minimum size of the content",
3294
3290
  "stretch": "Sets width of column to stretch to remainder of the grid's width"
3295
3291
  },
3296
3292
  "defaultValue": "fit",
@@ -4005,7 +4001,7 @@
4005
4001
  "id": "data",
4006
4002
  "scope": "zg-data",
4007
4003
  "description": "Data for the grid presented as an array or object. If set as an attribute value, the\ndata needs to be in JSON format.",
4008
- "type": "Object",
4004
+ "type": "Array | Object",
4009
4005
  "enumValues": {},
4010
4006
  "defaultValue": "\"\"",
4011
4007
  "enabledByDefault": false,
@@ -4339,7 +4335,8 @@
4339
4335
  "description": "Determines which type of pagination to use, input or buttons",
4340
4336
  "type": "String",
4341
4337
  "enumValues": {
4342
- "\"button": "arrows\""
4338
+ "button-text": "applies pager with \"previous\" and \"next\" buttons",
4339
+ "button-arrows": "applies pager with arrow buttons"
4343
4340
  },
4344
4341
  "defaultValue": "\"\"",
4345
4342
  "enabledByDefault": false,
@@ -4453,7 +4450,7 @@
4453
4450
  "id": "adapter",
4454
4451
  "scope": "zg-param:name",
4455
4452
  "description": "Adapter is a shortcut to set known options for specific third party datasets. Currently supports `graphql` and `firebase`.\nDevelopers could register their own custom adapters. For more information on custom adapters, visit Docs > Features > Adapters to learn how to \nyour own custom adapter and Docs > API > Methods > ZingGrid Object > registerAdapter() to register it.",
4456
- "type": "<string>",
4453
+ "type": "String",
4457
4454
  "enumValues": {},
4458
4455
  "defaultValue": false,
4459
4456
  "enabledByDefault": false,
@@ -4470,7 +4467,7 @@
4470
4467
  "id": "idKey",
4471
4468
  "scope": "zg-param:name",
4472
4469
  "description": "In the case of non-key based objects, the idKey can be set to indicate the id to send back to the datasource on CRUD commands.\nFor example, if the READ URL was https://zinggrid-named.firebaseio.com/ then the UPDATE would be https://zinggrid-named.firebaseio.com/VALUE_OF_IDKEY.",
4473
- "type": "<string>",
4470
+ "type": "String",
4474
4471
  "enumValues": {},
4475
4472
  "defaultValue": false,
4476
4473
  "enabledByDefault": false,
@@ -4501,7 +4498,7 @@
4501
4498
  "id": "newIndexPath",
4502
4499
  "scope": "zg-param:name",
4503
4500
  "description": "Specifies the path of the insert or CREATE response that returns an object to indicate the key value of the new record.\nBy default, it is set to the idKey or the raw value of the response so it would not be necessary to set this property.",
4504
- "type": "<string>",
4501
+ "type": "String",
4505
4502
  "enumValues": {},
4506
4503
  "defaultValue": false,
4507
4504
  "enabledByDefault": false,
@@ -4522,7 +4519,7 @@
4522
4519
  "id": "recordPath",
4523
4520
  "scope": "zg-param:name",
4524
4521
  "description": "Sets the path of the JSON object response to where the grid data is located. When not specified,\nit is assumed that the whole JSON object response is the grid data. This value takes in dot notation.",
4525
- "type": "<string>",
4522
+ "type": "String",
4526
4523
  "enumValues": {},
4527
4524
  "defaultValue": false,
4528
4525
  "enabledByDefault": false,
@@ -4541,7 +4538,7 @@
4541
4538
  "id": "nodePath",
4542
4539
  "scope": "zg-param:name",
4543
4540
  "description": "Sets the path of the JSON object within the array. When not specified,\nit is assumed that the array contains the JSON object. This value takes in dot notation.",
4544
- "type": "<string>",
4541
+ "type": "String",
4545
4542
  "enumValues": {},
4546
4543
  "defaultValue": false,
4547
4544
  "enabledByDefault": false,
@@ -4560,7 +4557,7 @@
4560
4557
  "id": "searchKey",
4561
4558
  "scope": "zg-param:name",
4562
4559
  "description": "The query parameter to specify the search value",
4563
- "type": "<string>",
4560
+ "type": "String",
4564
4561
  "enumValues": {},
4565
4562
  "defaultValue": false,
4566
4563
  "enabledByDefault": false,
@@ -4583,7 +4580,7 @@
4583
4580
  "id": "search",
4584
4581
  "scope": "zg-param:name",
4585
4582
  "description": "The value to search by. This is automatically generated when search using `<zg-search>`, but the developer\nhas option to specify if preferred.",
4586
- "type": "<string>",
4583
+ "type": "String",
4587
4584
  "enumValues": {},
4588
4585
  "defaultValue": false,
4589
4586
  "enabledByDefault": false,
@@ -4605,7 +4602,7 @@
4605
4602
  "id": "serverFilter",
4606
4603
  "scope": "zg-param:name",
4607
4604
  "description": "Boolean value indicating that filtering should take place on the server. Requires `loadByPage` to be enabled.",
4608
- "type": "<boolean>",
4605
+ "type": "Boolean",
4609
4606
  "enumValues": {},
4610
4607
  "defaultValue": false,
4611
4608
  "enabledByDefault": false,
@@ -4625,7 +4622,7 @@
4625
4622
  "id": "filterFunction",
4626
4623
  "scope": "zg-param:name",
4627
4624
  "description": "This specifies a function to call to build the url for filtering on server side filter.\nThe function takes in a `filterObj` and is expected to return a URL query string or an object of name/pair values.",
4628
- "type": "<string>",
4625
+ "type": "String",
4629
4626
  "enumValues": {},
4630
4627
  "defaultValue": false,
4631
4628
  "enabledByDefault": false,
@@ -4650,7 +4647,7 @@
4650
4647
  "id": "sortByKey",
4651
4648
  "scope": "zg-param:name",
4652
4649
  "description": "The query parameter to specify the sort field",
4653
- "type": "<string>",
4650
+ "type": "String",
4654
4651
  "enumValues": {},
4655
4652
  "defaultValue": false,
4656
4653
  "enabledByDefault": false,
@@ -4674,7 +4671,7 @@
4674
4671
  "id": "sortBy",
4675
4672
  "scope": "zg-param:name",
4676
4673
  "description": "Specifies the property to sort on. This is automatically generated on column sort.",
4677
- "type": "<string>",
4674
+ "type": "String",
4678
4675
  "enumValues": {},
4679
4676
  "defaultValue": false,
4680
4677
  "enabledByDefault": false,
@@ -4698,7 +4695,7 @@
4698
4695
  "id": "sortDirKey",
4699
4696
  "scope": "zg-param:name",
4700
4697
  "description": "The query parameter that specifies sort direction",
4701
- "type": "<string>",
4698
+ "type": "String",
4702
4699
  "enumValues": {},
4703
4700
  "defaultValue": false,
4704
4701
  "enabledByDefault": false,
@@ -4722,7 +4719,7 @@
4722
4719
  "id": "sortDir",
4723
4720
  "scope": "zg-param:name",
4724
4721
  "description": "Sets the sort direction. This is automatically generated on column sort.",
4725
- "type": "<string>",
4722
+ "type": "String",
4726
4723
  "enumValues": {},
4727
4724
  "defaultValue": false,
4728
4725
  "enabledByDefault": false,
@@ -4743,7 +4740,7 @@
4743
4740
  "id": "batchEditStatus",
4744
4741
  "scope": "zg-param:name",
4745
4742
  "description": "Sets the status message for batch editing",
4746
- "type": "<string>",
4743
+ "type": "String",
4747
4744
  "enumValues": {},
4748
4745
  "defaultValue": false,
4749
4746
  "enabledByDefault": false,
@@ -4760,7 +4757,7 @@
4760
4757
  "id": "startAtKey",
4761
4758
  "scope": "zg-param:name",
4762
4759
  "description": "The query parameter that specifies the start location. Must specify either nextPath, nextIDPath, pageKey\nor startAtKey when using loadByPage or loadByScroll.",
4763
- "type": "<string>",
4760
+ "type": "String",
4764
4761
  "enumValues": {},
4765
4762
  "defaultValue": false,
4766
4763
  "enabledByDefault": false,
@@ -4785,7 +4782,7 @@
4785
4782
  "id": "startAtValue",
4786
4783
  "scope": "zg-param:name",
4787
4784
  "description": "Boolean value indicating that a value is required (instead of an index) for the next start value",
4788
- "type": "<boolean>",
4785
+ "type": "Boolean",
4789
4786
  "enumValues": {},
4790
4787
  "defaultValue": false,
4791
4788
  "enabledByDefault": false,
@@ -4804,7 +4801,7 @@
4804
4801
  "id": "limitToKey",
4805
4802
  "scope": "zg-param:name",
4806
4803
  "description": "The query parameter to specify limitTo amount. Required to be used in loadByScroll or loadByPage.",
4807
- "type": "<string>",
4804
+ "type": "String",
4808
4805
  "enumValues": {},
4809
4806
  "defaultValue": false,
4810
4807
  "enabledByDefault": false,
@@ -4831,7 +4828,7 @@
4831
4828
  "id": "limitTo",
4832
4829
  "scope": "zg-param:name",
4833
4830
  "description": "Sets the page size. Uses ZingGrid page size by default, so `should not set`.",
4834
- "type": "<number>",
4831
+ "type": "Number",
4835
4832
  "enumValues": {},
4836
4833
  "defaultValue": false,
4837
4834
  "enabledByDefault": false,
@@ -4857,7 +4854,7 @@
4857
4854
  "id": "offsetKey",
4858
4855
  "scope": "zg-param:name",
4859
4856
  "description": "The query paramter to specify offsetValue amount. The default if \"offset\".",
4860
- "type": "<number>",
4857
+ "type": "Number",
4861
4858
  "enumValues": {},
4862
4859
  "defaultValue": false,
4863
4860
  "enabledByDefault": false,
@@ -4884,7 +4881,7 @@
4884
4881
  "id": "offsetValue",
4885
4882
  "scope": "zg-param:name",
4886
4883
  "description": "Sets the offset or number of records to skip",
4887
- "type": "<number>",
4884
+ "type": "Number",
4888
4885
  "enumValues": {},
4889
4886
  "defaultValue": false,
4890
4887
  "enabledByDefault": false,
@@ -4910,7 +4907,7 @@
4910
4907
  "id": "pageKey",
4911
4908
  "scope": "zg-param:name",
4912
4909
  "description": "The query parameter to specify the page. Must specify either nextPath, nextIDPath, pageKey\nor startAtKey when using loadByPage or loadByScroll.",
4913
- "type": "<number>",
4910
+ "type": "Number",
4914
4911
  "enumValues": {},
4915
4912
  "defaultValue": false,
4916
4913
  "enabledByDefault": false,
@@ -4940,7 +4937,7 @@
4940
4937
  "id": "countPath",
4941
4938
  "scope": "zg-param:name",
4942
4939
  "description": "Sets the value to path of the total count of records.",
4943
- "type": "<string>",
4940
+ "type": "String",
4944
4941
  "enumValues": {},
4945
4942
  "defaultValue": false,
4946
4943
  "enabledByDefault": false,
@@ -4965,7 +4962,7 @@
4965
4962
  "id": "cursor",
4966
4963
  "scope": "zg-param:name",
4967
4964
  "description": "Boolean indicating if we should handle the loadByPage as cursor-based. \nIf set to true, no count or number of pages will be displayed. Used in loadByPage",
4968
- "type": "<boolean>",
4965
+ "type": "Boolean",
4969
4966
  "enumValues": {},
4970
4967
  "defaultValue": false,
4971
4968
  "enabledByDefault": false,
@@ -4991,7 +4988,7 @@
4991
4988
  "id": "loadByPage",
4992
4989
  "scope": "zg-param:name",
4993
4990
  "description": "Boolean value enabling each page of data to be retrieved from server. Requires setting sortBy in Firebase. \nMust specify either nextPath, nextIDPath, pageKey or startAtKey when using loadByPage.",
4994
- "type": "<boolean>",
4991
+ "type": "Boolean",
4995
4992
  "enumValues": {},
4996
4993
  "defaultValue": false,
4997
4994
  "enabledByDefault": false,
@@ -5021,7 +5018,7 @@
5021
5018
  "id": "loadByScroll",
5022
5019
  "scope": "zg-param:name",
5023
5020
  "description": "Boolean value enabling infinite scrolling. Enabling infinite scrolling requires setting `height` on `<zing-grid>` and \nalso setting the following: limitToKey, startAtKey, sortByKey, startAtValue, and sortBy. The first four are set when using Firebase adapter.\nMust specify either nextPath, nextIDPath, pageKey or startAtKey when using loadByScroll.",
5024
- "type": "<boolean>",
5021
+ "type": "Boolean",
5025
5022
  "enumValues": {},
5026
5023
  "defaultValue": false,
5027
5024
  "enabledByDefault": false,
@@ -5046,7 +5043,7 @@
5046
5043
  "id": "hasNextPath",
5047
5044
  "scope": "zg-param:name",
5048
5045
  "description": "Path to check if there is more data.",
5049
- "type": "<string>",
5046
+ "type": "String",
5050
5047
  "enumValues": {},
5051
5048
  "defaultValue": false,
5052
5049
  "enabledByDefault": false,
@@ -5071,7 +5068,7 @@
5071
5068
  "id": "nextPath",
5072
5069
  "scope": "zg-param:name",
5073
5070
  "description": "If set, looks at response packet for full link to next path. Must specify either nextPath, nextIDPath, pageKey\nor startAtKey when using loadByPage.",
5074
- "type": "<string>",
5071
+ "type": "String",
5075
5072
  "enumValues": {},
5076
5073
  "defaultValue": false,
5077
5074
  "enabledByDefault": false,
@@ -5096,7 +5093,7 @@
5096
5093
  "id": "nextIDPath",
5097
5094
  "scope": "zg-param:name",
5098
5095
  "description": "If set, looks at response packet for ID to next path.",
5099
- "type": "<string>",
5096
+ "type": "String",
5100
5097
  "enumValues": {},
5101
5098
  "defaultValue": false,
5102
5099
  "enabledByDefault": false,
@@ -5126,7 +5123,7 @@
5126
5123
  "id": "nextIDKey",
5127
5124
  "scope": "zg-param:name",
5128
5125
  "description": "If set, adds the next key to the URL to get to the next recordset. Must specify either nextPath, nextIDPath, pageKey\nor startAtKey when using loadByPage.",
5129
- "type": "<string>",
5126
+ "type": "String",
5130
5127
  "enumValues": {},
5131
5128
  "defaultValue": false,
5132
5129
  "enabledByDefault": false,
@@ -5152,7 +5149,7 @@
5152
5149
  "id": "hasPrevPath",
5153
5150
  "scope": "zg-param:name",
5154
5151
  "description": "Path to check if there is previous data.",
5155
- "type": "<string>",
5152
+ "type": "String",
5156
5153
  "enumValues": {},
5157
5154
  "defaultValue": false,
5158
5155
  "enabledByDefault": false,
@@ -5180,7 +5177,7 @@
5180
5177
  "id": "prevPath",
5181
5178
  "scope": "zg-param:name",
5182
5179
  "description": "If set, looks at repsonse for link to previous path.",
5183
- "type": "<string>",
5180
+ "type": "String",
5184
5181
  "enumValues": {},
5185
5182
  "defaultValue": false,
5186
5183
  "enabledByDefault": false,
@@ -5206,7 +5203,7 @@
5206
5203
  "id": "prevIDPath",
5207
5204
  "scope": "zg-param:name",
5208
5205
  "description": "If set, looks at response packet for ID to prev path.",
5209
- "type": "<string>",
5206
+ "type": "String",
5210
5207
  "enumValues": {},
5211
5208
  "defaultValue": false,
5212
5209
  "enabledByDefault": false,
@@ -5235,7 +5232,7 @@
5235
5232
  "id": "prevIDKey",
5236
5233
  "scope": "zg-param:name",
5237
5234
  "description": "If set, adds the prev key to the URL to get to the previous recordset.",
5238
- "type": "<string>",
5235
+ "type": "String",
5239
5236
  "enumValues": {},
5240
5237
  "defaultValue": false,
5241
5238
  "enabledByDefault": false,
@@ -5254,7 +5251,7 @@
5254
5251
  "id": "pageBase",
5255
5252
  "scope": "zg-param:name",
5256
5253
  "description": "If loadByPage enabled, sets this to base page. The default is 1.",
5257
- "type": "<number>",
5254
+ "type": "Number",
5258
5255
  "enumValues": {},
5259
5256
  "defaultValue": false,
5260
5257
  "enabledByDefault": false,
@@ -5271,7 +5268,7 @@
5271
5268
  "id": "selectorKey",
5272
5269
  "scope": "zg-param:name",
5273
5270
  "description": "In the case of server side paging and type-selector-page-persist, this will indicate the field to act as an ID to persist the selection.",
5274
- "type": "<string>",
5271
+ "type": "String",
5275
5272
  "enumValues": {},
5276
5273
  "defaultValue": false,
5277
5274
  "enabledByDefault": false,
@@ -5296,7 +5293,7 @@
5296
5293
  "id": "csvCaption",
5297
5294
  "scope": "zg-param:name",
5298
5295
  "description": "Specific to CSV responseType. Specify if the first line should be the caption",
5299
- "type": "<string>",
5296
+ "type": "String",
5300
5297
  "enumValues": {},
5301
5298
  "defaultValue": false,
5302
5299
  "enabledByDefault": false,
@@ -5317,7 +5314,7 @@
5317
5314
  "id": "csvDelimiter",
5318
5315
  "scope": "zg-param:name",
5319
5316
  "description": "Specific to CSV responseType. Specify the separator to split the columns. ',' is default",
5320
- "type": "<string>",
5317
+ "type": "String",
5321
5318
  "enumValues": {},
5322
5319
  "defaultValue": false,
5323
5320
  "enabledByDefault": false,
@@ -5338,7 +5335,7 @@
5338
5335
  "id": "csvHeader",
5339
5336
  "scope": "zg-param:name",
5340
5337
  "description": "Specific to CSV responseType. Specify if the first line (or second if caption defined) should be the column headers",
5341
- "type": "<string>",
5338
+ "type": "String",
5342
5339
  "enumValues": {},
5343
5340
  "defaultValue": false,
5344
5341
  "enabledByDefault": false,
@@ -5359,7 +5356,7 @@
5359
5356
  "id": "csvLineSeparator",
5360
5357
  "scope": "zg-param:name",
5361
5358
  "description": "Specific to CSV responseType. Specify the separator to split the rows. '\\r\\n' is default",
5362
- "type": "<string>",
5359
+ "type": "String",
5363
5360
  "enumValues": {},
5364
5361
  "defaultValue": false,
5365
5362
  "enabledByDefault": false,
@@ -5380,7 +5377,7 @@
5380
5377
  "id": "tableHide",
5381
5378
  "scope": "zg-param:name",
5382
5379
  "description": "Hide the table referenced in tableData",
5383
- "type": "<boolean>",
5380
+ "type": "Boolean",
5384
5381
  "enumValues": {},
5385
5382
  "defaultValue": false,
5386
5383
  "enabledByDefault": false,
@@ -5401,7 +5398,7 @@
5401
5398
  "id": "tableHead",
5402
5399
  "scope": "zg-param:name",
5403
5400
  "description": "Specifies the values that should be used for the grid's header",
5404
- "type": "<array>",
5401
+ "type": "Array",
5405
5402
  "enumValues": {},
5406
5403
  "defaultValue": false,
5407
5404
  "enabledByDefault": false,
@@ -5422,7 +5419,7 @@
5422
5419
  "id": "tableDataFormat",
5423
5420
  "scope": "zg-param:name",
5424
5421
  "description": "Specifies if the grid should copy the full html value of the data rows or just the text data.",
5425
- "type": "<string>",
5422
+ "type": "String",
5426
5423
  "enumValues": {},
5427
5424
  "defaultValue": false,
5428
5425
  "enabledByDefault": false,
@@ -5443,7 +5440,7 @@
5443
5440
  "id": "tableHeadFormat",
5444
5441
  "scope": "zg-param:name",
5445
5442
  "description": "Specifies if the grid should copy the full html value of the header row or just the text data.",
5446
- "type": "<string>",
5443
+ "type": "String",
5447
5444
  "enumValues": {},
5448
5445
  "defaultValue": false,
5449
5446
  "enabledByDefault": false,
@@ -5463,7 +5460,7 @@
5463
5460
  "id": "collection",
5464
5461
  "scope": "zg-param:name",
5465
5462
  "description": "Specific to the firebaseSDK. Sets the firebase collection to use.",
5466
- "type": "<string>",
5463
+ "type": "String",
5467
5464
  "enumValues": {},
5468
5465
  "defaultValue": false,
5469
5466
  "enabledByDefault": false,
@@ -5482,7 +5479,7 @@
5482
5479
  "id": "subscription",
5483
5480
  "scope": "zg-param:name",
5484
5481
  "description": "Specific to the firebaseSDK. Set to true if you want to use subscription mode.",
5485
- "type": "<boolean>",
5482
+ "type": "Boolean",
5486
5483
  "enumValues": {},
5487
5484
  "defaultValue": false,
5488
5485
  "enabledByDefault": false,
@@ -5501,7 +5498,7 @@
5501
5498
  "id": "dataTable",
5502
5499
  "scope": "zg-param:name",
5503
5500
  "description": "Specific to the dexieCloud and supabaseJS adapter. Sets the table to use for CRUD operations.",
5504
- "type": "<string>",
5501
+ "type": "String",
5505
5502
  "enumValues": {},
5506
5503
  "defaultValue": false,
5507
5504
  "enabledByDefault": false,
@@ -5533,7 +5530,7 @@
5533
5530
  "id": "createOptions",
5534
5531
  "scope": "zg-param:name",
5535
5532
  "description": "Sets the options for CREATE request. Options are formatted as a JSON string.\nAvalable options for requests: body, requestType, exclude, headers, method, mode, responseType, src, queryString.\nNot neccessary to set, the top-level values will be taken instead.",
5536
- "type": "<object>",
5533
+ "type": "Object",
5537
5534
  "enumValues": {},
5538
5535
  "defaultValue": false,
5539
5536
  "enabledByDefault": false,
@@ -5570,7 +5567,7 @@
5570
5567
  "id": "readOptions",
5571
5568
  "scope": "zg-param:name",
5572
5569
  "description": "Sets the options for READ request. Options are formatted as a JSON string.\nAvailable options for requests: body, requestType, exclude, headers, method, mode, responseType, src, queryString.\nNot necessary to set, the top-level values will be taken instead.",
5573
- "type": "<object>",
5570
+ "type": "Object",
5574
5571
  "enumValues": {},
5575
5572
  "defaultValue": false,
5576
5573
  "enabledByDefault": false,
@@ -5606,7 +5603,7 @@
5606
5603
  "id": "updateRowOptions",
5607
5604
  "scope": "zg-param:name",
5608
5605
  "description": "Sets the options for UPDATE row request. \nAvailable options for requests: body, requestType, exclude, headers, method, mode, responseType, src, queryString.\nNot necessary to set, the top-level values will be taken instead.",
5609
- "type": "<object>",
5606
+ "type": "Object",
5610
5607
  "enumValues": {},
5611
5608
  "defaultValue": false,
5612
5609
  "enabledByDefault": false,
@@ -5643,7 +5640,7 @@
5643
5640
  "id": "updateCellOptions",
5644
5641
  "scope": "zg-param:name",
5645
5642
  "description": "Sets the options for UPDATE cell request. \nAvailable options for requests: body, requestType, exclude, headers, method, mode, responseType, src, queryString.\nNot necessary to set, the top-level values will be taken instead.",
5646
- "type": "<object>",
5643
+ "type": "Object",
5647
5644
  "enumValues": {},
5648
5645
  "defaultValue": false,
5649
5646
  "enabledByDefault": false,
@@ -5684,7 +5681,7 @@
5684
5681
  "id": "updateOptions",
5685
5682
  "scope": "zg-param:name",
5686
5683
  "description": "Sets the options for UPDATE request. Options can be set to either \"cell\" or \"row\" updates, the types of updates used in ZingGrid; \noptions are formatted as a JSON string.\nAvailable options for requests: body, requestType, exclude, headers, method, mode, responseType, src, queryString.\nNot necessary to set, the top-level values will be taken instead.",
5687
- "type": "<object>",
5684
+ "type": "Object",
5688
5685
  "enumValues": {},
5689
5686
  "defaultValue": false,
5690
5687
  "enabledByDefault": false,
@@ -5721,7 +5718,7 @@
5721
5718
  "id": "deleteOptions",
5722
5719
  "scope": "zg-param:name",
5723
5720
  "description": "Sets the options for DELETE request. Options are formatted as a JSON string.\nAvailable options for requests: body, requestType, exclude, headers, method, mode, responseType, src, queryString.\nNot necessary to set, the top-level values will be taken instead.",
5724
- "type": "<object>",
5721
+ "type": "Object",
5725
5722
  "enumValues": {},
5726
5723
  "defaultValue": false,
5727
5724
  "enabledByDefault": false,
@@ -5756,7 +5753,7 @@
5756
5753
  "id": "src",
5757
5754
  "scope": "zg-param:name",
5758
5755
  "description": "Option for request type. Sets the base URL for the request. ID is automatically inserted in the `src` for DELETE and UPDATE requests.",
5759
- "type": "<string>",
5756
+ "type": "String",
5760
5757
  "enumValues": {},
5761
5758
  "defaultValue": false,
5762
5759
  "enabledByDefault": false,
@@ -5793,7 +5790,7 @@
5793
5790
  "id": "createSrc",
5794
5791
  "scope": "zg-param:name",
5795
5792
  "description": "Option for request type. Sets the base URL for the create request.",
5796
- "type": "<string>",
5793
+ "type": "String",
5797
5794
  "enumValues": {},
5798
5795
  "defaultValue": false,
5799
5796
  "enabledByDefault": false,
@@ -5825,7 +5822,7 @@
5825
5822
  "id": "readSrc",
5826
5823
  "scope": "zg-param:name",
5827
5824
  "description": "Option for request type. Sets the base URL for the read request.",
5828
- "type": "<string>",
5825
+ "type": "String",
5829
5826
  "enumValues": {},
5830
5827
  "defaultValue": false,
5831
5828
  "enabledByDefault": false,
@@ -5857,7 +5854,7 @@
5857
5854
  "id": "updateRowSrc",
5858
5855
  "scope": "zg-param:name",
5859
5856
  "description": "Option for request type. Sets the base URL for the update row request.",
5860
- "type": "<string>",
5857
+ "type": "String",
5861
5858
  "enumValues": {},
5862
5859
  "defaultValue": false,
5863
5860
  "enabledByDefault": false,
@@ -5889,7 +5886,7 @@
5889
5886
  "id": "updateCellSrc",
5890
5887
  "scope": "zg-param:name",
5891
5888
  "description": "Option for request type. Sets the base URL for the update cell request.",
5892
- "type": "<string>",
5889
+ "type": "String",
5893
5890
  "enumValues": {},
5894
5891
  "defaultValue": false,
5895
5892
  "enabledByDefault": false,
@@ -5921,7 +5918,7 @@
5921
5918
  "id": "deleteSrc",
5922
5919
  "scope": "zg-param:name",
5923
5920
  "description": "Option for request type. Sets the base URL for the delete request.",
5924
- "type": "<string>",
5921
+ "type": "String",
5925
5922
  "enumValues": {},
5926
5923
  "defaultValue": false,
5927
5924
  "enabledByDefault": false,
@@ -5945,7 +5942,7 @@
5945
5942
  "id": "restmode",
5946
5943
  "scope": "zg-param:name",
5947
5944
  "description": "Set to \"manual\" if you want to turn off traditional REST URL construction and method setting.\nSet to \"method\" if you only want to use REST methods and not REST url construction. \nSet to \"url\" if you want to use REST URL construction but not REST methods. \nSet to \"auto\" if you want to use REST URL constuction and REST methods.\nThe method settings for `restmode=\"manual\"` and `restmode=\"url\"` is GET = GET and the all other = POST. To update\nmethod settings, use `updateCellMethod`, `deleteMethod`, etc.",
5948
- "type": "<string>",
5945
+ "type": "String",
5949
5946
  "enumValues": {},
5950
5947
  "defaultValue": false,
5951
5948
  "enabledByDefault": false,
@@ -5977,7 +5974,7 @@
5977
5974
  "id": "method",
5978
5975
  "scope": "zg-param:name",
5979
5976
  "description": "Option for request type (GET, POST, PUT, etc). ZingGrid uses the standard request type per action, but it can overwritten with this param.",
5980
- "type": "<string>",
5977
+ "type": "String",
5981
5978
  "enumValues": {},
5982
5979
  "defaultValue": false,
5983
5980
  "enabledByDefault": false,
@@ -6009,7 +6006,7 @@
6009
6006
  "id": "createMethod",
6010
6007
  "scope": "zg-param:name",
6011
6008
  "description": "Sets the method on the create request",
6012
- "type": "<string>",
6009
+ "type": "String",
6013
6010
  "enumValues": {},
6014
6011
  "defaultValue": false,
6015
6012
  "enabledByDefault": false,
@@ -6041,7 +6038,7 @@
6041
6038
  "id": "readMethod",
6042
6039
  "scope": "zg-param:name",
6043
6040
  "description": "Sets the method on the read request",
6044
- "type": "<string>",
6041
+ "type": "String",
6045
6042
  "enumValues": {},
6046
6043
  "defaultValue": false,
6047
6044
  "enabledByDefault": false,
@@ -6074,7 +6071,7 @@
6074
6071
  "id": "updateRowMethod",
6075
6072
  "scope": "zg-param:name",
6076
6073
  "description": "Sets the method on the update row request",
6077
- "type": "<string>",
6074
+ "type": "String",
6078
6075
  "enumValues": {},
6079
6076
  "defaultValue": false,
6080
6077
  "enabledByDefault": false,
@@ -6107,7 +6104,7 @@
6107
6104
  "id": "updateCellMethod",
6108
6105
  "scope": "zg-param:name",
6109
6106
  "description": "Sets the method on the update cell request",
6110
- "type": "<string>",
6107
+ "type": "String",
6111
6108
  "enumValues": {},
6112
6109
  "defaultValue": false,
6113
6110
  "enabledByDefault": false,
@@ -6140,7 +6137,7 @@
6140
6137
  "id": "deleteMethod",
6141
6138
  "scope": "zg-param:name",
6142
6139
  "description": "Sets the method on the the delete request",
6143
- "type": "<string>",
6140
+ "type": "String",
6144
6141
  "enumValues": {},
6145
6142
  "defaultValue": false,
6146
6143
  "enabledByDefault": false,
@@ -6172,7 +6169,7 @@
6172
6169
  "id": "headers",
6173
6170
  "scope": "zg-param:name",
6174
6171
  "description": "Option for request type. Sets headers for request.",
6175
- "type": "<object>",
6172
+ "type": "Object",
6176
6173
  "enumValues": {},
6177
6174
  "defaultValue": false,
6178
6175
  "enabledByDefault": false,
@@ -6197,7 +6194,7 @@
6197
6194
  "id": "queryString",
6198
6195
  "scope": "zg-param:name",
6199
6196
  "description": "Option for request type. Adds an additional query string to request.",
6200
- "type": "<string>",
6197
+ "type": "String",
6201
6198
  "enumValues": {},
6202
6199
  "defaultValue": false,
6203
6200
  "enabledByDefault": false,
@@ -6228,7 +6225,7 @@
6228
6225
  "id": "body",
6229
6226
  "scope": "zg-param:name",
6230
6227
  "description": "Sets the body or query string of the request, which overwrites the ZingGrid generated query string. \nCan be set to a template string, string, or function name. If set to function name, the function \ntakes in `rawData`, `method`, and `src` and returns an object to send as body for request.",
6231
- "type": "<string>",
6228
+ "type": "String",
6232
6229
  "enumValues": {},
6233
6230
  "defaultValue": false,
6234
6231
  "enabledByDefault": false,
@@ -6245,7 +6242,7 @@
6245
6242
  "id": "bodyMethodSuffix",
6246
6243
  "scope": "zg-param:name",
6247
6244
  "description": "Sets the suffix for the function name that will construct the body for the request. \nWill set the `createBody`, `readBody`, `updateRowBody`, `updateCellBody`, and `deleteBody` parameters to:\n `create` + suffix\n `read` + suffix\n `updateRow` + suffix\n `updateCell` + suffix\n `delete` + suffix",
6248
- "type": "<string>",
6245
+ "type": "String",
6249
6246
  "enumValues": {},
6250
6247
  "defaultValue": false,
6251
6248
  "enabledByDefault": false,
@@ -6283,7 +6280,7 @@
6283
6280
  "id": "createBody",
6284
6281
  "scope": "zg-param:name",
6285
6282
  "description": "Sets the body on the create request\nCan be set to a template string, string, or function name. If set to function name, the function \ntakes in `rawData`, `method`, and `src` and returns an object to send as body for request.",
6286
- "type": "<string>",
6283
+ "type": "String",
6287
6284
  "enumValues": {},
6288
6285
  "defaultValue": false,
6289
6286
  "enabledByDefault": false,
@@ -6314,7 +6311,7 @@
6314
6311
  "id": "readBody",
6315
6312
  "scope": "zg-param:name",
6316
6313
  "description": "Sets the body on the read request\nCan be set to a template string, string, or function name. If set to function name, the function \ntakes in `rawData`, `method`, and `src` and returns an object to send as body for request.",
6317
- "type": "<string>",
6314
+ "type": "String",
6318
6315
  "enumValues": {},
6319
6316
  "defaultValue": false,
6320
6317
  "enabledByDefault": false,
@@ -6345,7 +6342,7 @@
6345
6342
  "id": "updateRowBody",
6346
6343
  "scope": "zg-param:name",
6347
6344
  "description": "Sets the body on the update row request\nCan be set to a template string, string, or function name. If set to function name, the function \ntakes in `rawData`, `method`, and `src` and returns an object to send as body for request.",
6348
- "type": "<string>",
6345
+ "type": "String",
6349
6346
  "enumValues": {},
6350
6347
  "defaultValue": false,
6351
6348
  "enabledByDefault": false,
@@ -6376,7 +6373,7 @@
6376
6373
  "id": "updateCellBody",
6377
6374
  "scope": "zg-param:name",
6378
6375
  "description": "Sets the body on the update cell request\nCan be set to a template string, string, or function name. If set to function name, the function \ntakes in `rawData`, `method`, and `src` and returns an object to send as body for request.",
6379
- "type": "<string>",
6376
+ "type": "String",
6380
6377
  "enumValues": {},
6381
6378
  "defaultValue": false,
6382
6379
  "enabledByDefault": false,
@@ -6407,7 +6404,7 @@
6407
6404
  "id": "deleteBody",
6408
6405
  "scope": "zg-param:name",
6409
6406
  "description": "Sets the body on the delete request\nCan be set to a template string, string, or function name. If set to function name, the function \ntakes in `rawData`, `method`, and `src` and returns an object to send as body for request.",
6410
- "type": "<string>",
6407
+ "type": "String",
6411
6408
  "enumValues": {},
6412
6409
  "defaultValue": false,
6413
6410
  "enabledByDefault": false,
@@ -6436,7 +6433,7 @@
6436
6433
  "id": "createCustomFunction",
6437
6434
  "scope": "zg-param:name",
6438
6435
  "description": "Sets the function that handles the external data handling for creating new records\nThe function takes in `recordId`, `rawData`, and `options` and returns an object to send as body for request.",
6439
- "type": "<string>",
6436
+ "type": "String",
6440
6437
  "enumValues": {},
6441
6438
  "defaultValue": false,
6442
6439
  "enabledByDefault": false,
@@ -6465,7 +6462,7 @@
6465
6462
  "id": "readCustomFunction",
6466
6463
  "scope": "zg-param:name",
6467
6464
  "description": "Sets the function that handles the external data handling for reading data\nThe function takes in `options` and returns an object to send as body for request.",
6468
- "type": "<string>",
6465
+ "type": "String",
6469
6466
  "enumValues": {},
6470
6467
  "defaultValue": false,
6471
6468
  "enabledByDefault": false,
@@ -6494,7 +6491,7 @@
6494
6491
  "id": "updateCellCustomFunction",
6495
6492
  "scope": "zg-param:name",
6496
6493
  "description": "Sets the function that handles the external data handling for updating a cell of data\nThe function takes in `recordId`, `rawData`, and `options` and returns an object to send as body for request.",
6497
- "type": "<string>",
6494
+ "type": "String",
6498
6495
  "enumValues": {},
6499
6496
  "defaultValue": false,
6500
6497
  "enabledByDefault": false,
@@ -6523,7 +6520,7 @@
6523
6520
  "id": "updateRowCustomFunction",
6524
6521
  "scope": "zg-param:name",
6525
6522
  "description": "Sets the function that handles the external data handling for updating a row of data\nThe function takes in `recordId`, `rawData`, and `options` and returns an object to send as body for request.",
6526
- "type": "<string>",
6523
+ "type": "String",
6527
6524
  "enumValues": {},
6528
6525
  "defaultValue": false,
6529
6526
  "enabledByDefault": false,
@@ -6552,7 +6549,7 @@
6552
6549
  "id": "deleteCustomFunction",
6553
6550
  "scope": "zg-param:name",
6554
6551
  "description": "Sets the function that handles the external data handling for delete\nThe function takes in `recordId`, `rawData`, and `options` and returns an object to send as body for request.",
6555
- "type": "<string>",
6552
+ "type": "String",
6556
6553
  "enumValues": {},
6557
6554
  "defaultValue": false,
6558
6555
  "enabledByDefault": false,
@@ -6571,7 +6568,7 @@
6571
6568
  "id": "serverErrorMessage",
6572
6569
  "scope": "zg-param:name",
6573
6570
  "description": "Sets the error message for any server errors. Use [[serverMessage]] token to set message from server",
6574
- "type": "<string>",
6571
+ "type": "String",
6575
6572
  "enumValues": {},
6576
6573
  "defaultValue": false,
6577
6574
  "enabledByDefault": false,
@@ -6592,7 +6589,7 @@
6592
6589
  "id": "serverErrorPath",
6593
6590
  "scope": "zg-param:name",
6594
6591
  "description": "serverErrorPath: Sets the path to the server error message if response is JSON.",
6595
- "type": "<string>",
6592
+ "type": "String",
6596
6593
  "enumValues": {},
6597
6594
  "defaultValue": false,
6598
6595
  "enabledByDefault": false,
@@ -6614,7 +6611,7 @@
6614
6611
  "id": "exclude",
6615
6612
  "scope": "zg-param:name",
6616
6613
  "description": "If enabled, method will not call the external REST API",
6617
- "type": "<boolean>",
6614
+ "type": "Boolean",
6618
6615
  "enumValues": {},
6619
6616
  "defaultValue": false,
6620
6617
  "enabledByDefault": false,
@@ -6634,7 +6631,7 @@
6634
6631
  "id": "cdataEscape",
6635
6632
  "scope": "zg-param:name",
6636
6633
  "description": "If enabled, method will escape HTML wrapped in CDATA blocks on xml decoding",
6637
- "type": "<boolean>",
6634
+ "type": "Boolean",
6638
6635
  "enumValues": {},
6639
6636
  "defaultValue": false,
6640
6637
  "enabledByDefault": false,
@@ -6654,7 +6651,7 @@
6654
6651
  "id": "requestType",
6655
6652
  "scope": "zg-param:name",
6656
6653
  "description": "Sets the Content Type for the request. The default is application/json.",
6657
- "type": "<string>",
6654
+ "type": "String",
6658
6655
  "enumValues": {},
6659
6656
  "defaultValue": false,
6660
6657
  "enabledByDefault": false,
@@ -6675,7 +6672,7 @@
6675
6672
  "id": "responseType",
6676
6673
  "scope": "zg-param:name",
6677
6674
  "description": "Sets the expected Content Type for the response. The default is application/json.",
6678
- "type": "<string>",
6675
+ "type": "String",
6679
6676
  "enumValues": {},
6680
6677
  "defaultValue": false,
6681
6678
  "enabledByDefault": false,
@@ -6696,7 +6693,7 @@
6696
6693
  "id": "dataType",
6697
6694
  "scope": "zg-param:name",
6698
6695
  "description": "Sets the expected data type for a static data source. The default is application/json.",
6699
- "type": "<string>",
6696
+ "type": "String",
6700
6697
  "enumValues": {},
6701
6698
  "defaultValue": false,
6702
6699
  "enabledByDefault": false,
@@ -6723,7 +6720,7 @@
6723
6720
  "id": "urlSuffix",
6724
6721
  "scope": "zg-param:name",
6725
6722
  "description": "Any string to place at the end of a REST constructed URL. Note that this cannot be used with `restmode` is set to 'manual'.",
6726
- "type": "<string>",
6723
+ "type": "String",
6727
6724
  "enumValues": {},
6728
6725
  "defaultValue": false,
6729
6726
  "enabledByDefault": false,
@@ -6748,7 +6745,7 @@
6748
6745
  "id": "mode",
6749
6746
  "scope": "zg-param:name",
6750
6747
  "description": "Sets to 'cors' to specify the settings for cors request. The external server must enable 'cors' for this to take effect.",
6751
- "type": "<string>",
6748
+ "type": "String",
6752
6749
  "enumValues": {},
6753
6750
  "defaultValue": false,
6754
6751
  "enabledByDefault": false,
@@ -6998,7 +6995,7 @@
6998
6995
  "avg": "computes the average value",
6999
6996
  "max": "displays the maximum value",
7000
6997
  "min": "displays the minimum value",
7001
- "count": "displays the number of non"
6998
+ "count": "displays the number of non-null values"
7002
6999
  },
7003
7000
  "defaultValue": "N/A",
7004
7001
  "enabledByDefault": false,
@@ -7116,7 +7113,7 @@
7116
7113
  "cascades": {},
7117
7114
  "deprecated": false,
7118
7115
  "severity": "info",
7119
- "notes": "R"
7116
+ "notes": "Related attributes enable button tooltips; `button-tooltip-disabled` can be used to disable them"
7120
7117
  },
7121
7118
  {
7122
7119
  "id": "caption",
@@ -7154,8 +7151,8 @@
7154
7151
  "analogousAttributes": [],
7155
7152
  "cascades": {},
7156
7153
  "deprecated": false,
7157
- "severity": "w",
7158
- "notes": "R"
7154
+ "severity": "warning",
7155
+ "notes": "Recommended to set features on `<zg-card>` instead."
7159
7156
  },
7160
7157
  {
7161
7158
  "id": "cell-break",
@@ -7455,7 +7452,7 @@
7455
7452
  "description": "Sets the style to use for the tooltips. Uses the `default` style by default. Can set to `system` to match the tooltips used on icons throughout `<zing-grid>`.",
7456
7453
  "type": "String",
7457
7454
  "enumValues": {
7458
- "default": "The default styling applied to <zg",
7455
+ "default": "The default styling applied to <zg-tooltip>, featuring a white background, gray border, and black text.",
7459
7456
  "system": "Features a dark background and white text."
7460
7457
  },
7461
7458
  "defaultValue": "\"default\"",
@@ -7669,7 +7666,7 @@
7669
7666
  "id": "columns",
7670
7667
  "scope": "zing-grid",
7671
7668
  "description": "Specifies the columns of the grid. More appropriate to use `<zg-column>` in most cases or set the property programmatically.",
7672
- "type": "Object",
7669
+ "type": "Array",
7673
7670
  "enumValues": {},
7674
7671
  "defaultValue": "Dependent on data",
7675
7672
  "enabledByDefault": false,
@@ -7679,8 +7676,8 @@
7679
7676
  "analogousAttributes": [],
7680
7677
  "cascades": {},
7681
7678
  "deprecated": false,
7682
- "severity": "w",
7683
- "notes": "R"
7679
+ "severity": "warning",
7680
+ "notes": "Recommended to features on `<zg-column>` instead.\nColumns are set with `ZGColumn[index]` based on dataset."
7684
7681
  },
7685
7682
  {
7686
7683
  "id": "columns-control",
@@ -7734,8 +7731,8 @@
7734
7731
  "analogousAttributes": [],
7735
7732
  "cascades": {},
7736
7733
  "deprecated": false,
7737
- "severity": "w",
7738
- "notes": "T"
7734
+ "severity": "warning",
7735
+ "notes": "The preferred way to enable features through HTML is to add the attributes directly to the components.\nThis should be used only when using JavaScript to enable features."
7739
7736
  },
7740
7737
  {
7741
7738
  "id": "confirm-delete",
@@ -7764,7 +7761,8 @@
7764
7761
  "description": "Sets which confirmation dialogs to display on batch editing and deleting",
7765
7762
  "type": "String",
7766
7763
  "enumValues": {
7767
- "\"batch": "edit",
7764
+ "batch-edit": "Disables all confirmation dialog relating to batch edit (discard batch edit changes and delete rows)",
7765
+ "batch-edit-discard": "Disables confirmation dialog when discarding batch edit changes",
7768
7766
  "delete": "Disables confirmation dialog when deleting rows",
7769
7767
  "disabled": "Disables all confirmation dialogs",
7770
7768
  "all": "Displays all available confirmation dialogs"
@@ -7788,7 +7786,7 @@
7788
7786
  "description": "Enables the default `<zing-grid>` context menu or set to the id name of a custom `<zg-menu>`. If\nset to a custom menu and `<zg-menu>` has the `replace` attribute present, then the custom menu will replace the context menu.\nOtherwise the contents of the custom menu is appended to the end of context menu.\nCan also set to `\"browser\"` to use the browser's built in context-menu\nNote that the `\"browser\"` context-menu cannot be used together with a custom static-menu.",
7789
7787
  "type": "String | Boolean",
7790
7788
  "enumValues": {
7791
- "browser": "Uses the browser's built"
7789
+ "browser": "Uses the browser's built-in context-menu"
7792
7790
  },
7793
7791
  "defaultValue": "\"\"",
7794
7792
  "enabledByDefault": false,
@@ -7834,7 +7832,7 @@
7834
7832
  "id": "data",
7835
7833
  "scope": "zing-grid",
7836
7834
  "description": "Data for the grid presented as an array or object",
7837
- "type": "Object",
7835
+ "type": "Array | Object",
7838
7836
  "enumValues": {},
7839
7837
  "defaultValue": "\"\"",
7840
7838
  "enabledByDefault": false,
@@ -8045,7 +8043,7 @@
8045
8043
  "id": "filter-buttons",
8046
8044
  "scope": "zing-grid",
8047
8045
  "description": "Comma separated list of buttons to display in the specified order on the filter menu",
8048
- "type": "String | Array",
8046
+ "type": "String",
8049
8047
  "enumValues": {
8050
8048
  "reset": "Add button to reset filter condition(s)",
8051
8049
  "close": "Add button to close filter menu",
@@ -8700,7 +8698,7 @@
8700
8698
  "enumValues": {
8701
8699
  "left": "Positions the icon to the left of the header",
8702
8700
  "right": "Positions the icon to the right of the header",
8703
- "\"after": "text\""
8701
+ "after-text": "Positions the icon after the header text"
8704
8702
  },
8705
8703
  "defaultValue": "\"right\"",
8706
8704
  "enabledByDefault": false,
@@ -8863,7 +8861,7 @@
8863
8861
  "description": "Sets the style to use for the tooltips. Uses the `default` style by default. Can set to `system` to match the tooltips used on icons throughout `<zing-grid>`.",
8864
8862
  "type": "String",
8865
8863
  "enumValues": {
8866
- "default": "The default styling applied to <zg",
8864
+ "default": "The default styling applied to <zg-tooltip>, featuring a white background, gray border, and black text.",
8867
8865
  "system": "Features a dark background and white text."
8868
8866
  },
8869
8867
  "defaultValue": "\"default\"",
@@ -9077,7 +9075,7 @@
9077
9075
  "src",
9078
9076
  "zg-data:data",
9079
9077
  "zg-data:src",
9080
- "zg-param:src"
9078
+ "zg-param:name:src"
9081
9079
  ],
9082
9080
  "analogousAttributes": [],
9083
9081
  "cascades": {},
@@ -9104,7 +9102,7 @@
9104
9102
  "zg-column:search",
9105
9103
  "zg-data:data",
9106
9104
  "zg-data:src",
9107
- "zg-param:src"
9105
+ "zg-param:name:src"
9108
9106
  ],
9109
9107
  "analogousAttributes": [],
9110
9108
  "cascades": {},
@@ -9292,7 +9290,8 @@
9292
9290
  "description": "Determines which type of pagination to use, input or buttons",
9293
9291
  "type": "String",
9294
9292
  "enumValues": {
9295
- "\"button": "arrows\""
9293
+ "button-text": "applies pager with \"previous\" and \"next\" buttons",
9294
+ "button-arrows": "applies pager with arrow buttons"
9296
9295
  },
9297
9296
  "defaultValue": "''",
9298
9297
  "enabledByDefault": false,
@@ -9323,8 +9322,8 @@
9323
9322
  "analogousAttributes": [],
9324
9323
  "cascades": {},
9325
9324
  "deprecated": false,
9326
- "severity": "w",
9327
- "notes": "R"
9325
+ "severity": "warning",
9326
+ "notes": "Recommended to features using `<zg-param>` instead."
9328
9327
  },
9329
9328
  {
9330
9329
  "id": "preserve-state-id",
@@ -9581,9 +9580,9 @@
9581
9580
  "description": "If `[rowHeight]` is set, it specifies which rows to apply row height to.\nChoices are `data`, `headers, and `all`. Can combine with comma separated list",
9582
9581
  "type": "String",
9583
9582
  "enumValues": {
9584
- "data": "Apply `row",
9585
- "headers": "Apply `row",
9586
- "all": "Apply `row"
9583
+ "data": "Apply `row-height` to data rows",
9584
+ "headers": "Apply `row-height` to header rows",
9585
+ "all": "Apply `row-height` to both header and data rows"
9587
9586
  },
9588
9587
  "defaultValue": "\"data\"",
9589
9588
  "enabledByDefault": false,
@@ -9864,16 +9863,16 @@
9864
9863
  "description": "Positions the status message in one of nine positions relative to the grid",
9865
9864
  "type": "String",
9866
9865
  "enumValues": {
9867
- "\"top left\"": "Positions the status message in the top",
9868
- "\"center left\"": "Positions the status message in the center",
9869
- "\"bottom left\"": "Positions the status message in the bottom",
9870
- "\"top center\"": "Positions the status message in the top",
9871
- "\"center\"": "Positions the status message in the center of the grid",
9872
- "\"bottom center\"": "Positions the status message in the bottom",
9873
- "\"top right\"": "Positions the status message in the top",
9874
- "\"center right\"": "Positions the status message in the center",
9875
- "\"bottom right\"": "Positions the status message in the bottom",
9876
- "\"bar\"": "Positions the status message as a bar at the bottom of the grid"
9866
+ "top left": "Positions the status message in the top-left corner of the grid",
9867
+ "center left": "Positions the status message in the center-left of the grid",
9868
+ "bottom left": "Positions the status message in the bottom-left corner of the grid",
9869
+ "top center": "Positions the status message in the top-center of the grid",
9870
+ "center": "Positions the status message in the center of the grid",
9871
+ "bottom center": "Positions the status message in the bottom-center of the grid",
9872
+ "top right": "Positions the status message in the top-right corner of the grid",
9873
+ "center right": "Positions the status message in the center-right of the grid",
9874
+ "bottom right": "Positions the status message in the bottom-right corner of the grid",
9875
+ "bar": "Positions the status message as a bar at the bottom of the grid"
9877
9876
  },
9878
9877
  "defaultValue": "\"top right\"",
9879
9878
  "enabledByDefault": false,
@@ -9935,11 +9934,11 @@
9935
9934
  "description": "Sets the theme of the grid. Built-in themes are specified by keyword, but custom theme\nnames are also accepted by setting a URL path to your custom css theme file. For custom themes, on load set `theme`\nto the path to the custom theme file. After, set to theme name to switch themes.",
9936
9935
  "type": "String",
9937
9936
  "enumValues": {
9938
- "android": "Android",
9939
- "black": "High",
9937
+ "android": "Android-inspired styling",
9938
+ "black": "High-contrast black color styling",
9940
9939
  "default": "Standard styling",
9941
- "dark": "Dark color styling for low",
9942
- "ios": "iOS"
9940
+ "dark": "Dark color styling for low-light use",
9941
+ "ios": "iOS-inspired styling"
9943
9942
  },
9944
9943
  "defaultValue": "\"default\"",
9945
9944
  "enabledByDefault": false,
@@ -10065,7 +10064,7 @@
10065
10064
  "cascades": {},
10066
10065
  "deprecated": false,
10067
10066
  "severity": "info",
10068
- "notes": "R"
10067
+ "notes": "Related to layout, because `viewport` changes can trigger a switch between layout modes (card and row). \nFreezing viewport (with `viewport-pausse`) keeps the current layout mode unchanged."
10069
10068
  },
10070
10069
  {
10071
10070
  "id": "viewport-stop",
@@ -10087,7 +10086,7 @@
10087
10086
  "cascades": {},
10088
10087
  "deprecated": false,
10089
10088
  "severity": "info",
10090
- "notes": "R"
10089
+ "notes": "Related to layout, because `viewport` changes can trigger a switch between layout modes (card and row). \nDisabling viewport resizing (with `viewport-stop`) keeps the layout in row mode."
10091
10090
  },
10092
10091
  {
10093
10092
  "id": "viewport-types",