@esri/calcite-components 1.3.0-next.0 → 1.3.0-next.10

package/dist/extras/docs-json.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2023-04-06T01:08:46",
+  "timestamp": "2023-04-21T22:39:17",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.22.3",
@@ -651,6 +651,7 @@
         "calcite-action-menu",
         "calcite-action-pad",
         "calcite-flow-item",
+        "calcite-list-item",
         "calcite-panel",
         "calcite-pick-list-item",
         "calcite-popover",
@@ -681,6 +682,9 @@
         "calcite-flow-item": [
           "calcite-action"
         ],
+        "calcite-list-item": [
+          "calcite-action"
+        ],
         "calcite-panel": [
           "calcite-action"
         ],
@@ -1018,8 +1022,14 @@
           "attr": "layout",
           "reflectToAttr": true,
           "docs": "Indicates the layout of the component.",
-          "docsTags": [],
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "Use the `layout` property on the component's parent instead."
+            }
+          ],
           "default": "\"vertical\"",
+          "deprecation": "Use the `layout` property on the component's parent instead.",
           "values": [
             {
               "value": "grid",
@@ -3695,6 +3705,23 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "disabled",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "disabled",
+          "reflectToAttr": true,
+          "docs": "When true, interaction is prevented and the component is displayed with lower opacity.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "icon",
           "type": "string",
@@ -3754,6 +3781,22 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "label",
+          "type": "string",
+          "mutable": false,
+          "attr": "label",
+          "reflectToAttr": false,
+          "docs": "Accessible name for the component.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "messageOverrides",
           "type": "{ dismissLabel?: string; }",
@@ -3795,6 +3838,23 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "selected",
+          "type": "boolean",
+          "mutable": true,
+          "attr": "selected",
+          "reflectToAttr": true,
+          "docs": "When true, the component is selected.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "value",
           "type": "any",
@@ -3821,7 +3881,7 @@
           },
           "signature": "setFocus() => Promise<void>",
           "parameters": [],
-          "docs": "When `closable` is `true`, sets focus on the component's \"close\" button (the first focusable item).",
+          "docs": "Sets focus on the component.",
           "docsTags": []
         }
       ],
@@ -3832,11 +3892,31 @@
           "bubbles": true,
           "cancelable": false,
           "composed": true,
-          "docs": "Fires when the close button is clicked.",
+          "docs": "Fires when the component's close button is selected.",
+          "docsTags": []
+        },
+        {
+          "event": "calciteChipSelect",
+          "detail": "void",
+          "bubbles": true,
+          "cancelable": false,
+          "composed": true,
+          "docs": "Fires when the selected state of the component changes.",
           "docsTags": []
         }
       ],
-      "listeners": [],
+      "listeners": [
+        {
+          "event": "keydown",
+          "capture": false,
+          "passive": false
+        },
+        {
+          "event": "click",
+          "capture": false,
+          "passive": false
+        }
+      ],
       "styles": [],
       "slots": [
         {
@@ -3872,6 +3952,183 @@
         ]
       }
     },
