@esri/calcite-components 1.9.0-next.9 → 1.9.0

package/dist/extras/docs-json.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2023-09-26T21:37:28",
+  "timestamp": "2023-10-03T04:41:26",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.22.3",
@@ -8372,6 +8372,40 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "collapsed",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "collapsed",
+          "reflectToAttr": true,
+          "docs": "When `true`, hides the component's content area.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "collapsible",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "collapsible",
+          "reflectToAttr": true,
+          "docs": "When `true`, the component is collapsible.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "description",
           "type": "string",
@@ -8513,7 +8547,7 @@
           "name": "scrollContentTo",
           "returns": {
             "type": "Promise<void>",
-            "docs": ""
+            "docs": "- promise that resolves once the content is scrolled to."
           },
           "signature": "scrollContentTo(options?: ScrollToOptions) => Promise<void>",
           "parameters": [],
@@ -8525,7 +8559,11 @@
             },
             {
               "name": "param",
-              "text": "options"
+              "text": "options - allows specific coordinates to be defined."
+            },
+            {
+              "name": "returns",
+              "text": "- promise that resolves once the content is scrolled to."
             }
           ]
         },
@@ -8533,12 +8571,17 @@
           "name": "setFocus",
           "returns": {
             "type": "Promise<void>",
-            "docs": ""
+            "docs": "promise."
           },
           "signature": "setFocus() => Promise<void>",
           "parameters": [],
           "docs": "Sets focus on the component.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "returns",
+              "text": "promise."
+            }
+          ]
         }
       ],
       "events": [
@@ -8568,6 +8611,15 @@
           "composed": true,
           "docs": "Fires when the content is scrolled.",
           "docsTags": []
+        },
+        {
+          "event": "calciteFlowItemToggle",
+          "detail": "void",
+          "bubbles": true,
+          "cancelable": false,
+          "composed": true,
+          "docs": "Fires when the collapse button is clicked.",
+          "docsTags": []
         }
       ],
       "listeners": [],
@@ -8576,6 +8628,11 @@
           "name": "--calcite-flow-item-footer-padding",
           "annotation": "prop",
           "docs": "Specifies the padding of the component's footer."
