@esri/calcite-components 2.6.0-next.2 → 2.6.0-next.3

package/dist/extras/docs-json.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2024-02-26T21:54:23",
+  "timestamp": "2024-02-27T18:15:07",
   "compiler": {
     "name": "@stencil/core",
     "version": "4.9.0",
@@ -4537,19 +4537,27 @@
       "docsTags": [
         {
           "name": "slot",
-          "text": "- A slot for adding subheader/description content."
+          "text": "- A slot for adding content."
+        },
+        {
+          "name": "slot",
+          "text": "title - [Deprecated] use `heading` instead. A slot for adding a heading."
+        },
+        {
+          "name": "slot",
+          "text": "subtitle - [Deprecated] use `description` instead. A slot for adding a description."
         },
         {
           "name": "slot",
-          "text": "thumbnail - A slot for adding a thumbnail to the component."
+          "text": "thumbnail - A slot for adding a thumbnail."
         },
         {
           "name": "slot",
-          "text": "title - A slot for adding a title."
+          "text": "heading - A slot for adding a heading."
         },
         {
           "name": "slot",
-          "text": "subtitle - A slot for adding a subtitle or short summary."
+          "text": "description - A slot for adding a description."
         },
         {
           "name": "slot",
@@ -4564,6 +4572,49 @@
         "Basic": "```html\n<div style=\"width:260px\">\n  <calcite-card>\n    <h3 slot=\"title\">ArcGIS Online: Gallery and Organization pages</h3>\n    <span slot=\"subtitle\">\n      A great example of a study description that might wrap to a line or two, but isn't overly verbose.\n    </span>\n  </calcite-card>\n</div>\n```\n"
       },
       "props": [
+        {
+          "name": "disabled",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "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",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "label",
+          "reflectToAttr": false,
+          "docs": "Accessible name for the component.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "loading",
           "type": "boolean",
@@ -4628,8 +4679,14 @@
           "attr": "selectable",
           "reflectToAttr": true,
           "docs": "When `true`, the component is selectable.",
-          "docsTags": [],
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "use `selectionMode` property on a parent `calcite-card-group` instead."
+            }
+          ],
           "default": "false",
+          "deprecation": "use `selectionMode` property on a parent `calcite-card-group` instead.",
           "values": [
             {
               "type": "boolean"
@@ -4702,7 +4759,30 @@
           "required": false
         }
       ],
-      "methods": [],
+      "methods": [
+        {
+          "name": "setFocus",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "() => Promise<void>",
+            "parameters": [],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              }
+            },
+            "return": "Promise<void>"
+          },
+          "signature": "setFocus() => Promise<void>",
+          "parameters": [],
+          "docs": "Sets focus on the component.",
+          "docsTags": []
+        }
+      ],
       "events": [
         {
           "event": "calciteCardSelect",
@@ -4715,16 +4795,81 @@
           },
           "cancelable": false,
           "composed": true,
-          "docs": "Fires when `selectable` is `true` and the component is selected.",
+          "docs": "Fires when the deprecated `selectable` is true, or `selectionMode` set on parent `calcite-card-group` is not `none` and the component is selected.",
           "docsTags": []
         }
       ],
       "listeners": [],
