@esri/calcite-components 1.0.0-beta.81 → 1.0.0-beta.82

package/dist/extras/docs-json.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2022-04-12T19:02:52",
+  "timestamp": "2022-05-10T19:59:52",
   "compiler": {
     "name": "@stencil/core",
-    "version": "2.15.0",
+    "version": "2.15.1",
     "typescriptVersion": "4.5.4"
   },
   "components": [
@@ -846,14 +846,12 @@
       "dependents": [],
       "dependencies": [
         "calcite-action-group",
-        "calcite-action",
-        "calcite-tooltip-manager"
+        "calcite-action"
       ],
       "dependencyGraph": {
         "calcite-action-bar": [
           "calcite-action-group",
-          "calcite-action",
-          "calcite-tooltip-manager"
+          "calcite-action"
         ],
         "calcite-action-group": [
           "calcite-action-menu",
@@ -861,7 +859,6 @@
         ],
         "calcite-action-menu": [
           "calcite-action",
-          "calcite-tooltip-manager",
           "calcite-popover"
         ],
         "calcite-action": [
@@ -1075,7 +1072,6 @@
         ],
         "calcite-action-menu": [
           "calcite-action",
-          "calcite-tooltip-manager",
           "calcite-popover"
         ],
         "calcite-action": [
@@ -1312,13 +1308,11 @@
       ],
       "dependencies": [
         "calcite-action",
-        "calcite-tooltip-manager",
         "calcite-popover"
       ],
       "dependencyGraph": {
         "calcite-action-menu": [
           "calcite-action",
-          "calcite-tooltip-manager",
           "calcite-popover"
         ],
         "calcite-action": [
@@ -1541,14 +1535,12 @@
       "dependents": [],
       "dependencies": [
         "calcite-action-group",
-        "calcite-action",
-        "calcite-tooltip-manager"
+        "calcite-action"
       ],
       "dependencyGraph": {
         "calcite-action-pad": [
           "calcite-action-group",
-          "calcite-action",
-          "calcite-tooltip-manager"
+          "calcite-action"
         ],
         "calcite-action-group": [
           "calcite-action-menu",
@@ -1556,7 +1548,6 @@
         ],
         "calcite-action-menu": [
           "calcite-action",
-          "calcite-tooltip-manager",
           "calcite-popover"
         ],
         "calcite-action": [
@@ -2149,8 +2140,9 @@
           "mutable": false,
           "attr": "intl-collapse",
           "reflectToAttr": false,
-          "docs": "Tooltip used for the toggle when expanded.",
+          "docs": "Aria-label for collapsing the toggle and tooltip used for the toggle when expanded.",
           "docsTags": [],
+          "default": "TEXT.collapse",
           "values": [
             {
               "type": "string"
@@ -2165,8 +2157,9 @@
           "mutable": false,
           "attr": "intl-expand",
           "reflectToAttr": false,
-          "docs": "Tooltip used for the toggle when collapsed.",
+          "docs": "Aria-label for expanding the toggle and tooltip used for the toggle when collapsed.",
           "docsTags": [],
+          "default": "TEXT.expand",
           "values": [
             {
               "type": "string"
@@ -2352,7 +2345,6 @@
         ],
         "calcite-action-menu": [
           "calcite-action",
-          "calcite-tooltip-manager",
           "calcite-popover"
         ],
         "calcite-action": [
@@ -7616,13 +7608,11 @@
         "calcite-value-list"
       ],
       "dependencies": [
-        "calcite-input",
-        "calcite-icon"
+        "calcite-input"
       ],
       "dependencyGraph": {
         "calcite-filter": [
-          "calcite-input",
-          "calcite-icon"
+          "calcite-input"
         ],
         "calcite-input": [
           "calcite-progress",
@@ -7990,7 +7980,6 @@
         "calcite-combobox-item",
         "calcite-date-picker-month-header",
         "calcite-dropdown-item",
-        "calcite-filter",
         "calcite-handle",
         "calcite-input",
         "calcite-input-date-picker",
@@ -8050,9 +8039,6 @@
         "calcite-dropdown-item": [
           "calcite-icon"
         ],
-        "calcite-filter": [
-          "calcite-icon"
-        ],
         "calcite-handle": [
           "calcite-icon"
         ],
@@ -8533,6 +8519,22 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "intlClear",
+          "type": "string",
+          "mutable": false,
+          "attr": "intl-clear",
+          "reflectToAttr": false,
+          "docs": "A text label that will appear on the clear button for screen readers.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "intlLoading",
           "type": "string",
@@ -8546,7 +8548,7 @@
               "text": "\"Loading\""
             }
           ],
-          "default": "TEXT.loading",
+          "default": "COMMON_TEXT.loading",
           "values": [
             {
               "type": "string"
@@ -10218,6 +10220,17 @@
         }
       ],
       "methods": [
+        {
+          "name": "reposition",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "signature": "reposition() => Promise<void>",
+          "parameters": [],
+          "docs": "Updates the position of the component.",
+          "docsTags": []
+        },
         {
           "name": "setFocus",
           "returns": {
@@ -12644,7 +12657,7 @@
           "docsTags": []
         },
         {
-          "event": "calcitePanelDismissedChange",
+          "event": "calcitePanelDismiss",
           "detail": "any",
           "bubbles": true,
           "cancelable": true,
@@ -12652,6 +12665,21 @@
           "docs": "Emitted when the close button has been clicked.",
           "docsTags": []
         },
+        {
+          "event": "calcitePanelDismissedChange",
+          "detail": "any",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Emitted when the close button has been clicked.",
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "use calcitePanelDismiss instead."
+            }
+          ],
+          "deprecation": "use calcitePanelDismiss instead."
+        },
         {
           "event": "calcitePanelScroll",
           "detail": "any",
@@ -12733,7 +12761,6 @@
         ],
         "calcite-action-menu": [
           "calcite-action",
-          "calcite-tooltip-manager",
           "calcite-popover"
         ],
         "calcite-popover": [
@@ -12991,8 +13018,7 @@
           "calcite-scrim"
         ],
         "calcite-filter": [
-          "calcite-input",
-          "calcite-icon"
+          "calcite-input"
         ],
         "calcite-input": [
           "calcite-progress",
@@ -13380,6 +13406,23 @@
         "Manager": "```html\n<calcite-popover reference-element=\"popover-button\">Hello! I am some popover content!</calcite-popover>\n\n<calcite-popover-manager\n  ><calcite-button id=\"popover-button\">Clickable popover</calcite-button></calcite-popover-manager\n>\n```\n"
       },
       "props": [
+        {
+          "name": "autoClose",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "auto-close",
+          "reflectToAttr": true,
+          "docs": "Automatically closes any currently open popovers when clicking outside of a popover.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "closeButton",
           "type": "boolean",
@@ -13785,6 +13828,10 @@
         {
           "name": "slot",
           "text": "- A slot for adding elements that reference a 'calcite-popover' by the 'selector' property."
+        },
+        {
+          "name": "deprecated",
+          "text": "No longer required for popover usage."
         }
       ],
       "usage": {},
@@ -13819,7 +13866,7 @@
               "text": "`[data-calcite-popover-reference]`"
             }
           ],
-          "default": "`[${POPOVER_REFERENCE}]`",
+          "default": "\"[data-calcite-popover-reference]\"",
           "values": [
             {
               "type": "string"
@@ -13831,14 +13878,7 @@
       ],
       "methods": [],
       "events": [],
-      "listeners": [
-        {
-          "event": "click",
-          "target": "window",
-          "capture": true,
-          "passive": false
-        }
-      ],
+      "listeners": [],
       "styles": [],
       "slots": [
         {
@@ -13849,7 +13889,8 @@
       "parts": [],
       "dependents": [],
       "dependencies": [],
-      "dependencyGraph": {}
+      "dependencyGraph": {},
+      "deprecation": "No longer required for popover usage."
     },
     {
       "filePath": "./src/components/progress/progress.tsx",
@@ -15630,7 +15671,13 @@
           "cancelable": true,
           "composed": true,
           "docs": "Emitted when collapse has been toggled.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "use a resizeObserver on the shell-panel to listen for changes to its size."
+            }
+          ],
+          "deprecation": "use a resizeObserver on the shell-panel to listen for changes to its size."
         }
       ],
       "listeners": [],
@@ -16763,7 +16810,7 @@
             "type": "Promise<void>",
             "docs": ""
           },
-          "signature": "goToStep(num: number) => Promise<void>",
+          "signature": "goToStep(step: number) => Promise<void>",
           "parameters": [],
           "docs": "set the requested step as active",
           "docsTags": []
@@ -16950,11 +16997,6 @@
       "methods": [],
       "events": [],
       "listeners": [
-        {
-          "event": "keydown",
-          "capture": false,
-          "passive": false
-        },
         {
           "event": "calciteStepperItemChange",
           "target": "body",
@@ -17510,7 +17552,7 @@
           "bubbles": true,
           "cancelable": true,
           "composed": true,
-          "docs": "Fires when a specific tab is activated (`event.details`)",
+          "docs": "Fires when a specific tab is activated. Emits the \"tab\" property or the index position.",
           "docsTags": [
             {
               "name": "see",
@@ -19091,6 +19133,15 @@
         }
       ],
       "events": [
+        {
+          "event": "calciteTipManagerClose",
+          "detail": "any",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Emitted when the `calcite-tip-manager` has been closed.",
+          "docsTags": []
+        },
         {
           "event": "calciteTipManagerToggle",
           "detail": "any",
@@ -19098,7 +19149,13 @@
           "cancelable": true,
           "composed": true,
           "docs": "Emitted when the `calcite-tip-manager` has been toggled open or closed.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "use calciteTipManagerClose instead."
+            }
+          ],
+          "deprecation": "use calciteTipManagerClose instead."
         }
       ],
       "listeners": [],
@@ -19150,7 +19207,7 @@
         }
       ],
       "usage": {
-        "Basic": "```html\n<calcite-tooltip placement=\"auto\" reference-element=\"tooltip-button\"\n  >This is the message of the tooltip</calcite-tooltip\n>\n<calcite-tooltip-manager>\n  <p>\n    Lorem <a id=\"tooltip-button\" href=\"#\">ipsum</a> dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor\n    incididunt ut labore et dolore magna aliqua.\n  </p>\n</calcite-tooltip-manager>\n```\n"
+        "Basic": "```html\n<calcite-tooltip placement=\"auto\" reference-element=\"tooltip-button\"\n  >This is the message of the tooltip</calcite-tooltip\n>\n<p>\n  Lorem <a id=\"tooltip-button\" href=\"#\">ipsum</a> dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor\n  incididunt ut labore et dolore magna aliqua.\n</p>\n```\n"
       },
       "props": [
         {
@@ -19332,6 +19389,10 @@
         {
           "name": "slot",
           "text": "- A slot for adding elements that reference a 'calcite-tooltip' by the 'selector' property."
+        },
+        {
+          "name": "deprecated",
+          "text": "No longer required for tooltip usage."
         }
       ],
       "usage": {},
@@ -19349,7 +19410,7 @@
               "text": "`[data-calcite-tooltip-reference]`"
             }
           ],
-          "default": "`[${TOOLTIP_REFERENCE}]`",
+          "default": "\"[data-calcite-tooltip-reference]\"",
           "values": [
             {
               "type": "string"
@@ -19361,39 +19422,7 @@
       ],
       "methods": [],
       "events": [],
-      "listeners": [
-        {
-          "event": "keyup",
-          "target": "document",
-          "capture": false,
-          "passive": false
-        },
-        {
-          "event": "mouseover",
-          "capture": true,
-          "passive": true
-        },
-        {
-          "event": "mouseout",
-          "capture": true,
-          "passive": true
-        },
-        {
-          "event": "click",
-          "capture": true,
-          "passive": false
-        },
-        {
-          "event": "focus",
-          "capture": true,
-          "passive": false
-        },
-        {
-          "event": "blur",
-          "capture": true,
-          "passive": false
-        }
-      ],
+      "listeners": [],
       "styles": [],
       "slots": [
         {
@@ -19402,23 +19431,10 @@
         }
       ],
       "parts": [],
-      "dependents": [
-        "calcite-action-bar",
-        "calcite-action-menu",
-        "calcite-action-pad"
-      ],
+      "dependents": [],
       "dependencies": [],
-      "dependencyGraph": {
-        "calcite-action-bar": [
-          "calcite-tooltip-manager"
-        ],
-        "calcite-action-menu": [
-          "calcite-tooltip-manager"
-        ],
-        "calcite-action-pad": [
-          "calcite-tooltip-manager"
-        ]
-      }
+      "dependencyGraph": {},
+      "deprecation": "No longer required for tooltip usage."
     },
     {
       "filePath": "./src/components/tree/tree.tsx",
@@ -19429,7 +19445,7 @@
       "docsTags": [
         {
           "name": "slot",
-          "text": "- A slot for `calcite-tree-item` elements."
+          "text": "- A slot for calcite-tree-item elements."
         }
       ],
       "usage": {
@@ -19446,11 +19462,11 @@
           "docsTags": [
             {
               "name": "deprecated",
-              "text": "use \"ancestors\" selection-mode for checkbox input"
+              "text": "Use \"ancestors\" selection-mode for checkbox input."
             }
           ],
           "default": "false",
-          "deprecation": "use \"ancestors\" selection-mode for checkbox input",
+          "deprecation": "Use \"ancestors\" selection-mode for checkbox input.",
           "values": [
             {
               "type": "boolean"
@@ -19465,7 +19481,7 @@
           "mutable": true,
           "attr": "lines",
           "reflectToAttr": true,
-          "docs": "Display indentation guide lines",
+          "docs": "Display indentation guide lines.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -19482,7 +19498,7 @@
           "mutable": true,
           "attr": "scale",
           "reflectToAttr": true,
-          "docs": "Specify the scale of the tree, defaults to m",
+          "docs": "Specify the scale of the tree.",
           "docsTags": [],
           "default": "\"m\"",
           "values": [
@@ -19508,7 +19524,7 @@
           "mutable": true,
           "attr": "selection-mode",
           "reflectToAttr": true,
-          "docs": "Customize how tree selection works (single, multi, children, multi-children, ancestors)",
+          "docs": "Customize how tree selection works.",
           "docsTags": [
             {
               "name": "default",
@@ -19549,7 +19565,7 @@
           "bubbles": true,
           "cancelable": true,
           "composed": true,
-          "docs": "Emitted when user selects/deselects tree items. An object including an array of selected items will be passed in the event's `detail` property.",
+          "docs": "Emits when the user selects/deselects tree items. An object including an array of selected items will be passed in the event's \"detail\" property.",
           "docsTags": [
             {
               "name": "see",
@@ -19589,7 +19605,7 @@
       "slots": [
         {
           "name": "",
-          "docs": "A slot for `calcite-tree-item` elements."
+          "docs": "A slot for calcite-tree-item elements."
         }
       ],
       "parts": [],
@@ -19610,7 +19626,7 @@
         },
         {
           "name": "slot",
-          "text": "children - A slot for adding nested `calcite-tree` elements."
+          "text": "children - A slot for adding nested calcite-tree elements."
         }
       ],
       "usage": {},
@@ -19621,7 +19637,7 @@
           "mutable": true,
           "attr": "expanded",
           "reflectToAttr": true,
-          "docs": "True if the item is in an expanded state",
+          "docs": "Expanded state of the item.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -19638,7 +19654,7 @@
           "mutable": true,
           "attr": "selected",
           "reflectToAttr": true,
-          "docs": "Is the item currently selected",
+          "docs": "Selected state of the item.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -19672,7 +19688,7 @@
         },
         {
           "name": "children",
-          "docs": "A slot for adding nested `calcite-tree` elements."
+          "docs": "A slot for adding nested calcite-tree elements."
         }
       ],
       "parts": [],
@@ -19697,11 +19713,11 @@
       "docsTags": [
         {
           "name": "slot",
-          "text": "- A slot for adding `calcite-value-list-item` elements. Items are displayed as a vertical list."
+          "text": "- A slot for adding calcite-value-list-item elements. List items are displayed as a vertical list."
         },
         {
           "name": "slot",
-          "text": "menu-actions - A slot for adding a button + menu combo for performing actions like sorting."
+          "text": "menu-actions - A slot for adding a button and menu combination for performing actions, such as sorting."
         }
       ],
       "usage": {
@@ -19716,7 +19732,7 @@
           "mutable": false,
           "attr": "disabled",
           "reflectToAttr": true,
-          "docs": "When true, disabled prevents interaction. This state shows items with lower opacity/grayed.",
+          "docs": "When true, prevents user interaction. This state shows list items grayed out and with lower opacity.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -19733,7 +19749,7 @@
           "mutable": false,
           "attr": "drag-enabled",
           "reflectToAttr": true,
-          "docs": "When true, the items will be sortable via drag and drop.",
+          "docs": "When true, list items are sortable via a draggable button.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -19750,7 +19766,7 @@
           "mutable": false,
           "attr": "filter-enabled",
           "reflectToAttr": true,
-          "docs": "When true, an input appears at the top of the list that can be used by end users to filter items in the list.",
+          "docs": "When true, an input appears at the top of the list that can be used by end users to filter list items.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -19767,7 +19783,7 @@
           "mutable": false,
           "attr": "filter-placeholder",
           "reflectToAttr": true,
-          "docs": "Placeholder text for the filter input field.",
+          "docs": "Placeholder text for the filter's input field.",
           "docsTags": [],
           "values": [
             {
@@ -19816,7 +19832,7 @@
           "mutable": false,
           "attr": "multiple",
           "reflectToAttr": true,
-          "docs": "Multiple Works similar to standard radio buttons and checkboxes.\nWhen true, a user can select multiple items at a time.\nWhen false, only a single item can be selected at a time\nand selecting a new item will deselect any other selected items.",
+          "docs": "Similar to standard radio buttons and checkboxes.\nWhen true, a user can select multiple list items at a time.\nWhen false, only a single list item can be selected at a time,\nand selecting a new list item will deselect any other selected list items.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -19833,7 +19849,7 @@
           "mutable": false,
           "attr": "selection-follows-focus",
           "reflectToAttr": false,
-          "docs": "When true and single-selection is enabled, the selection will change when navigating items via the keyboard.",
+          "docs": "When true and single-selection is enabled, the selection changes when navigating list items via the keyboard.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -19876,7 +19892,7 @@
           "bubbles": true,
           "cancelable": true,
           "composed": true,
-          "docs": "Emitted when any of the item selections have changed.",
+          "docs": "Emits when any of the list item selections have changed.",
           "docsTags": []
         },
         {
@@ -19885,7 +19901,7 @@
           "bubbles": true,
           "cancelable": true,
           "composed": true,
-          "docs": "Emitted when the order of the list has changed.",
+          "docs": "Emits when the order of the list has changed.",
           "docsTags": []
         }
       ],
@@ -19920,11 +19936,11 @@
       "slots": [
         {
           "name": "",
-          "docs": "A slot for adding `calcite-value-list-item` elements. Items are displayed as a vertical list."
+          "docs": "A slot for adding calcite-value-list-item elements. List items are displayed as a vertical list."
         },
         {
           "name": "menu-actions",
-          "docs": "A slot for adding a button + menu combo for performing actions like sorting."
+          "docs": "A slot for adding a button and menu combination for performing actions, such as sorting."
         }
       ],
       "parts": [],
@@ -19939,8 +19955,7 @@
           "calcite-scrim"
         ],
         "calcite-filter": [
-          "calcite-input",
-          "calcite-icon"
+          "calcite-input"
         ],
         "calcite-input": [
           "calcite-progress",
@@ -19975,7 +19990,7 @@
           "mutable": false,
           "attr": "description",
           "reflectToAttr": true,
-          "docs": "An optional description for this item. Will appear below the label text.",
+          "docs": "An optional description for the list item that displays below the label text.",
           "docsTags": [],
           "values": [
             {
@@ -19991,7 +20006,7 @@
           "mutable": false,
           "attr": "disabled",
           "reflectToAttr": true,
-          "docs": "When true, the item cannot be clicked and is visually muted",
+          "docs": "When true, the list item cannot be clicked and is visually muted.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -20036,7 +20051,7 @@
           "mutable": false,
           "attr": "label",
           "reflectToAttr": true,
-          "docs": "The main label for this item. Appears next to the icon.",
+          "docs": "The main label for the list item. Appears next to the icon.",
           "docsTags": [],
           "values": [
             {
@@ -20051,7 +20066,7 @@
           "type": "{ [x: string]: unknown; }",
           "mutable": false,
           "reflectToAttr": false,
-          "docs": "Used to provide additional metadata to an item, primarily used when the parent list has a filter.",
+          "docs": "Provides additional metadata to a list item. Primary use is for a filter on the parent list.",
           "docsTags": [],
           "values": [
             {
@@ -20084,7 +20099,7 @@
           "mutable": false,
           "attr": "removable",
           "reflectToAttr": true,
-          "docs": "Set this to true to display a remove action that removes the item from the list.",
+          "docs": "When true, adds an action to remove the list item.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -20101,7 +20116,7 @@
           "mutable": true,
           "attr": "selected",
           "reflectToAttr": true,
-          "docs": "Set this to true to pre-select an item. Toggles when an item is checked/unchecked.",
+          "docs": "When true, preselects the list item. Toggles when an item is checked/unchecked.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -20118,7 +20133,7 @@
           "mutable": false,
           "attr": "value",
           "reflectToAttr": false,
-          "docs": "The item's associated value.",
+          "docs": "The list item's associated value.",
           "docsTags": [],
           "values": [
             {
@@ -20138,7 +20153,7 @@
           },
           "signature": "setFocus() => Promise<void>",
           "parameters": [],
-          "docs": "Sets focus on the component.",
+          "docs": "Set focus on the component.",
           "docsTags": []
         },
         {
@@ -20149,7 +20164,7 @@
           },
           "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.",
+          "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": []
         }
       ],
@@ -20160,7 +20175,7 @@
           "bubbles": true,
           "cancelable": true,
           "composed": true,
-          "docs": "Emitted whenever the remove button is pressed.",
+          "docs": "Emits when the remove button is pressed.",
           "docsTags": []
         }
       ],