@esri/calcite-components 1.0.0-next.465 → 1.0.0-next.468

package/dist/extras/docs-json.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2022-05-10T21:10:14",
+  "timestamp": "2022-05-13T23:12:54",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.15.2",
@@ -153,17 +153,17 @@
       "events": [],
       "listeners": [
         {
-          "event": "calciteAccordionItemKeyEvent",
+          "event": "calciteInternalAccordionItemKeyEvent",
           "capture": false,
           "passive": false
         },
         {
-          "event": "calciteAccordionItemRegister",
+          "event": "calciteInternalAccordionItemRegister",
           "capture": false,
           "passive": false
         },
         {
-          "event": "calciteAccordionItemSelect",
+          "event": "calciteInternalAccordionItemSelect",
           "capture": false,
           "passive": false
         }
@@ -269,7 +269,7 @@
           "passive": false
         },
         {
-          "event": "calciteAccordionChange",
+          "event": "calciteInternalAccordionChange",
           "target": "body",
           "capture": false,
           "passive": false
@@ -812,7 +812,12 @@
           "signature": "setFocus(focusId?: \"expand-toggle\") => Promise<void>",
           "parameters": [],
           "docs": "Sets focus on the component.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "focusId"
+            }
+          ]
         }
       ],
       "events": [
@@ -1505,7 +1510,12 @@
           "signature": "setFocus(focusId?: \"expand-toggle\") => Promise<void>",
           "parameters": [],
           "docs": "Sets focus on the component.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "focusId"
+            }
+          ]
         }
       ],
       "events": [
@@ -1831,13 +1841,13 @@
       ],
       "listeners": [
         {
-          "event": "calciteAlertSync",
+          "event": "calciteInternalAlertSync",
           "target": "window",
           "capture": false,
           "passive": false
         },
         {
-          "event": "calciteAlertRegister",
+          "event": "calciteInternalAlertRegister",
           "target": "window",
           "capture": false,
           "passive": false
@@ -2141,7 +2151,12 @@
           "attr": "intl-collapse",
           "reflectToAttr": false,
           "docs": "Aria-label for collapsing the toggle and tooltip used for the toggle when expanded.",
-          "docsTags": [],
+          "docsTags": [
+            {
+              "name": "default",
+              "text": "\"Collapse\""
+            }
+          ],
           "default": "TEXT.collapse",
           "values": [
             {
@@ -2158,7 +2173,12 @@
           "attr": "intl-expand",
           "reflectToAttr": false,
           "docs": "Aria-label for expanding the toggle and tooltip used for the toggle when collapsed.",
-          "docsTags": [],
+          "docsTags": [
+            {
+              "name": "default",
+              "text": "\"Expand\""
+            }
+          ],
           "default": "TEXT.expand",
           "values": [
             {
@@ -5013,7 +5033,7 @@
           "bubbles": true,
           "cancelable": true,
           "composed": true,
-          "docs": "Called when a selected item in the combobox is dismissed via its chip *",
+          "docs": "Called when a selected item in the combobox is dismissed via its chip",
           "docsTags": []
         },
         {
@@ -5255,7 +5275,12 @@
           "signature": "toggleSelected(coerce?: boolean) => Promise<void>",
           "parameters": [],
           "docs": "Used to toggle the selection state. By default this won't trigger an event.\nThe first argument allows the value to be coerced, rather than swapping values.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "coerce"
+            }
+          ]
         }
       ],
       "events": [
@@ -6797,7 +6822,7 @@
           "bubbles": true,
           "cancelable": true,
           "composed": true,
-          "docs": "fires when a dropdown has been closed *",
+          "docs": "fires when a dropdown has been closed",
           "docsTags": []
         },
         {
@@ -6806,7 +6831,7 @@
           "bubbles": true,
           "cancelable": true,
           "composed": true,
-          "docs": "fires when a dropdown has been opened *",
+          "docs": "fires when a dropdown has been opened",
           "docsTags": []
         },
         {
@@ -6815,7 +6840,7 @@
           "bubbles": true,
           "cancelable": true,
           "composed": true,
-          "docs": "fires when a dropdown item has been selected or deselected *",
+          "docs": "fires when a dropdown item has been selected or deselected",
           "docsTags": []
         }
       ],
@@ -6827,7 +6852,7 @@
           "passive": false
         },
         {
-          "event": "calciteDropdownCloseRequest",
+          "event": "calciteInternalDropdownCloseRequest",
           "capture": false,
           "passive": false
         },