-      "styles": [],
+      "styles": [
+        {
+          "name": "--calcite-card-accent-color-selected",
+          "annotation": "prop",
+          "docs": "Specifies the accent color of the component when `selected`."
+        },
+        {
+          "name": "--calcite-card-background-color",
+          "annotation": "prop",
+          "docs": "Specifies the background color of the component."
+        },
+        {
+          "name": "--calcite-card-border-color",
+          "annotation": "prop",
+          "docs": "Specifies the border color of the component."
+        },
+        {
+          "name": "--calcite-card-corner-radius",
+          "annotation": "prop",
+          "docs": "Specifies the corner radius of the component."
+        },
+        {
+          "name": "--calcite-card-selection-background-color",
+          "annotation": "prop",
+          "docs": "Specifies the background color of the component's selection element."
+        },
+        {
+          "name": "--calcite-card-selection-background-color-active",
+          "annotation": "prop",
+          "docs": "Specifies the background color of the component's selection element when active."
+        },
+        {
+          "name": "--calcite-card-selection-background-color-hover",
+          "annotation": "prop",
+          "docs": "Specifies the background color of the component's selection element when hovered."
+        },
+        {
+          "name": "--calcite-card-selection-background-color-selected",
+          "annotation": "prop",
+          "docs": "Specifies the icon color of the component's selection element when `selected`."
+        },
+        {
+          "name": "--calcite-card-selection-icon-color",
+          "annotation": "prop",
+          "docs": "Specifies the icon color of the component's selection element."
+        },
+        {
+          "name": "--calcite-card-selection-icon-color-hover",
+          "annotation": "prop",
+          "docs": "Specifies the icon color of the component's selection element when hovered."
+        },
+        {
+          "name": "--calcite-card-selection-icon-color-selected",
+          "annotation": "prop",
+          "docs": "Specifies the icon color of the component's selection element when `selected`."
+        },
+        {
+          "name": "--calcite-card-shadow",
+          "annotation": "prop",
+          "docs": "Specifies the shadow of the component."
+        }
+      ],
       "slots": [
         {
           "name": "",
-          "docs": "A slot for adding subheader/description content."
+          "docs": "A slot for adding content."
+        },
+        {
+          "name": "description",
+          "docs": "A slot for adding a description."
         },
         {
           "name": "footer-end",
@@ -4734,34 +4879,283 @@
           "name": "footer-start",
           "docs": "A slot for adding a leading footer."
         },
+        {
+          "name": "heading",
+          "docs": "A slot for adding a heading."
+        },
         {
           "name": "subtitle",
-          "docs": "A slot for adding a subtitle or short summary."
+          "docs": "[Deprecated] use `description` instead. A slot for adding a description."
         },
         {
           "name": "thumbnail",
-          "docs": "A slot for adding a thumbnail to the component."
+          "docs": "A slot for adding a thumbnail."
         },
         {
           "name": "title",
-          "docs": "A slot for adding a title."
+          "docs": "[Deprecated] use `heading` instead. A slot for adding a heading."
         }
       ],
       "parts": [],
       "dependents": [],
       "dependencies": [
-        "calcite-loader",
         "calcite-label",
-        "calcite-checkbox"
+        "calcite-checkbox",
+        "calcite-icon",
+        "calcite-loader"
       ],
       "dependencyGraph": {
         "calcite-card": [
-          "calcite-loader",
           "calcite-label",
-          "calcite-checkbox"
+          "calcite-checkbox",
+          "calcite-icon",
+          "calcite-loader"
         ]
       }
     },
