@esri/calcite-components 1.0.0-next.294 → 1.0.0-next.298

package/dist/extras/docs-json.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2021-11-05T22:39:43",
+  "timestamp": "2021-11-10T22:22:24",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.10.0",
@@ -3276,19 +3276,18 @@
         },
         {
           "name": "name",
-          "type": "string",
+          "type": "any",
           "mutable": false,
           "attr": "name",
           "reflectToAttr": true,
           "docs": "The name of the checkbox input",
           "docsTags": [],
-          "default": "\"\"",
           "values": [
             {
-              "type": "string"
+              "type": "any"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false
         },
         {
@@ -3330,7 +3329,7 @@
               "type": "any"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false
         }
       ],
@@ -3358,18 +3357,7 @@
           "docsTags": []
         }
       ],
-      "listeners": [
-        {
-          "event": "mouseenter",
-          "capture": false,
-          "passive": true
-        },
-        {
-          "event": "mouseleave",
-          "capture": false,
-          "passive": true
-        }
-      ],
+      "listeners": [],
       "styles": [
         {
           "name": "--calcite-checkbox-size",
@@ -4773,6 +4761,22 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "name",
+          "type": "string",
+          "mutable": false,
+          "attr": "name",
+          "reflectToAttr": true,
+          "docs": "The name of the switch input",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "overlayPositioning",
           "type": "\"absolute\" | \"fixed\"",
@@ -4862,6 +4866,26 @@
           ],
           "optional": false,
           "required": false
+        },
+        {
+          "name": "value",
+          "type": "string | string[]",
+          "mutable": true,
+          "attr": "value",
+          "reflectToAttr": false,
+          "docs": "The value(s) of the selectedItem(s)",
+          "docsTags": [],
+          "default": "null",
+          "values": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "string[]"
+            }
+          ],
+          "optional": false,
+          "required": false
         }
       ],
       "methods": [
@@ -5280,7 +5304,13 @@
           "attr": "end",
           "reflectToAttr": false,
           "docs": "Selected end date",
-          "docsTags": [],
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "use value instead"
+            }
+          ],
+          "deprecation": "use value instead",
           "values": [
             {
               "type": "string"
@@ -5295,7 +5325,13 @@
           "mutable": true,
           "reflectToAttr": false,
           "docs": "Selected end date as full date object",
-          "docsTags": [],
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "use valueAsDate instead"
+            }
+          ],
+          "deprecation": "use valueAsDate instead",
           "values": [
             {
               "type": "Date"
@@ -5531,7 +5567,13 @@
           "attr": "start",
           "reflectToAttr": false,
           "docs": "Selected start date",
-          "docsTags": [],
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "use value instead"
+            }
+          ],
+          "deprecation": "use value instead",
           "values": [
             {
               "type": "string"
@@ -5546,7 +5588,13 @@
           "mutable": true,
           "reflectToAttr": false,
           "docs": "Selected start date as full date object",
-          "docsTags": [],
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "use valueAsDate instead"
+            }
+          ],
+          "deprecation": "use valueAsDate instead",
           "values": [
             {
               "type": "Date"
@@ -5557,7 +5605,7 @@
         },
         {
           "name": "value",
-          "type": "string",
+          "type": "string | string[]",
           "mutable": true,
           "attr": "value",
           "reflectToAttr": false,
@@ -5566,6 +5614,9 @@
           "values": [
             {
               "type": "string"
+            },
+            {
+              "type": "string[]"
             }
           ],
           "optional": true,
@@ -5573,7 +5624,7 @@
         },
         {
           "name": "valueAsDate",
-          "type": "Date",
+          "type": "Date | Date[]",
           "mutable": true,
           "reflectToAttr": false,
           "docs": "Selected date as full date object",
@@ -5581,6 +5632,9 @@
           "values": [
             {
               "type": "Date"
+            },
+            {
+              "type": "Date[]"
             }
           ],
           "optional": true,
@@ -7244,7 +7298,13 @@
           "mutable": false,
           "reflectToAttr": false,
           "docs": "The input data. The filter uses this as the starting point, and returns items\nthat contain the string entered in the input, using a partial match and recursive search.",
-          "docsTags": [],
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "use `items` instead."
+            }
+          ],
+          "deprecation": "use `items` instead.",
           "values": [
             {
               "type": "object[]"
@@ -7270,6 +7330,26 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "filteredItems",
+          "type": "object[]",
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "The resulting items after filtering.",
+          "docsTags": [
+            {
+              "name": "readonly"
+            }
+          ],
+          "default": "[]",
+          "values": [
+            {
+              "type": "object[]"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "intlClear",
           "type": "string",
@@ -7302,6 +7382,21 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "items",
+          "type": "object[]",
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "The items to filter through. The filter uses this as the starting point, and returns items\nthat contain the string entered in the input, using a partial match and recursive search.\n\nThis property is required.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "object[]"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "placeholder",
           "type": "string",
@@ -7902,7 +7997,7 @@
     },
     {
       "filePath": "./src/components/calcite-inline-editable/calcite-inline-editable.tsx",
-      "encapsulation": "scoped",
+      "encapsulation": "shadow",
       "tag": "calcite-inline-editable",
       "readme": "# calcite-inline-editable\n",
       "docs": "",
@@ -8138,7 +8233,7 @@
     },
     {
       "filePath": "./src/components/calcite-input/calcite-input.tsx",
-      "encapsulation": "scoped",
+      "encapsulation": "shadow",
       "tag": "calcite-input",
       "readme": "# calcite-input\n",
       "docs": "",
@@ -8246,6 +8341,23 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "hidden",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "hidden",
+          "reflectToAttr": false,
+          "docs": "when true, the component will not be visible",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "icon",
           "type": "boolean | string",
@@ -8453,7 +8565,7 @@
               "type": "string"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false
         },
         {
@@ -8727,7 +8839,7 @@
               "type": "string"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false
         }
       ],
@@ -8755,13 +8867,7 @@
           "docsTags": []
         }
       ],