+        },
+        {
+          "name": "--calcite-flow-item-header-border-block-end",
+          "annotation": "prop",
+          "docs": "Specifies the component header's block end border."
         }
       ],
       "slots": [
@@ -10797,6 +10854,32 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "status",
+          "type": "\"idle\" | \"invalid\" | \"valid\"",
+          "mutable": false,
+          "attr": "status",
+          "reflectToAttr": true,
+          "docs": "Specifies the status of the input field, which determines message and icons.",
+          "docsTags": [],
+          "default": "\"idle\"",
+          "values": [
+            {
+              "value": "idle",
+              "type": "string"
+            },
+            {
+              "value": "invalid",
+              "type": "string"
+            },
+            {
+              "value": "valid",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "value",
           "type": "string | string[]",
@@ -12885,6 +12968,32 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "status",
+          "type": "\"idle\" | \"invalid\" | \"valid\"",
+          "mutable": false,
+          "attr": "status",
+          "reflectToAttr": true,
+          "docs": "Specifies the status of the input field, which determines message and icons.",
+          "docsTags": [],
+          "default": "\"idle\"",
+          "values": [
+            {
+              "value": "idle",
+              "type": "string"
+            },
+            {
+              "value": "invalid",
+              "type": "string"
+            },
+            {
+              "value": "valid",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "step",
           "type": "number",
@@ -13039,7 +13148,8 @@
       "docs": "",
       "docsTags": [],
       "usage": {
-        "Basic": "```html\n<calcite-input-time-zone value=\"-360\"></calcite-input-time-zone>\n```\n"
+        "Basic": "Displays options to select a time zone offset (in minutes).\n\n```html\n<calcite-input-time-zone value=\"-360\"></calcite-input-time-zone>\n```\n",
+        "TimeZoneNames": "Displays options to select a IANA time zone name.\n\n```html\n<calcite-input-time-zone mode=\"name\" value=\"America/Ciudad_Juarez\"></calcite-input-time-zone>\n```\n"
       },
       "props": [
         {
@@ -13107,6 +13217,33 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "mode",
+          "type": "\"name\" | \"offset\"",
+          "mutable": false,
+          "attr": "mode",
+          "reflectToAttr": true,
+          "docs": "This specifies the type of `value` and the associated options presented to the user:\n\nUsing `\"offset\"` will provide options related",
+          "docsTags": [
+            {
+              "name": "default",
+              "text": "\"offset\""
+            }
+          ],
+          "default": "\"offset\"",
+          "values": [
+            {
+              "value": "name",
+              "type": "string"
+            },
+            {
+              "value": "offset",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "name",
           "type": "string",
@@ -13162,6 +13299,30 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "referenceDate",
+          "type": "Date | string",
+          "mutable": false,
+          "attr": "reference-date",
+          "reflectToAttr": false,
+          "docs": "This date will be used as a reference to Daylight Savings Time when creating time zone item groups.\n\nIt can be either a Date instance or a string in ISO format (YYYY-MM-DD, YYYY-MM-DDTHH:MM:SS.SSSZ)",
+          "docsTags": [
+            {
+              "name": "see",
+              "text": "[Date.prototype.toISOString](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)"
+            }
+          ],
+          "values": [
+            {
+              "type": "Date"
+            },
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "scale",
           "type": "\"l\" | \"m\" | \"s\"",
@@ -17187,6 +17348,7 @@
       "usage": {
         "Basic": "Renders a basic panel with a header.\n\n```html\n<calcite-panel>\n  <div slot=\"header-content\">Header!</div>\n  <p>Slotted content!</p>\n</calcite-panel>\n```\n",
         "Closable": "Renders a panel that is closable with a click of the \"x\".\n\n```html\n<calcite-panel closable id=\"closable-panel\">\n  <div slot=\"header-content\">Closable Header</div>\n  <p>Click the X and I go away!</p>\n</calcite-panel>\n```\n",
+        "Collapsible": "Renders a panel that is collapsible with a click of the chevron.\n\n```html\n<calcite-panel collapsible id=\"collapsible-panel\">\n  <div slot=\"header-content\">Collapsible Header</div>\n  <p>Click the chevron and I go away!</p>\n</calcite-panel>\n```\n",
         "Header-with-actions": "Renders a panel with leading and trailing `calcite-action`s.\n\n```html\n<calcite-panel>\n  <calcite-action\n    label=\"Performs my custom action\"\n    text=\"Perform Action!\"\n    text-enabled\n    icon=\"home\"\n    slot=\"header-actions-start\"\n  ></calcite-action>\n  <div slot=\"header-content\">Header!</div>\n  <calcite-action\n    label=\"Performs another custom action\"\n    text=\"Perform Another Action!\"\n    text-enabled\n    icon=\"blog\"\n    slot=\"header-actions-end\"\n  ></calcite-action>\n  <p>Actions are in the top left and right.</p>\n</calcite-panel>\n```\n",
         "With-footer": "Renders a panel with a header and a footer.\n\n```html\n<calcite-panel>\n  <div slot=\"header-content\">Header!</div>\n  <p>I have a footer.</p>\n  <div slot=\"footer\">Footer!</div>\n</calcite-panel>\n```\n"
       },
@@ -17225,6 +17387,40 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "collapsed",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "collapsed",
+          "reflectToAttr": true,
+          "docs": "When `true`, hides the component's content area.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "collapsible",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "collapsible",
+          "reflectToAttr": true,
+          "docs": "When `true`, the component is collapsible.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "description",
           "type": "string",
@@ -17347,14 +17543,14 @@
         },
         {
           "name": "messageOverrides",
-          "type": "{ close?: string; options?: string; }",
+          "type": "{ close?: string; options?: string; collapse?: string; expand?: string; }",
           "mutable": true,
           "reflectToAttr": false,
           "docs": "Use this property to override individual strings used by the component.",
           "docsTags": [],
           "values": [
             {
-              "type": "{ close?: string; options?: string; }"
+              "type": "{ close?: string; options?: string; collapse?: string; expand?: string; }"
             }
           ],
           "optional": false,
@@ -17366,7 +17562,7 @@
           "name": "scrollContentTo",
           "returns": {
             "type": "Promise<void>",
-            "docs": ""
+            "docs": "- promise that resolves once the content is scrolled to."
           },
           "signature": "scrollContentTo(options?: ScrollToOptions) => Promise<void>",
           "parameters": [],
@@ -17378,7 +17574,11 @@
             },
             {
               "name": "param",
-              "text": "options"
+              "text": "options - allows specific coordinates to be defined."
+            },
+            {
+              "name": "returns",
+              "text": "- promise that resolves once the content is scrolled to."
             }
           ]
         },
@@ -17412,6 +17612,15 @@
           "composed": true,
           "docs": "Fires when the content is scrolled.",
           "docsTags": []
+        },
+        {
+          "event": "calcitePanelToggle",
+          "detail": "void",
+          "bubbles": true,
+          "cancelable": false,
+          "composed": true,
+          "docs": "Fires when the collapse button is clicked.",
+          "docsTags": []
         }
       ],
       "listeners": [],
@@ -17420,6 +17629,11 @@
           "name": "--calcite-panel-footer-padding",
           "annotation": "prop",
           "docs": "Specifies the padding of the component's footer."
+        },
+        {
+          "name": "--calcite-panel-header-border-block-end",
+          "annotation": "prop",
+          "docs": "Specifies the component header's block end border."
         }
       ],
       "slots": [
@@ -22296,6 +22510,7 @@
       "filePath": "./src/components/stack/stack.tsx",
       "encapsulation": "shadow",
       "tag": "calcite-stack",
+      "readme": "# calcite-stack\n",
       "docs": "",
       "docsTags": [
         {