@@ -6848,12 +6873,12 @@
           "passive": true
         },
         {
-          "event": "calciteDropdownItemKeyEvent",
+          "event": "calciteInternalDropdownItemKeyEvent",
           "capture": false,
           "passive": false
         },
         {
-          "event": "calciteDropdownItemSelect",
+          "event": "calciteInternalDropdownItemSelect",
           "capture": false,
           "passive": false
         }
@@ -6972,7 +6997,7 @@
       "events": [],
       "listeners": [
         {
-          "event": "calciteDropdownItemSelect",
+          "event": "calciteInternalDropdownItemSelect",
           "capture": false,
           "passive": false
         }
@@ -7168,7 +7193,7 @@
           "passive": false
         },
         {
-          "event": "calciteDropdownItemChange",
+          "event": "calciteInternalDropdownItemChange",
           "target": "body",
           "capture": false,
           "passive": false
@@ -8329,7 +8354,7 @@
       ],
       "listeners": [
         {
-          "event": "calciteInputBlur",
+          "event": "calciteInternalInputBlur",
           "capture": false,
           "passive": false
         }
@@ -8879,7 +8904,7 @@
           "mutable": false,
           "attr": "suffix-text",
           "reflectToAttr": false,
-          "docs": "optionally add suffix  *",
+          "docs": "optionally add suffix",
           "docsTags": [],
           "values": [
             {
@@ -10266,12 +10291,12 @@
           "passive": false
         },
         {
-          "event": "calciteTimePickerBlur",
+          "event": "calciteInternalTimePickerBlur",
           "capture": false,
           "passive": false
         },
         {
-          "event": "calciteTimePickerFocus",
+          "event": "calciteInternalTimePickerFocus",
           "capture": false,
           "passive": false
         }
@@ -10720,7 +10745,7 @@
       "docsTags": [
         {
           "name": "slot",
-          "text": "- A slot for adding `calcite-list-item` elements."
+          "text": "- A slot for adding calcite-list-item elements."
         }
       ],
       "usage": {
@@ -10736,7 +10761,7 @@
           "mutable": false,
           "attr": "disabled",
           "reflectToAttr": true,
-          "docs": "When true, disabled prevents user interaction.",
+          "docs": "When true, prevents user interaction.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -10753,7 +10778,7 @@
           "mutable": false,
           "attr": "heading-level",
           "reflectToAttr": false,
-          "docs": "Number at which section headings should start for this component.",
+          "docs": "Number at which section headings should start for the list.",
           "docsTags": [],
           "values": [
             {
@@ -10804,7 +10829,7 @@
       "slots": [
         {
           "name": "",
-          "docs": "A slot for adding `calcite-list-item` elements."
+          "docs": "A slot for adding calcite-list-item elements."
         }
       ],
       "parts": [],
@@ -10821,11 +10846,11 @@
       "docsTags": [
         {
           "name": "slot",
-          "text": "- A slot for adding `calcite-list-item` and `calcite-list-item-group` elements."
+          "text": "- A slot for adding calcite-list-item and calcite-list-item-group elements."
         },
         {
           "name": "slot",
-          "text": "actions-start - A slot for adding actionable `calcite-action` elements before the content of the list item."
+          "text": "actions-start - A slot for adding actionable calcite-action elements before the content of the list item."
         },
         {
           "name": "slot",
@@ -10837,7 +10862,7 @@
         },
         {
           "name": "slot",
-          "text": "actions-end - A slot for adding actionable `calcite-action` elements after the content of the list item."
+          "text": "actions-end - A slot for adding actionable calcite-action elements after the content of the list item."
         }
       ],
       "usage": {},
@@ -10848,7 +10873,7 @@
           "mutable": false,
           "attr": "description",
           "reflectToAttr": false,
-          "docs": "An optional description for this item.  This will appear below the label text.",
+          "docs": "An optional description for the list item. Displays below the label text.",
           "docsTags": [],
           "values": [
             {
@@ -10864,7 +10889,7 @@
           "mutable": false,
           "attr": "disabled",
           "reflectToAttr": true,
-          "docs": "When true, disabled prevents interaction.",
+          "docs": "When true, prevents user interaction.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -10881,7 +10906,7 @@
           "mutable": false,
           "attr": "label",
           "reflectToAttr": false,
-          "docs": "The label text of the list item. This will appear above the description text.",
+          "docs": "The label text of the list item. Displays above the description text.",
           "docsTags": [],
           "values": [
             {
@@ -10928,15 +10953,15 @@
       "slots": [
         {
           "name": "",
-          "docs": "A slot for adding `calcite-list-item` and `calcite-list-item-group` elements."
+          "docs": "A slot for adding calcite-list-item and calcite-list-item-group elements."
         },
         {
           "name": "actions-end",
-          "docs": "A slot for adding actionable `calcite-action` elements after the content of the list item."
+          "docs": "A slot for adding actionable calcite-action elements after the content of the list item."
         },
         {
           "name": "actions-start",
-          "docs": "A slot for adding actionable `calcite-action` elements before the content of the list item."
+          "docs": "A slot for adding actionable calcite-action elements before the content of the list item."
         },
         {
           "name": "content-end",
@@ -10961,7 +10986,7 @@
       "docsTags": [
         {
           "name": "slot",
-          "text": "- A slot for adding `calcite-list-item` and `calcite-list-item-group` elements."
+          "text": "- A slot for adding calcite-list-item and calcite-list-item-group elements."
         }
       ],
       "usage": {},
@@ -10972,7 +10997,7 @@
           "mutable": false,
           "attr": "heading",
           "reflectToAttr": true,
-          "docs": "The title used for all nested `calcite-list-item` rows.",
+          "docs": "The title for all nested calcite-list-item rows.",
           "docsTags": [],
           "values": [
             {
@@ -10988,7 +11013,7 @@
           "mutable": false,
           "attr": "heading-level",
           "reflectToAttr": false,
-          "docs": "Number at which section headings should start for this component.",
+          "docs": "Number at which section headings should start for the group.",
           "docsTags": [],
           "values": [
             {
@@ -11027,7 +11052,7 @@
       "slots": [
         {
           "name": "",
-          "docs": "A slot for adding `calcite-list-item` and `calcite-list-item-group` elements."
+          "docs": "A slot for adding calcite-list-item and calcite-list-item-group elements."
         }
       ],
       "parts": [],
@@ -11054,7 +11079,7 @@
           "mutable": false,
           "attr": "active",
           "reflectToAttr": true,
-          "docs": "Show the loader",
+          "docs": "When true, the loader is active.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -11071,7 +11096,7 @@
           "mutable": false,
           "attr": "inline",
           "reflectToAttr": true,
-          "docs": "Inline loaders are smaller and will appear to the left of the text",
+          "docs": "When true, displays smaller and appears to the left of the text.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -11088,7 +11113,7 @@
           "mutable": false,
           "attr": "label",
           "reflectToAttr": false,
-          "docs": "Accessible name for the component",
+          "docs": "Accessible name for the loader.",
           "docsTags": [],
           "values": [
             {
@@ -11104,7 +11129,7 @@
           "mutable": false,
           "attr": "no-padding",
           "reflectToAttr": false,
-          "docs": "Turn off spacing around the loader",
+          "docs": "Disables spacing around the loader.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -11121,7 +11146,7 @@
           "mutable": false,
           "attr": "scale",
           "reflectToAttr": true,
-          "docs": "Speficy the scale of the loader. Defaults to \"m\"",
+          "docs": "Specify the scale of the loader.",
           "docsTags": [],
           "default": "\"m\"",
           "values": [
@@ -11147,7 +11172,7 @@
           "mutable": false,
           "attr": "text",
           "reflectToAttr": false,
-          "docs": "Text which should appear under the loading indicator (optional)",
+          "docs": "Text that displays under the loading indicator.",
           "docsTags": [],
           "default": "\"\"",
           "values": [
@@ -11155,7 +11180,7 @@
               "type": "string"
             }
           ],
-          "optional": false,
+          "optional": true,
           "required": false
         },
         {
@@ -11164,7 +11189,7 @@
           "mutable": false,
           "attr": "type",
           "reflectToAttr": true,
-          "docs": "Use indeterminate if finding actual progress value is impossible",
+          "docs": "Use indeterminate if finding actual progress value is impossible.",
           "docsTags": [],
           "values": [
             {
@@ -11185,7 +11210,7 @@
           "mutable": false,
           "attr": "value",
           "reflectToAttr": false,
-          "docs": "Percent complete of 100, only valid for determinate indicators",
+          "docs": "Valid only for determinate indicators. Percent complete of 100.",
           "docsTags": [],
           "default": "0",
           "values": [
@@ -11204,17 +11229,17 @@
         {
           "name": "--calcite-loader-font-size",
           "annotation": "prop",
-          "docs": "when type is determinate, the font-size of the loader percentage"
+          "docs": "When type is determinate, the font-size of the loader percentage."
         },
         {
           "name": "--calcite-loader-size",
           "annotation": "prop",
-          "docs": "the width and height of a non-inline loader"
+          "docs": "The width and height of a non-inline loader."
         },
         {
           "name": "--calcite-loader-size-inline",
           "annotation": "prop",
-          "docs": "the width and height of an inline loader"
+          "docs": "The width and height of an inline loader."
         }
       ],
       "slots": [],
@@ -11554,6 +11579,10 @@
           "parameters": [],
           "docs": "Focus first interactive element",
           "docsTags": [
+            {
+              "name": "param",
+              "text": "el"
+            },
             {
               "name": "deprecated",
               "text": "use `setFocus` instead."
@@ -11570,7 +11599,16 @@
           "signature": "scrollContent(top?: number, left?: number) => Promise<void>",
           "parameters": [],
           "docs": "Set the scroll top of the modal content",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "top"
+            },
+            {
+              "name": "param",
+              "text": "left"
+            }
+          ]
         },
         {
           "name": "setFocus",
@@ -11581,7 +11619,12 @@
           "signature": "setFocus(focusId?: \"close-button\") => Promise<void>",
           "parameters": [],
           "docs": "Sets focus on the component.\n\nBy default, will try to focus on any focusable content. If there is none, it will focus on the close button.\nIf you want to focus on the close button, you can use the `close-button` focus ID.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "focusId"
+            }
+          ]
         }
       ],
       "events": [
@@ -12631,8 +12674,13 @@
           },
           "signature": "scrollContentTo(options?: ScrollToOptions) => Promise<void>",
           "parameters": [],
-          "docs": "Scrolls panel content to a particular set of coordinates.\n\n```\n myCalcitePanel.scrollContentTo({\n   left: 0, // Specifies the number of pixels along the X axis to scroll the window or element.\n   top: 0, // Specifies the number of pixels along the Y axis to scroll the window or element\n   behavior: \"auto\" // Specifies whether the scrolling should animate smoothly (smooth), or happen instantly in a single jump (auto, the default value).\n });\n```",
-          "docsTags": []
+          "docs": "Scrolls panel content to a particular set of coordinates.\n\n```\n  myCalcitePanel.scrollContentTo({\n    left: 0, // Specifies the number of pixels along the X axis to scroll the window or element.\n    top: 0, // Specifies the number of pixels along the Y axis to scroll the window or element\n    behavior: \"auto\" // Specifies whether the scrolling should animate smoothly (smooth), or happen instantly in a single jump (auto, the default value).\n  });\n```",
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "options"
+            }
+          ]
         },
         {
           "name": "setFocus",
@@ -12643,7 +12691,12 @@
           "signature": "setFocus(focusId?: \"dismiss-button\" | \"back-button\") => Promise<void>",
           "parameters": [],
           "docs": "Sets focus on the component.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "focusId"
+            }
+          ]
         }
       ],
       "events": [
@@ -12954,7 +13007,12 @@
           "signature": "setFocus(focusId?: ListFocusId) => Promise<void>",
           "parameters": [],
           "docs": "Sets focus on the component.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "focusId"
+            }
+          ]
         }
       ],
       "events": [
@@ -12980,12 +13038,12 @@
           "passive": false
         },
         {
-          "event": "calciteListItemPropsChange",
+          "event": "calciteInternalListItemPropsChange",
           "capture": false,
           "passive": false
         },
         {
-          "event": "calciteListItemValueChange",
+          "event": "calciteInternalListItemValueChange",
           "capture": false,
           "passive": false
         },
@@ -13333,7 +13391,12 @@
           "signature": "toggleSelected(coerce?: boolean) => Promise<void>",
           "parameters": [],
           "docs": "Used to toggle the selection state. By default this won't trigger an event.\nThe first argument allows the value to be coerced, rather than swapping values.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "coerce"
+            }
+          ]
         }
       ],
       "events": [
@@ -13727,6 +13790,23 @@
           ],
           "optional": false,
           "required": true
+        },
+        {
+          "name": "triggerDisabled",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "trigger-disabled",
+          "reflectToAttr": true,
+          "docs": "Disables automatically toggling a popover when its referenceElement has been triggered. This property can be set to true to manage when a popover is open.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
         }
       ],
       "methods": [
@@ -13750,7 +13830,12 @@
           "signature": "setFocus(focusId?: \"close-button\") => Promise<void>",
           "parameters": [],
           "docs": "Sets focus on the component.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "focusId"
+            }
+          ]
         },
         {
           "name": "toggle",
@@ -13761,7 +13846,12 @@
           "signature": "toggle(value?: boolean) => Promise<void>",
           "parameters": [],
           "docs": "Toggles the popover's open property.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "value"
+            }
+          ]
         }
       ],
       "events": [
@@ -14578,7 +14668,7 @@
       ],
       "listeners": [
         {
-          "event": "calciteRadioGroupItemChange",
+          "event": "calciteInternalRadioGroupItemChange",
           "capture": false,
           "passive": false
         },
@@ -15251,12 +15341,12 @@
       ],
       "listeners": [
         {
-          "event": "calciteOptionChange",
+          "event": "calciteInternalOptionChange",
           "capture": false,
           "passive": false
         },
         {
-          "event": "calciteOptionGroupChange",
+          "event": "calciteInternalOptionGroupChange",
           "capture": false,
           "passive": false
         }
@@ -16813,7 +16903,12 @@
           "signature": "goToStep(step: number) => Promise<void>",
           "parameters": [],
           "docs": "set the requested step as active",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "step"
+            }
+          ]
         },
         {
           "name": "nextStep",
@@ -16852,17 +16947,17 @@
       "events": [],
       "listeners": [
         {
-          "event": "calciteStepperItemKeyEvent",
+          "event": "calciteInternalStepperItemKeyEvent",
           "capture": false,
           "passive": false
         },
         {
-          "event": "calciteStepperItemRegister",
+          "event": "calciteInternalStepperItemRegister",
           "capture": false,
           "passive": false
         },
         {
-          "event": "calciteStepperItemSelect",
+          "event": "calciteInternalStepperItemSelect",
           "capture": false,
           "passive": false
         }
@@ -16998,7 +17093,7 @@
       "events": [],
       "listeners": [
         {
-          "event": "calciteStepperItemChange",
+          "event": "calciteInternalStepperItemChange",
           "target": "body",
           "capture": false,
           "passive": false
@@ -17361,12 +17456,12 @@
       ],
       "listeners": [
         {
-          "event": "calciteTabsFocusPrevious",
+          "event": "calciteInternalTabsFocusPrevious",
           "capture": false,
           "passive": false
         },
         {
-          "event": "calciteTabsFocusNext",
+          "event": "calciteInternalTabsFocusNext",
           "capture": false,
           "passive": false
         },
@@ -17381,7 +17476,7 @@
           "passive": false
         },
         {
-          "event": "calciteTabTitleRegister",
+          "event": "calciteInternalTabTitleRegister",
           "capture": false,
           "passive": false
         },
@@ -17715,7 +17810,7 @@
       "events": [],
       "listeners": [
         {
-          "event": "calciteTabTitleRegister",
+          "event": "calciteInternalTabTitleRegister",
           "capture": false,
           "passive": false
         },
@@ -17726,7 +17821,7 @@
           "passive": false
         },
         {
-          "event": "calciteTabRegister",
+          "event": "calciteInternalTabRegister",
           "capture": false,
           "passive": false
         },
@@ -18692,7 +18787,12 @@
           "signature": "setFocus(target: TimePart) => Promise<void>",
           "parameters": [],
           "docs": "Sets focus on the component.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "target"
+            }
+          ]
         }
       ],
       "events": [],
@@ -19591,7 +19691,7 @@
           "passive": false
         },
         {
-          "event": "calciteTreeItemSelect",
+          "event": "calciteInternalTreeItemSelect",
           "capture": false,
           "passive": false
         },
@@ -19882,7 +19982,12 @@
           "signature": "setFocus(focusId?: ListFocusId) => Promise<void>",
           "parameters": [],
           "docs": "Sets focus on the component.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "focusId"
+            }
+          ]
         }
       ],
       "events": [
@@ -19922,12 +20027,12 @@
           "passive": false
         },
         {
-          "event": "calciteListItemPropsChange",
+          "event": "calciteInternalListItemPropsChange",
           "capture": false,
           "passive": false
         },
         {
-          "event": "calciteListItemValueChange",
+          "event": "calciteInternalListItemValueChange",
           "capture": false,
           "passive": false
         }
@@ -20165,7 +20270,12 @@
           "signature": "toggleSelected(coerce?: boolean) => Promise<void>",
           "parameters": [],
           "docs": "Toggle the selection state. By default this won't trigger an event.\nThe first argument allows the value to be coerced, rather than swapping values.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "coerce"
+            }
+          ]
         }
       ],
       "events": [