-      "listeners": [
-        {
-          "event": "keydown",
-          "capture": false,
-          "passive": false
-        }
-      ],
+      "listeners": [],
       "styles": [],
       "slots": [
         {
@@ -8831,6 +8937,23 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "disabled",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "disabled",
+          "reflectToAttr": true,
+          "docs": "When false, the component won't be interactive.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "end",
           "type": "string",
@@ -8838,7 +8961,13 @@
           "attr": "end",
           "reflectToAttr": false,
           "docs": "Selected end date",
-          "docsTags": [],
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "use value instead"
+            }
+          ],
+          "deprecation": "use value instead",
           "values": [
             {
               "type": "string"
@@ -8853,7 +8982,13 @@
           "mutable": true,
           "reflectToAttr": false,
           "docs": "Selected end date as full date object",
-          "docsTags": [],
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "use valueAsDate instead"
+            }
+          ],
+          "deprecation": "use valueAsDate instead",
           "values": [
             {
               "type": "Date"
@@ -9044,6 +9179,22 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "name",
+          "type": "string",
+          "mutable": false,
+          "attr": "name",
+          "reflectToAttr": false,
+          "docs": "The picker's name. Gets submitted with the form.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "overlayPositioning",
           "type": "\"absolute\" | \"fixed\"",
@@ -9133,7 +9284,13 @@
           "attr": "start",
           "reflectToAttr": false,
           "docs": "Selected start date",
-          "docsTags": [],
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "use value instead"
+            }
+          ],
+          "deprecation": "use value instead",
           "values": [
             {
               "type": "string"
@@ -9148,7 +9305,13 @@
           "mutable": true,
           "reflectToAttr": false,
           "docs": "Selected start date as full date object",
-          "docsTags": [],
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "use valueAsDate instead"
+            }
+          ],
+          "deprecation": "use valueAsDate instead",
           "values": [
             {
               "type": "Date"
@@ -9159,7 +9322,7 @@
         },
         {
           "name": "value",
-          "type": "string",
+          "type": "string | string[]",
           "mutable": true,
           "attr": "value",
           "reflectToAttr": false,
@@ -9168,14 +9331,17 @@
           "values": [
             {
               "type": "string"
+            },
+            {
+              "type": "string[]"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false
         },
         {
           "name": "valueAsDate",
-          "type": "Date",
+          "type": "Date | Date[]",
           "mutable": true,
           "reflectToAttr": false,
           "docs": "Selected date as full date object",
@@ -9183,6 +9349,9 @@
           "values": [
             {
               "type": "Date"
+            },
+            {
+              "type": "Date[]"
             }
           ],
           "optional": true,
@@ -9703,7 +9872,7 @@
               "type": "string"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false
         },
         {
@@ -13563,7 +13732,7 @@
     },
     {
       "filePath": "./src/components/calcite-radio-button/calcite-radio-button.tsx",
-      "encapsulation": "scoped",
+      "encapsulation": "shadow",
       "tag": "calcite-radio-button",
       "readme": "# calcite-radio-button\n",
       "docs": "",
@@ -13701,7 +13870,7 @@
         {
           "name": "value",
           "type": "any",
-          "mutable": false,
+          "mutable": true,
           "attr": "value",
           "reflectToAttr": false,
           "docs": "The value of the radio button.",
@@ -14071,6 +14240,23 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "value",
+          "type": "string",
+          "mutable": true,
+          "attr": "value",
+          "reflectToAttr": false,
+          "docs": "The value of the selectedItem",
+          "docsTags": [],
+          "default": "null",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "width",
           "type": "\"auto\" | \"full\"",
@@ -14360,6 +14546,22 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "name",
+          "type": "string",
+          "mutable": false,
+          "attr": "name",
+          "reflectToAttr": true,
+          "docs": "The name of the rating",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "readOnly",
           "type": "boolean",
@@ -14650,6 +14852,22 @@
           "optional": false,
           "required": true
         },
+        {
+          "name": "name",
+          "type": "string",
+          "mutable": false,
+          "attr": "name",
+          "reflectToAttr": false,
+          "docs": "The select's name. Gets submitted with the form.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "scale",
           "type": "\"l\" | \"m\" | \"s\"",
@@ -14695,6 +14913,23 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "value",
+          "type": "string",
+          "mutable": true,
+          "attr": "value",
+          "reflectToAttr": false,
+          "docs": "The value of the selectedOption",
+          "docsTags": [],
+          "default": "null",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "width",
           "type": "\"auto\" | \"full\" | \"half\"",
@@ -15374,6 +15609,22 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "name",
+          "type": "string",
+          "mutable": false,
+          "attr": "name",
+          "reflectToAttr": true,
+          "docs": "The name of the slider",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "pageStep",
           "type": "number",
@@ -15407,6 +15658,23 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "required",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "required",
+          "reflectToAttr": true,
+          "docs": "When true, makes the component required for form-submission.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "snap",
           "type": "boolean",
@@ -16464,7 +16732,7 @@
               "type": "string"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false
         },
         {
@@ -16521,7 +16789,7 @@
           "type": "any",
           "mutable": false,
           "attr": "value",
-          "reflectToAttr": true,
+          "reflectToAttr": false,
           "docs": "The value of the switch input",
           "docsTags": [],
           "values": [
@@ -16529,7 +16797,7 @@
               "type": "any"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false
         }
       ],
@@ -16557,13 +16825,7 @@
           "docsTags": []
         }
       ],
-      "listeners": [
-        {
-          "event": "keydown",
-          "capture": false,
-          "passive": false
-        }
-      ],
+      "listeners": [],
       "styles": [],
       "slots": [],
       "parts": [],
@@ -17478,16 +17740,15 @@
         },
         {
           "name": "name",
-          "type": "string",
+          "type": "any",
           "mutable": false,
           "attr": "name",
           "reflectToAttr": true,
           "docs": "The name of the tile select.  This name will appear in form submissions as either a radio or checkbox identifier based on the `type` property.",
           "docsTags": [],
-          "default": "\"\"",
           "values": [
             {
-              "type": "string"
+              "type": "any"
             }
           ],
           "optional": false,