@esri/calcite-components 1.0.0-next.701 → 1.0.0-next.703

package/dist/extras/docs-json.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2022-12-18T03:12:51",
+  "timestamp": "2022-12-28T19:53:49",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.20.0",
@@ -124,7 +124,7 @@
         },
         {
           "name": "selectionMode",
-          "type": "\"multiple\" | \"single\"",
+          "type": "\"multiple\" | \"single\" | \"single-persist\"",
           "mutable": false,
           "attr": "selection-mode",
           "reflectToAttr": true,
@@ -139,6 +139,10 @@
             {
               "value": "single",
               "type": "string"
+            },
+            {
+              "value": "single-persist",
+              "type": "string"
             }
           ],
           "optional": false,
@@ -691,15 +695,15 @@
       "docsTags": [
         {
           "name": "slot",
-          "text": "- A slot for adding `calcite-action`s that will appear at the top of the action bar."
+          "text": "- A slot for adding `calcite-action`s that will appear at the top of the component."
         },
         {
           "name": "slot",
-          "text": "bottom-actions - A slot for adding `calcite-action`s that will appear at the bottom of the action bar, above the collapse/expand button."
+          "text": "bottom-actions - A slot for adding `calcite-action`s that will appear at the bottom of the component, above the collapse/expand button."
         },
         {
           "name": "slot",
-          "text": "expand-tooltip - Used to set the tooltip for the expand toggle."
+          "text": "expand-tooltip - A slot to set the `calcite-tooltip` for the expand toggle."
         }
       ],
       "usage": {
@@ -879,15 +883,15 @@
       "slots": [
         {
           "name": "",
-          "docs": "A slot for adding `calcite-action`s that will appear at the top of the action bar."
+          "docs": "A slot for adding `calcite-action`s that will appear at the top of the component."
         },
         {
           "name": "bottom-actions",
-          "docs": "A slot for adding `calcite-action`s that will appear at the bottom of the action bar, above the collapse/expand button."
+          "docs": "A slot for adding `calcite-action`s that will appear at the bottom of the component, above the collapse/expand button."
         },
         {
           "name": "expand-tooltip",
-          "docs": "Used to set the tooltip for the expand toggle."
+          "docs": "A slot to set the `calcite-tooltip` for the expand toggle."
         }
       ],
       "parts": [],
@@ -1464,7 +1468,7 @@
         },
         {
           "name": "slot",
-          "text": "expand-tooltip - Used to set the `calcite-tooltip` for the expand toggle."
+          "text": "expand-tooltip - A slot to set the `calcite-tooltip` for the expand toggle."
         }
       ],
       "usage": {
@@ -1634,7 +1638,7 @@
         },
         {
           "name": "expand-tooltip",
-          "docs": "Used to set the `calcite-tooltip` for the expand toggle."
+          "docs": "A slot to set the `calcite-tooltip` for the expand toggle."
         }
       ],
       "parts": [],