+    {
+      "filePath": "./src/components/chip-group/chip-group.tsx",
+      "encapsulation": "shadow",
+      "tag": "calcite-chip-group",
+      "readme": "# calcite-tile-select-group\n",
+      "docs": "",
+      "docsTags": [
+        {
+          "name": "slot",
+          "text": "- A slot for adding one or more `calcite-chip`s."
+        }
+      ],
+      "usage": {},
+      "props": [
+        {
+          "name": "disabled",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "disabled",
+          "reflectToAttr": true,
+          "docs": "When true, interaction is prevented and the component is displayed with lower opacity.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "label",
+          "type": "string",
+          "mutable": false,
+          "attr": "label",
+          "reflectToAttr": false,
+          "docs": "Accessible name for the component.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": true
+        },
+        {
+          "name": "scale",
+          "type": "\"l\" | \"m\" | \"s\"",
+          "mutable": false,
+          "attr": "scale",
+          "reflectToAttr": true,
+          "docs": "Specifies the size of the component.",
+          "docsTags": [],
+          "default": "\"m\"",
+          "values": [
+            {
+              "value": "l",
+              "type": "string"
+            },
+            {
+              "value": "m",
+              "type": "string"
+            },
+            {
+              "value": "s",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "selectedItems",
+          "type": "HTMLCalciteChipElement[]",
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "Specifies the component's selected items.",
+          "docsTags": [
+            {
+              "name": "readonly"
+            }
+          ],
+          "default": "[]",
+          "values": [
+            {
+              "type": "HTMLCalciteChipElement[]"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "selectionMode",
+          "type": "\"multiple\" | \"none\" | \"single\" | \"single-persist\"",
+          "mutable": false,
+          "attr": "selection-mode",
+          "reflectToAttr": true,
+          "docs": "Specifies the selection mode of the component.",
+          "docsTags": [],
+          "default": "\"none\"",
+          "values": [
+            {
+              "value": "multiple",
+              "type": "string"
+            },
+            {
+              "value": "none",
+              "type": "string"
+            },
+            {
+              "value": "single",
+              "type": "string"
+            },
+            {
+              "value": "single-persist",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [
+        {
+          "name": "setFocus",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "signature": "setFocus() => Promise<void>",
+          "parameters": [],
+          "docs": "Sets focus on the component's first focusable element.",
+          "docsTags": []
+        }
+      ],
+      "events": [
+        {
+          "event": "calciteChipGroupSelect",
+          "detail": "void",
+          "bubbles": true,
+          "cancelable": false,
+          "composed": true,
+          "docs": "Emits when the component's selection changes.",
+          "docsTags": []
+        }
+      ],
+      "listeners": [
+        {
+          "event": "calciteInternalChipKeyEvent",
+          "capture": false,
+          "passive": false
+        },
+        {
+          "event": "calciteChipClose",
+          "capture": false,
+          "passive": false
+        },
+        {
+          "event": "calciteChipSelect",
+          "capture": false,
+          "passive": false
+        }
+      ],
+      "styles": [],
+      "slots": [
+        {
+          "name": "",
+          "docs": "A slot for adding one or more `calcite-chip`s."
+        }
+      ],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    },
     {
       "filePath": "./src/components/color-picker/color-picker.tsx",
       "encapsulation": "shadow",
@@ -4580,7 +4837,7 @@
       "filePath": "./src/components/color-picker-swatch/color-picker-swatch.tsx",
       "encapsulation": "shadow",
       "tag": "calcite-color-picker-swatch",
-      "readme": "# my-component\n",
+      "readme": "# calcite-color-picker-swatch\n",
       "docs": "",
       "docsTags": [],
       "usage": {},
@@ -9344,7 +9601,7 @@
         {
           "name": "scale",
           "type": "\"l\" | \"m\" | \"s\"",
-          "mutable": true,
+          "mutable": false,
           "attr": "scale",
           "reflectToAttr": true,
           "docs": "Specifies the size of the component.",
@@ -9370,7 +9627,7 @@
         {
           "name": "status",
           "type": "\"idle\" | \"invalid\" | \"valid\"",
-          "mutable": true,
+          "mutable": false,
           "attr": "status",
           "reflectToAttr": true,
           "docs": "Specifies the status of the input field, which determines message and icons.",
@@ -9767,14 +10024,14 @@
         },
         {
           "name": "messageOverrides",
-          "type": "{ nextMonth?: string; prevMonth?: string; year?: string; }",
+          "type": "{ chooseDate?: string; nextMonth?: string; prevMonth?: string; year?: string; }",
           "mutable": true,
           "reflectToAttr": false,
           "docs": "Use this property to override individual strings used by the component.",
           "docsTags": [],
           "values": [
             {
-              "type": "{ nextMonth?: string; prevMonth?: string; year?: string; }"
+              "type": "{ chooseDate?: string; nextMonth?: string; prevMonth?: string; year?: string; }"
             }
           ],
           "optional": false,
@@ -10300,7 +10557,7 @@
         {
           "name": "scale",
           "type": "\"l\" | \"m\" | \"s\"",
-          "mutable": true,
+          "mutable": false,
           "attr": "scale",
           "reflectToAttr": true,
           "docs": "Specifies the size of the component.",
@@ -10993,7 +11250,7 @@
         {
           "name": "scale",
           "type": "\"l\" | \"m\" | \"s\"",
-          "mutable": true,
+          "mutable": false,
           "attr": "scale",
           "reflectToAttr": true,
           "docs": "Specifies the size of the component.",
@@ -11617,7 +11874,7 @@
         {
           "name": "scale",
           "type": "\"l\" | \"m\" | \"s\"",
-          "mutable": true,
+          "mutable": false,
           "attr": "scale",
           "reflectToAttr": true,
           "docs": "Specifies the size of the component.",
@@ -12859,6 +13116,11 @@
           "event": "calciteInternalListItemSelect",
           "capture": false,
           "passive": false
+        },
+        {
+          "event": "calciteListItemClose",
+          "capture": false,
+          "passive": false
         }
       ],
       "styles": [],
@@ -12925,6 +13187,40 @@
       ],
       "usage": {},
       "props": [
+        {
+          "name": "closable",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "closable",
+          "reflectToAttr": true,
+          "docs": "When `true`, a close button is added to the component.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "closed",
+          "type": "boolean",
+          "mutable": true,
+          "attr": "closed",
+          "reflectToAttr": true,
+          "docs": "When `true`, hides the component.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "description",
           "type": "string",
@@ -12974,6 +13270,21 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "messageOverrides",
+          "type": "{ close?: string; }",
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "Use this property to override individual strings used by the component.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "{ close?: string; }"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "metadata",
           "type": "{ [x: string]: unknown; }",
@@ -13012,7 +13323,7 @@
           "mutable": true,
           "attr": "selected",
           "reflectToAttr": true,
-          "docs": "When `true`, the component is selected.",
+          "docs": "When `true` and the parent `calcite-list`'s `selectionMode` is `\"single\"` or `\"multiple\"`, the component is selected.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -13054,6 +13365,15 @@
         }
       ],
       "events": [
+        {
+          "event": "calciteListItemClose",
+          "detail": "void",
+          "bubbles": true,
+          "cancelable": false,
+          "composed": true,
+          "docs": "Fires when the close button is clicked.",
+          "docsTags": []
+        },
         {
           "event": "calciteListItemSelect",
           "detail": "void",
@@ -13095,10 +13415,16 @@
       "parts": [],
       "dependents": [],
       "dependencies": [
-        "calcite-icon"
+        "calcite-icon",
+        "calcite-action"
       ],
       "dependencyGraph": {
         "calcite-list-item": [
+          "calcite-icon",
+          "calcite-action"
+        ],
+        "calcite-action": [
+          "calcite-loader",
           "calcite-icon"
         ]
       }
@@ -14498,6 +14824,10 @@
           "name": "slot",
           "text": "- A slot for adding custom content."
         },
+        {
+          "name": "slot",
+          "text": "action-bar - A slot for adding a `calcite-action-bar` to the component."
+        },
         {
           "name": "slot",
           "text": "header-actions-start - A slot for adding actions or content to the start side of the header."
@@ -14764,6 +15094,10 @@
           "name": "",
           "docs": "A slot for adding custom content."
         },
+        {
+          "name": "action-bar",
+          "docs": "A slot for adding a `calcite-action-bar` to the component."
+        },
         {
           "name": "fab",
           "docs": "A slot for adding a `calcite-fab` (floating action button) to perform an action."
@@ -17884,6 +18218,28 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "layout",
+          "type": "\"horizontal\" | \"vertical\"",
+          "mutable": false,
+          "attr": "layout",
+          "reflectToAttr": true,
+          "docs": "The direction of the component.",
+          "docsTags": [],
+          "default": "\"vertical\"",
+          "values": [
+            {
+              "value": "horizontal",
+              "type": "string"
+            },
+            {
+              "value": "vertical",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "messageOverrides",
           "type": "{ resize?: string; }",
@@ -17973,11 +18329,26 @@
           "annotation": "prop",
           "docs": "The maximum height of the component when `detached` is true."
         },
+        {
+          "name": "--calcite-shell-panel-height",
+          "annotation": "prop",
+          "docs": "The height of the component."
+        },
+        {
+          "name": "--calcite-shell-panel-max-height",
+          "annotation": "prop",
+          "docs": "The maximum height of the component."
+        },
         {
           "name": "--calcite-shell-panel-max-width",
           "annotation": "prop",
           "docs": "The maximum width of the component."
         },
+        {
+          "name": "--calcite-shell-panel-min-height",
+          "annotation": "prop",
+          "docs": "The minimum height of the component."
+        },
         {
           "name": "--calcite-shell-panel-min-width",
           "annotation": "prop",
@@ -23417,6 +23788,15 @@
         }
       ],
       "events": [
+        {
+          "event": "calciteListItemChange",
+          "detail": "{ item: HTMLCalciteValueListItemElement; value: any; selected: boolean; shiftPressed: boolean; }",
+          "bubbles": true,
+          "cancelable": false,
+          "composed": true,
+          "docs": "Fires when the component is selected or unselected.",
+          "docsTags": []
+        },
         {
           "event": "calciteListItemRemove",
           "detail": "void",