+    {
+      "filePath": "src/components/card-group/card-group.tsx",
+      "encapsulation": "shadow",
+      "tag": "calcite-card-group",
+      "readme": "# calcite-card-group\n",
+      "docs": "",
+      "docsTags": [
+        {
+          "name": "slot",
+          "text": "- A slot for adding one or more `calcite-card`s."
+        }
+      ],
+      "usage": {
+        "Basic": "```html\n<calcite-card-group label=\"Sports stadium layers\">\n  <calcite-card label=\"Baseball stadiums\">\n    <span slot=\"heading\">Baseball stadium layer</span>\n    <span slot=\"description\">This layer contains baseball stadiums</span>\n  </calcite-card>\n  <calcite-card label=\"Hockey stadiums\">\n    <span slot=\"heading\">Hockey stadium layer</span>\n    <span slot=\"description\">This layer contains hockey stadiums</span>\n  </calcite-card>\n  <calcite-card label=\"Football stadiums\">\n    <span slot=\"heading\">Football stadium layer</span>\n    <span slot=\"description\">This layer contains football stadiums</span>\n  </calcite-card>\n  <calcite-card label=\"Soccer stadiums\">\n    <span slot=\"heading\">Soccer stadium layer</span>\n    <span slot=\"description\">This layer contains soccer stadiums</span>\n  </calcite-card>\n</calcite-card-group>\n```\n",
+        "SelectionMode": "```html\n<calcite-card-group label=\"Sports stadium layers\" selection-mode=\"multiple\">\n  <calcite-card label=\"Baseball stadiums\">\n    <span slot=\"heading\">Baseball stadium layer</span>\n    <span slot=\"description\">This layer contains baseball stadiums</span>\n  </calcite-card>\n  <calcite-card label=\"Hockey stadiums\">\n    <span slot=\"heading\">Hockey stadium layer</span>\n    <span slot=\"description\">This layer contains hockey stadiums</span>\n  </calcite-card>\n  <calcite-card label=\"Football stadiums\">\n    <span slot=\"heading\">Football stadium layer</span>\n    <span slot=\"description\">This layer contains football stadiums</span>\n  </calcite-card>\n  <calcite-card label=\"Soccer stadiums\">\n    <span slot=\"heading\">Soccer stadium layer</span>\n    <span slot=\"description\">This layer contains soccer stadiums</span>\n  </calcite-card>\n</calcite-card-group>\n```\n"
+      },
+      "props": [
+        {
+          "name": "disabled",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "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",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
+          "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\"",
+          "complexType": {
+            "original": "Scale",
+            "resolved": "\"l\" | \"m\" | \"s\"",
+            "references": {
+              "Scale": {
+                "location": "import",
+                "path": "../interfaces",
+                "id": "src/components/interfaces.ts::Scale"
+              }
+            }
+          },
+          "mutable": false,
+          "attr": "scale",
+          "reflectToAttr": true,
+          "docs": "Specifies the size of the component. Child `calcite-card`s inherit the component's value.",
+          "docsTags": [],
+          "default": "\"m\"",
+          "values": [
+            {
+              "value": "l",
+              "type": "string"
+            },
+            {
+              "value": "m",
+              "type": "string"
+            },
+            {
+              "value": "s",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "selectedItems",
+          "type": "HTMLCalciteCardElement[]",
+          "complexType": {
+            "original": "HTMLCalciteCardElement[]",
+            "resolved": "HTMLCalciteCardElement[]",
+            "references": {
+              "HTMLCalciteCardElement": {
+                "location": "global",
+                "id": "global::HTMLCalciteCardElement"
+              }
+            }
+          },
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "Specifies the component's selected items.",
+          "docsTags": [
+            {
+              "name": "readonly"
+            }
+          ],
+          "default": "[]",
+          "values": [
+            {
+              "type": "HTMLCalciteCardElement[]"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "selectionMode",
+          "type": "\"multiple\" | \"none\" | \"single\" | \"single-persist\"",
+          "complexType": {
+            "original": "Extract<\n    \"multiple\" | \"single\" | \"single-persist\" | \"none\",\n    SelectionMode\n  >",
+            "resolved": "\"multiple\" | \"none\" | \"single\" | \"single-persist\"",
+            "references": {
+              "Extract": {
+                "location": "global",
+                "id": "global::Extract"
+              },
+              "SelectionMode": {
+                "location": "import",
+                "path": "../interfaces",
+                "id": "src/components/interfaces.ts::SelectionMode"
+              }
+            }
+          },
+          "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": ""
+          },
+          "complexType": {
+            "signature": "() => Promise<void>",
+            "parameters": [],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              }
+            },
+            "return": "Promise<void>"
+          },
+          "signature": "setFocus() => Promise<void>",
+          "parameters": [],
+          "docs": "Sets focus on the component's first focusable element.",
+          "docsTags": []
+        }
+      ],
+      "events": [
+        {
+          "event": "calciteCardGroupSelect",
+          "detail": "void",
+          "bubbles": true,
+          "complexType": {
+            "original": "void",
+            "resolved": "void",
+            "references": {}
+          },
+          "cancelable": false,
+          "composed": true,
+          "docs": "Emits when the component's selection changes and the `selectionMode` is not `none`.",
+          "docsTags": []
+        }
+      ],
+      "listeners": [
+        {
+          "event": "calciteInternalCardKeyEvent",
+          "capture": false,
+          "passive": false
+        },
+        {
+          "event": "calciteCardSelect",
+          "capture": false,
+          "passive": false
+        }
+      ],
+      "styles": [
+        {
+          "name": "--calcite-card-group-gap",
+          "annotation": "prop",
+          "docs": "Specifies the gap between slotted components."
+        }
+      ],
+      "slots": [
+        {
+          "name": "",
+          "docs": "A slot for adding one or more `calcite-card`s."
+        }
+      ],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    },
     {
       "filePath": "src/components/checkbox/checkbox.tsx",
       "encapsulation": "shadow",
@@ -5568,7 +5962,7 @@
       "filePath": "src/components/chip-group/chip-group.tsx",
       "encapsulation": "shadow",
       "tag": "calcite-chip-group",
-      "readme": "# calcite-tile-select-group\n",
+      "readme": "# calcite-chip-group\n",
       "docs": "",
       "docsTags": [
         {
@@ -12081,6 +12475,7 @@
         "calcite-block",
         "calcite-block-section",
         "calcite-button",
+        "calcite-card",
         "calcite-chip",
         "calcite-combobox",
         "calcite-combobox-item",
@@ -12139,6 +12534,9 @@
         "calcite-button": [
           "calcite-icon"
         ],
+        "calcite-card": [
+          "calcite-icon"
+        ],
         "calcite-chip": [
           "calcite-icon"
         ],
@@ -33861,8 +34259,14 @@
           "attr": "embed",
           "reflectToAttr": true,
           "docs": "The component's embed mode.\n\nWhen `true`, renders without a border and padding for use by other components.",
-          "docsTags": [],
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "No longer necessary."
+            }
+          ],
           "default": "false",
+          "deprecation": "No longer necessary.",
           "values": [
             {
               "type": "boolean"