@@ -1687,7 +1691,7 @@
         },
         {
           "name": "slot",
-          "text": "actions-end - A slot for adding actions to the end of the component. It is recommended to use two or fewer actions."
+          "text": "actions-end - A slot for adding `calcite-action`s to the end of the component. It is recommended to use two or fewer actions."
         }
       ],
       "usage": {
@@ -2104,7 +2108,7 @@
       "slots": [
         {
           "name": "actions-end",
-          "docs": "A slot for adding actions to the end of the component. It is recommended to use two or fewer actions."
+          "docs": "A slot for adding `calcite-action`s to the end of the component. It is recommended to use two or fewer actions."
         },
         {
           "name": "link",
@@ -2262,7 +2266,7 @@
       "docsTags": [
         {
           "name": "slot",
-          "text": "- A slot for adding content to the component."
+          "text": "- A slot for adding custom content."
         },
         {
           "name": "slot",
@@ -2274,7 +2278,7 @@
         },
         {
           "name": "slot",
-          "text": "header-menu-actions - A slot for adding an overflow menu with `calcite-action`s inside a dropdown."
+          "text": "header-menu-actions - A slot for adding an overflow menu with `calcite-action`s inside a dropdown menu."
         }
       ],
       "usage": {
@@ -2503,7 +2507,7 @@
       "slots": [
         {
           "name": "",
-          "docs": "A slot for adding content to the component."
+          "docs": "A slot for adding custom content."
         },
         {
           "name": "control",
@@ -2511,7 +2515,7 @@
         },
         {
           "name": "header-menu-actions",
-          "docs": "A slot for adding an overflow menu with `calcite-action`s inside a dropdown."
+          "docs": "A slot for adding an overflow menu with `calcite-action`s inside a dropdown menu."
         },
         {
           "name": "icon",
@@ -2564,7 +2568,7 @@
       "docsTags": [
         {
           "name": "slot",
-          "text": "- A slot for adding content to the component."
+          "text": "- A slot for adding custom content."
         }
       ],
       "usage": {},
@@ -2682,7 +2686,7 @@
       "slots": [
         {
           "name": "",
-          "docs": "A slot for adding content to the component."
+          "docs": "A slot for adding custom content."
         }
       ],
       "parts": [],
@@ -5287,24 +5291,7 @@
           "required": true
         }
       ],
-      "methods": [
-        {
-          "name": "toggleSelected",
-          "returns": {
-            "type": "Promise<void>",
-            "docs": ""
-          },
-          "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": [
-            {
-              "name": "param",
-              "text": "coerce"
-            }
-          ]
-        }
-      ],
+      "methods": [],
       "events": [
         {
           "event": "calciteComboboxItemChange",
@@ -5775,12 +5762,7 @@
           "cancelable": false,
           "composed": true,
           "docs": "Emits when a user changes the component's date `range`. For components without `range` use `calciteDatePickerChange`.",
-          "docsTags": [
-            {
-              "name": "see",
-              "text": "[DateRangeChange](https://github.com/Esri/calcite-components/blob/master/src/components/date-picker/interfaces.ts#L1)"
-            }
-          ]
+          "docsTags": []
         }
       ],
       "listeners": [],
@@ -6406,7 +6388,7 @@
       "docsTags": [
         {
           "name": "slot",
-          "text": "- A slot for adding `calcite-dropdown-group` components. Every `calcite-dropdown-item` must have a parent `calcite-dropdown-group`, even if the `groupTitle` property is not set."
+          "text": "- A slot for adding `calcite-dropdown-group` elements. Every `calcite-dropdown-item` must have a parent `calcite-dropdown-group`, even if the `groupTitle` property is not set."
         },
         {
           "name": "slot",
@@ -6775,7 +6757,7 @@
       "slots": [
         {
           "name": "",
-          "docs": "A slot for adding `calcite-dropdown-group` components. Every `calcite-dropdown-item` must have a parent `calcite-dropdown-group`, even if the `groupTitle` property is not set."
+          "docs": "A slot for adding `calcite-dropdown-group` elements. Every `calcite-dropdown-item` must have a parent `calcite-dropdown-group`, even if the `groupTitle` property is not set."
         },
         {
           "name": "trigger",
@@ -7556,7 +7538,7 @@
       "docsTags": [
         {
           "name": "slot",
-          "text": "- A slot for adding `calcite-flow-item` to the component."
+          "text": "- A slot for adding `calcite-flow-item` elements to the component."
         }
       ],
       "usage": {
@@ -7589,7 +7571,7 @@
       "slots": [
         {
           "name": "",
-          "docs": "A slot for adding `calcite-flow-item` to the component."
+          "docs": "A slot for adding `calcite-flow-item` elements to the component."
         }
       ],
       "parts": [],
@@ -7848,23 +7830,6 @@
           "optional": false,
           "required": false
         },
-        {
-          "name": "showBackButton",
-          "type": "boolean",
-          "mutable": false,
-          "attr": "show-back-button",
-          "reflectToAttr": true,
-          "docs": "When true, displays a back button in the header.\nWhen `true`, displays a back button in the component's header.",
-          "docsTags": [],
-          "default": "false",
-          "values": [
-            {
-              "type": "boolean"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
         {
           "name": "widthScale",
           "type": "\"l\" | \"m\" | \"s\"",
@@ -9615,7 +9580,7 @@
       "docs": "",
       "docsTags": [],
       "usage": {
-        "Basic": "```html\n<div style=\"width: 400px\">\n  <calcite-label layout=\"inline\">\n    Date\n    <calcite-input-date-picker\n      min=\"2016-08-09\"\n      max=\"2023-12-18\"\n      lang=\"en\"\n      intl-next-month=\"Next month\"\n      intl-prev-month=\"Previous month\"\n      role=\"application\"\n      layout=\"horizontal\"\n    ></calcite-input-date-picker>\n  </calcite-label>\n</div>\n```\n"
+        "Basic": "```html\n<div style=\"width: 400px\">\n  <calcite-label layout=\"inline\">\n    Date\n    <calcite-input-date-picker\n      min=\"2016-08-09\"\n      max=\"2023-12-18\"\n      lang=\"en\"\n      role=\"application\"\n      layout=\"horizontal\"\n    ></calcite-input-date-picker>\n  </calcite-label>\n</div>\n```\n"
       },
       "props": [
         {
@@ -13399,7 +13364,7 @@
         },
         {
           "name": "kind",
-          "type": "\"brand\" | \"danger\" | \"info\" | \"inverse\" | \"neutral\" | \"success\" | \"warning\"",
+          "type": "\"brand\" | \"danger\" | \"info\" | \"success\" | \"warning\"",
           "mutable": false,
           "attr": "kind",
           "reflectToAttr": true,
@@ -13418,14 +13383,6 @@
               "value": "info",
               "type": "string"
             },
-            {
-              "value": "inverse",
-              "type": "string"
-            },
-            {
-              "value": "neutral",
-              "type": "string"
-            },
             {
               "value": "success",
               "type": "string"
@@ -13570,15 +13527,21 @@
             "type": "Promise<void>",
             "docs": ""
           },
-          "signature": "setFocus(focusId?: \"close-button\") => Promise<void>",
+          "signature": "setFocus() => Promise<void>",
           "parameters": [],
           "docs": "Sets focus on the component.\n\nBy default, tries to focus on focusable content. If there is none, it will focus on the close button.\nTo focus on the close button, use the `close-button` focus ID.",
-          "docsTags": [
-            {
-              "name": "param",
-              "text": "focusId"
-            }
-          ]
+          "docsTags": []
+        },
+        {
+          "name": "updateFocusTrapElements",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "signature": "updateFocusTrapElements() => Promise<void>",
+          "parameters": [],
+          "docs": "Updates the element(s) that are used within the focus-trap of the component.",
+          "docsTags": []
         }
       ],
       "events": [
@@ -13699,11 +13662,11 @@
         },
         {
           "name": "slot",
-          "text": "link - A slot for adding actions to take, such as: undo, try again, link to page, etc."
+          "text": "link - A slot for adding a `calcite-action` to take, such as: \"undo\", \"try again\", \"link to page\", etc."
         },
         {
           "name": "slot",
-          "text": "actions-end - A slot for adding actions to the end of the component. It is recommended to use two or less actions."
+          "text": "actions-end - A slot for adding `calcite-action`s to the end of the component. It is recommended to use two or less actions."
         }
       ],
       "usage": {
@@ -13935,11 +13898,11 @@
       "slots": [
         {
           "name": "actions-end",
-          "docs": "A slot for adding actions to the end of the component. It is recommended to use two or less actions."
+          "docs": "A slot for adding `calcite-action`s to the end of the component. It is recommended to use two or less actions."
         },
         {
           "name": "link",
-          "docs": "A slot for adding actions to take, such as: undo, try again, link to page, etc."
+          "docs": "A slot for adding a `calcite-action` to take, such as: \"undo\", \"try again\", \"link to page\", etc."
         },
         {
           "name": "message",
@@ -14367,13 +14330,7 @@
         }
       ],
       "listeners": [],
-      "styles": [
-        {
-          "name": "--calcite-pagination-spacing",
-          "annotation": "prop",
-          "docs": "The amount of padding around each pagination item."
-        }
-      ],
+      "styles": [],
       "slots": [],
       "parts": [],
       "dependents": [],
@@ -14680,15 +14637,10 @@
             "type": "Promise<void>",
             "docs": ""
           },
-          "signature": "setFocus(focusId?: \"back-button\" | \"dismiss-button\") => Promise<void>",
+          "signature": "setFocus() => Promise<void>",
           "parameters": [],
           "docs": "Sets focus on the component.",
-          "docsTags": [
-            {
-              "name": "param",
-              "text": "focusId"
-            }
-          ]
+          "docsTags": []
         }
       ],
       "events": [
@@ -15967,31 +15919,21 @@
             "type": "Promise<void>",
             "docs": ""
           },
-          "signature": "setFocus(focusId?: \"close-button\") => Promise<void>",
+          "signature": "setFocus() => Promise<void>",
           "parameters": [],
           "docs": "Sets focus on the component.",
-          "docsTags": [
-            {
-              "name": "param",
-              "text": "focusId"
-            }
-          ]
+          "docsTags": []
         },
         {
-          "name": "toggle",
+          "name": "updateFocusTrapElements",
           "returns": {
             "type": "Promise<void>",
             "docs": ""
           },
-          "signature": "toggle(value?: boolean) => Promise<void>",
+          "signature": "updateFocusTrapElements() => Promise<void>",
           "parameters": [],
-          "docs": "Toggles the component's open property.",
-          "docsTags": [
-            {
-              "name": "param",
-              "text": "value"
-            }
-          ]
+          "docs": "Updates the element(s) that are used within the focus-trap of the component.",
+          "docsTags": []
         }
       ],
       "events": [
@@ -16529,13 +16471,33 @@
           ],
           "optional": false,
           "required": false
+        },
+        {
+          "name": "selectedItem",
+          "type": "HTMLCalciteRadioButtonElement",
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "Specifies the component's selected item.",
+          "docsTags": [
+            {
+              "name": "readonly"
+            }
+          ],
+          "default": "null",
+          "values": [
+            {
+              "type": "HTMLCalciteRadioButtonElement"
+            }
+          ],
+          "optional": false,
+          "required": false
         }
       ],
       "methods": [],
       "events": [
         {
           "event": "calciteRadioButtonGroupChange",
-          "detail": "any",
+          "detail": "void",
           "bubbles": true,
           "cancelable": false,
           "composed": true,
@@ -16580,7 +16542,7 @@
       "props": [
         {
           "name": "appearance",
-          "type": "\"outline\" | \"solid\"",
+          "type": "\"outline\" | \"outline-fill\" | \"solid\"",
           "mutable": false,
           "attr": "appearance",
           "reflectToAttr": true,
@@ -16592,6 +16554,10 @@
               "value": "outline",
               "type": "string"
             },
+            {
+              "value": "outline-fill",
+              "type": "string"
+            },
             {
               "value": "solid",
               "type": "string"
@@ -16908,7 +16874,7 @@
       "docs": "",
       "docsTags": [],
       "usage": {
-        "Basic": "```html\n<calcite-rating\n  show-chip\n  scale=\"m\"\n  value=\"0\"\n  average=\"4.4\"\n  count=\"10\"\n  intl-rating=\"Rating\"\n  intl-stars=\"Rating\"\n></calcite-rating>\n```\n"
+        "Basic": "```html\n<calcite-rating show-chip scale=\"m\" value=\"0\" average=\"4.4\" count=\"10\"></calcite-rating>\n```\n"
       },
       "props": [
         {
@@ -17453,7 +17419,7 @@
       "docsTags": [
         {
           "name": "slot",
-          "text": "- A slot for adding content to the component. This content will appear between any leading and trailing panels added to the component, such as a map."
+          "text": "- A slot for adding custom content. This content will appear between any leading and trailing panels added to the component, such as a map."
         },
         {
           "name": "slot",
@@ -17477,7 +17443,7 @@
         },
         {
           "name": "slot",
-          "text": "modal - A slot for adding `calcite-modal` components. When placed in this slot, the modal position will be constrained to the extent of the shell."
+          "text": "modals - A slot for adding `calcite-modal` components. When placed in this slot, the modal position will be constrained to the extent of the shell."
         },
         {
           "name": "slot",
@@ -17522,7 +17488,7 @@
       "slots": [
         {
           "name": "",
-          "docs": "A slot for adding content to the component. This content will appear between any leading and trailing panels added to the component, such as a map."
+          "docs": "A slot for adding custom content. This content will appear between any leading and trailing panels added to the component, such as a map."
         },
         {
           "name": "alerts",
@@ -17541,7 +17507,7 @@
           "docs": "A slot for adding header content. This content will be positioned at the top of the component."
         },
         {
-          "name": "modal",
+          "name": "modals",
           "docs": "A slot for adding `calcite-modal` components. When placed in this slot, the modal position will be constrained to the extent of the shell."
         },
         {
@@ -17670,7 +17636,7 @@
       "docsTags": [
         {
           "name": "slot",
-          "text": "- A slot for adding content to the component."
+          "text": "- A slot for adding custom content."
         },
         {
           "name": "slot",
@@ -17832,7 +17798,7 @@
       "slots": [
         {
           "name": "",
-          "docs": "A slot for adding content to the component."
+          "docs": "A slot for adding custom content."
         },
         {
           "name": "action-bar",
@@ -18943,7 +18909,7 @@
       "docsTags": [
         {
           "name": "slot",
-          "text": "- A slot for adding `calcite-stepper-item`s."
+          "text": "- A slot for adding `calcite-stepper-item` elements."
         }
       ],
       "usage": {
@@ -19132,6 +19098,26 @@
           ],
           "optional": false,
           "required": false
+        },
+        {
+          "name": "selectedItem",
+          "type": "HTMLCalciteStepperItemElement",
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "Specifies the component's selected item.",
+          "docsTags": [
+            {
+              "name": "readonly"
+            }
+          ],
+          "default": "null",
+          "values": [
+            {
+              "type": "HTMLCalciteStepperItemElement"
+            }
+          ],
+          "optional": false,
+          "required": false
         }
       ],
       "methods": [
@@ -19199,7 +19185,7 @@
       "events": [
         {
           "event": "calciteStepperItemChange",
-          "detail": "StepperItemChangeEventDetail",
+          "detail": "void",
           "bubbles": true,
           "cancelable": false,
           "composed": true,
@@ -19233,7 +19219,7 @@
       "slots": [
         {
           "name": "",
-          "docs": "A slot for adding `calcite-stepper-item`s."
+          "docs": "A slot for adding `calcite-stepper-item` elements."
         }
       ],
       "parts": [],
@@ -19580,7 +19566,7 @@
       "docsTags": [
         {
           "name": "slot",
-          "text": "- A slot for adding content to the component."
+          "text": "- A slot for adding custom content."
         }
       ],
       "usage": {
@@ -19647,7 +19633,7 @@
       "slots": [
         {
           "name": "",
-          "docs": "A slot for adding content to the component."
+          "docs": "A slot for adding custom content."
         }
       ],
       "parts": [],
@@ -19677,6 +19663,26 @@
         "Basic": "When tab-nav is the only parent, tab-title can inherit its `scale` and `position` from tab-nav:\n\n```html\n<calcite-tab-nav scale=\"l\" position=\"bottom\">\n  <calcite-tab-title>Layers</calcite-tab-title>\n  <calcite-tab-title>Maps</calcite-tab-title>\n  <calcite-tab-title selected>Data</calcite-tab-title>\n</calcite-tab-nav>\n```\n"
       },
       "props": [
+        {
+          "name": "selectedTitle",
+          "type": "HTMLCalciteTabTitleElement",
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "Specifies the component's selected tab-title.",
+          "docsTags": [
+            {
+              "name": "readonly"
+            }
+          ],
+          "default": "null",
+          "values": [
+            {
+              "type": "HTMLCalciteTabTitleElement"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "storageId",
           "type": "string",
@@ -19930,7 +19936,7 @@
           "bubbles": true,
           "cancelable": false,
           "composed": true,
-          "docs": "Fires when a `calcite-tab` is selected. Emits the `tab` property, or the index position.",
+          "docs": "Fires when a `calcite-tab` is selected.",
           "docsTags": []
         }
       ],
@@ -19988,7 +19994,7 @@
         },
         {
           "name": "slot",
-          "text": "tab-nav - A slot for adding a `calcite-tab-nav`."
+          "text": "title-group - A slot for adding a `calcite-tab-nav`."
         }
       ],
       "usage": {
@@ -20117,7 +20123,7 @@
           "docs": "A slot for adding `calcite-tab`s."
         },
         {
-          "name": "tab-nav",
+          "name": "title-group",
           "docs": "A slot for adding a `calcite-tab-nav`."
         }
       ],
@@ -20695,7 +20701,7 @@
       "docsTags": [
         {
           "name": "slot",
-          "text": "- A slot for adding `calcite-tile-select`s."
+          "text": "- A slot for adding `calcite-tile-select` elements."
         }
       ],
       "usage": {},
@@ -20747,7 +20753,7 @@
       "slots": [
         {
           "name": "",
-          "docs": "A slot for adding `calcite-tile-select`s."
+          "docs": "A slot for adding `calcite-tile-select` elements."
         }
       ],
       "parts": [],
@@ -21783,7 +21789,7 @@
         },
         {
           "name": "selectionMode",
-          "type": "\"ancestors\" | \"children\" | \"multichildren\" | \"multiple\" | \"none\" | \"single\"",
+          "type": "\"ancestors\" | \"children\" | \"multichildren\" | \"multiple\" | \"none\" | \"single\" | \"single-persist\"",
           "mutable": true,
           "attr": "selection-mode",
           "reflectToAttr": true,
@@ -21819,6 +21825,10 @@
             {
               "value": "single",
               "type": "string"
+            },
+            {
+              "value": "single-persist",
+              "type": "string"
             }
           ],
           "optional": false,
@@ -21885,7 +21895,7 @@
       "docsTags": [
         {
           "name": "slot",
-          "text": "- A slot for adding the component's content."
+          "text": "- A slot for adding text."
         },
         {
           "name": "slot",
@@ -21964,7 +21974,7 @@
       "slots": [
         {
           "name": "",
-          "docs": "A slot for adding the component's content."
+          "docs": "A slot for adding text."
         },
         {
           "name": "children",
@@ -22339,11 +22349,11 @@
       "docsTags": [
         {
           "name": "slot",
-          "text": "actions-end - A slot for adding actions or content to the end side of the component."
+          "text": "actions-end - A slot for adding `calcite-action`s or content to the end side of the component."
         },
         {
           "name": "slot",
-          "text": "actions-start - A slot for adding actions or content to the start side of the component."
+          "text": "actions-start - A slot for adding `calcite-action`s or content to the start side of the component."
         }
       ],
       "usage": {},
@@ -22576,11 +22586,11 @@
       "slots": [
         {
           "name": "actions-end",
-          "docs": "A slot for adding actions or content to the end side of the component."
+          "docs": "A slot for adding `calcite-action`s or content to the end side of the component."
         },
         {
           "name": "actions-start",
-          "docs": "A slot for adding actions or content to the start side of the component."
+          "docs": "A slot for adding `calcite-action`s or content to the start side of the component."
         }
       ],
       "parts": [],