npm - @esri/calcite-components - Versions diffs - 1.0.0-next.661 → 1.0.0-next.663 - Mend

@esri/calcite-components 1.0.0-next.661 → 1.0.0-next.663

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (673) hide show

package/dist/extras/docs-json.json CHANGED Viewed

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2022-12-08T02:04:41",
+  "timestamp": "2022-12-08T21:04:17",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.20.0",
@@ -456,7 +456,7 @@
           "mutable": false,
           "attr": "indicator",
           "reflectToAttr": true,
-          "docs": "When `true`, indicates unread changes.",
+          "docs": "When `true`, displays a visual indicator.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -473,11 +473,11 @@
           "mutable": false,
           "attr": "intl-indicator",
           "reflectToAttr": false,
-          "docs": "Specifies the text label to display `indicator` is `true`.",
+          "docs": "When `indicator` is `true`, specifies the accessible context of the `indicator`.",
           "docsTags": [
             {
               "name": "default",
-              "text": "\"Unread changes\""
+              "text": "\"Indicator present\""
             }
           ],
           "default": "TEXT.indicator",
@@ -1275,27 +1275,97 @@
         },
         {
           "name": "placement",
-          "type": "Placement | VariationPlacement | AutoPlacement",
+          "type": "\"auto\" | \"top\" | \"right\" | \"bottom\" | \"left\" | \"top-start\" | \"top-end\" | \"right-start\" | \"right-end\" | \"bottom-start\" | \"bottom-end\" | \"left-start\" | \"left-end\" | \"auto-start\" | \"auto-end\" | \"leading-start\" | \"leading\" | \"leading-end\" | \"trailing-end\" | \"trailing\" | \"trailing-start\"",
           "mutable": false,
           "attr": "placement",
           "reflectToAttr": true,
           "docs": "Determines where the component will be positioned relative to the `referenceElement`.",
-          "docsTags": [
-            {
-              "name": "see",
-              "text": "[LogicalPlacement](https://github.com/Esri/calcite-components/blob/master/src/utils/floating-ui.ts#L25)"
-            }
-          ],
+          "docsTags": [],
           "default": "\"auto\"",
           "values": [
             {
-              "type": "Placement"
+              "value": "auto",
+              "type": "string"
+            },
+            {
+              "value": "top",
+              "type": "string"
+            },
+            {
+              "value": "right",
+              "type": "string"
+            },
+            {
+              "value": "bottom",
+              "type": "string"
+            },
+            {
+              "value": "left",
+              "type": "string"
+            },
+            {
+              "value": "top-start",
+              "type": "string"
+            },
+            {
+              "value": "top-end",
+              "type": "string"
             },
             {
-              "type": "VariationPlacement"
+              "value": "right-start",
+              "type": "string"
+            },
+            {
+              "value": "right-end",
+              "type": "string"
+            },
+            {
+              "value": "bottom-start",
+              "type": "string"
             },
             {
-              "type": "AutoPlacement"
+              "value": "bottom-end",
+              "type": "string"
+            },
+            {
+              "value": "left-start",
+              "type": "string"
+            },
+            {
+              "value": "left-end",
+              "type": "string"
+            },
+            {
+              "value": "auto-start",
+              "type": "string"
+            },
+            {
+              "value": "auto-end",
+              "type": "string"
+            },
+            {
+              "value": "leading-start",
+              "type": "string"
+            },
+            {
+              "value": "leading",
+              "type": "string"
+            },
+            {
+              "value": "leading-end",
+              "type": "string"
+            },
+            {
+              "value": "trailing-end",
+              "type": "string"
+            },
+            {
+              "value": "trailing",
+              "type": "string"
+            },
+            {
+              "value": "trailing-start",
+              "type": "string"
             }
           ],
           "optional": false,
@@ -9022,11 +9092,11 @@
       "events": [
         {
           "event": "calciteHandleNudge",
-          "detail": "any",
+          "detail": "HandleNudge",
           "bubbles": true,
           "cancelable": false,
           "composed": true,
-          "docs": "Emitted when the handle is activated and the up or down arrow key is pressed.\n\n**Note:**: The `handle` event payload prop is deprecated, please use the event's `target`/`currentTarget` instead",
+          "docs": "Emitted when the handle is activated and the up or down arrow key is pressed.",
           "docsTags": []
         }
       ],
@@ -9846,32 +9916,6 @@
           "optional": false,
           "required": false
         },
-        {
-          "name": "locale",
-          "type": "string",
-          "mutable": false,
-          "attr": "locale",
-          "reflectToAttr": false,
-          "docs": "BCP 47 language tag for desired language and country format",
-          "docsTags": [
-            {
-              "name": "deprecated",
-              "text": "set the global `lang` attribute on the element instead."
-            },
-            {
-              "name": "mdn",
-              "text": "[lang](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang)"
-            }
-          ],
-          "deprecation": "set the global `lang` attribute on the element instead.",
-          "values": [
-            {
-              "type": "string"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
         {
           "name": "max",
           "type": "number",
@@ -9914,28 +9958,6 @@
           "optional": false,
           "required": false
         },
-        {
-          "name": "maxlength",
-          "type": "number",
-          "mutable": false,
-          "attr": "maxlength",
-          "reflectToAttr": true,
-          "docs": "Specifies the maximum length of text for the component's value.",
-          "docsTags": [
-            {
-              "name": "deprecated",
-              "text": "use `maxLength` instead."
-            }
-          ],
-          "deprecation": "use `maxLength` instead.",
-          "values": [
-            {
-              "type": "number"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
         {
           "name": "min",
           "type": "number",
@@ -10474,7 +10496,7 @@
           "bubbles": true,
           "cancelable": true,
           "composed": true,
-          "docs": "Fires each time a new `value` is typed.\n\n**Note:**: The `el` and `value` event payload properties are deprecated, use the event's `target`/`currentTarget` instead.",
+          "docs": "Fires each time a new `value` is typed.\nNOTE: `nativeEvent` payload property is deprecated",
           "docsTags": []
         }
       ],
@@ -13225,27 +13247,97 @@
         },
         {
           "name": "placement",
-          "type": "Placement | VariationPlacement | AutoPlacement",
+          "type": "\"auto\" | \"top\" | \"right\" | \"bottom\" | \"left\" | \"top-start\" | \"top-end\" | \"right-start\" | \"right-end\" | \"bottom-start\" | \"bottom-end\" | \"left-start\" | \"left-end\" | \"auto-start\" | \"auto-end\" | \"leading-start\" | \"leading\" | \"leading-end\" | \"trailing-end\" | \"trailing\" | \"trailing-start\"",
           "mutable": false,
           "attr": "placement",
           "reflectToAttr": true,
           "docs": "Determines where the popover will be positioned relative to the input.",
-          "docsTags": [
-            {
-              "name": "see",
-              "text": "[LogicalPlacement](https://github.com/Esri/calcite-components/blob/master/src/utils/floating-ui.ts#L25)"
-            }
-          ],
+          "docsTags": [],
           "default": "\"auto\"",
           "values": [
             {
-              "type": "Placement"
+              "value": "auto",
+              "type": "string"
+            },
+            {
+              "value": "top",
+              "type": "string"
+            },
+            {
+              "value": "right",
+              "type": "string"
+            },
+            {
+              "value": "bottom",
+              "type": "string"
+            },
+            {
+              "value": "left",
+              "type": "string"
+            },
+            {
+              "value": "top-start",
+              "type": "string"
+            },
+            {
+              "value": "top-end",
+              "type": "string"
+            },
+            {
+              "value": "right-start",
+              "type": "string"
+            },
+            {
+              "value": "right-end",
+              "type": "string"
             },
             {
-              "type": "VariationPlacement"
+              "value": "bottom-start",
+              "type": "string"
             },
             {
-              "type": "AutoPlacement"
+              "value": "bottom-end",
+              "type": "string"
+            },
+            {
+              "value": "left-start",
+              "type": "string"
+            },
+            {
+              "value": "left-end",
+              "type": "string"
+            },
+            {
+              "value": "auto-start",
+              "type": "string"
+            },
+            {
+              "value": "auto-end",
+              "type": "string"
+            },
+            {
+              "value": "leading-start",
+              "type": "string"
+            },
+            {
+              "value": "leading",
+              "type": "string"
+            },
+            {
+              "value": "leading-end",
+              "type": "string"
+            },
+            {
+              "value": "trailing-end",
+              "type": "string"
+            },
+            {
+              "value": "trailing",
+              "type": "string"
+            },
+            {
+              "value": "trailing-start",
+              "type": "string"
             }
           ],
           "optional": false,
@@ -17234,27 +17326,97 @@
         },
         {
           "name": "placement",
-          "type": "Placement | VariationPlacement | AutoPlacement",
+          "type": "\"auto\" | \"top\" | \"right\" | \"bottom\" | \"left\" | \"top-start\" | \"top-end\" | \"right-start\" | \"right-end\" | \"bottom-start\" | \"bottom-end\" | \"left-start\" | \"left-end\" | \"auto-start\" | \"auto-end\" | \"leading-start\" | \"leading\" | \"leading-end\" | \"trailing-end\" | \"trailing\" | \"trailing-start\"",
           "mutable": false,
           "attr": "placement",
           "reflectToAttr": true,
           "docs": "Determines where the component will be positioned relative to the `referenceElement`.",
-          "docsTags": [
-            {
-              "name": "see",
-              "text": "[LogicalPlacement](https://github.com/Esri/calcite-components/blob/master/src/utils/floating-ui.ts#L25)"
-            }
-          ],
+          "docsTags": [],
           "default": "defaultPopoverPlacement",
           "values": [
             {
-              "type": "Placement"
+              "value": "auto",
+              "type": "string"
+            },
+            {
+              "value": "top",
+              "type": "string"
             },
             {
-              "type": "VariationPlacement"
+              "value": "right",
+              "type": "string"
             },
             {
-              "type": "AutoPlacement"
+              "value": "bottom",
+              "type": "string"
+            },
+            {
+              "value": "left",
+              "type": "string"
+            },
+            {
+              "value": "top-start",
+              "type": "string"
+            },
+            {
+              "value": "top-end",
+              "type": "string"
+            },
+            {
+              "value": "right-start",
+              "type": "string"
+            },
+            {
+              "value": "right-end",
+              "type": "string"
+            },
+            {
+              "value": "bottom-start",
+              "type": "string"
+            },
+            {
+              "value": "bottom-end",
+              "type": "string"
+            },
+            {
+              "value": "left-start",
+              "type": "string"
+            },
+            {
+              "value": "left-end",
+              "type": "string"
+            },
+            {
+              "value": "auto-start",
+              "type": "string"
+            },
+            {
+              "value": "auto-end",
+              "type": "string"
+            },
+            {
+              "value": "leading-start",
+              "type": "string"
+            },
+            {
+              "value": "leading",
+              "type": "string"
+            },
+            {
+              "value": "leading-end",
+              "type": "string"
+            },
+            {
+              "value": "trailing-end",
+              "type": "string"
+            },
+            {
+              "value": "trailing",
+              "type": "string"
+            },
+            {
+              "value": "trailing-start",
+              "type": "string"
             }
           ],
           "optional": false,
@@ -20912,29 +21074,6 @@
           "optional": false,
           "required": false
         },
-        {
-          "name": "switched",
-          "type": "boolean",
-          "mutable": true,
-          "attr": "switched",
-          "reflectToAttr": true,
-          "docs": "When `true`, the component is checked.",
-          "docsTags": [
-            {
-              "name": "deprecated",
-              "text": "use `checked` instead."
-            }
-          ],
-          "default": "false",
-          "deprecation": "use `checked` instead.",
-          "values": [
-            {
-              "type": "boolean"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
         {
           "name": "value",
           "type": "any",
@@ -20968,7 +21107,7 @@
       "events": [
         {
           "event": "calciteSwitchChange",
-          "detail": "any",
+          "detail": "void",
           "bubbles": true,
           "cancelable": false,
           "composed": true,
@@ -21006,29 +21145,6 @@
         "Basic": "`calcite-tab` wraps the content you would like to appear when that tab is selected:\n\n```html\n<calcite-tab>My stuff!</calcite-tab>\n```\n"
       },
       "props": [
-        {
-          "name": "active",
-          "type": "boolean",
-          "mutable": true,
-          "attr": "active",
-          "reflectToAttr": true,
-          "docs": "When `true`, the component's contents are selected.\n\nOnly one tab can be selected within the `calcite-tabs` parent.",
-          "docsTags": [
-            {
-              "name": "deprecated",
-              "text": "Use `selected` instead."
-            }
-          ],
-          "default": "false",
-          "deprecation": "Use `selected` instead.",
-          "values": [
-            {
-              "type": "boolean"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
         {
           "name": "selected",
           "type": "boolean",
@@ -21116,7 +21232,7 @@
         }
       ],
       "usage": {
-        "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=\"below\">\n  <calcite-tab-title>Layers</calcite-tab-title>\n  <calcite-tab-title>Maps</calcite-tab-title>\n  <calcite-tab-title active>Data</calcite-tab-title>\n</calcite-tab-nav>\n```\n"
+        "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": [
         {
@@ -21249,29 +21365,6 @@
       ],
       "usage": {},
       "props": [
-        {
-          "name": "active",
-          "type": "boolean",
-          "mutable": true,
-          "attr": "active",
-          "reflectToAttr": true,
-          "docs": "When `true`, the component and its respective `calcite-tab` contents are selected.\n\nOnly one tab can be selected within the `calcite-tabs` parent.",
-          "docsTags": [
-            {
-              "name": "deprecated",
-              "text": "Use `selected` instead."
-            }
-          ],
-          "default": "false",
-          "deprecation": "Use `selected` instead.",
-          "values": [
-            {
-              "type": "boolean"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
         {
           "name": "disabled",
           "type": "boolean",
@@ -21467,8 +21560,8 @@
         }
       ],
       "usage": {
-        "Basic": "`calcite-tabs` uses several sub-components ([calcite-tab-nav](../tab-nav), [calcite-tab](../tab), [calcite-tab-title](../tab-title)) to create a tabbed interface with optional client side storage. Place your content inside of the `<calcite-tab>` element:\n\n```html\n<calcite-tabs>\n  <calcite-tab-nav slot=\"tab-nav\">\n    <calcite-tab-title active>Tab 1 Title</calcite-tab-title>\n    <calcite-tab-title>Tab 2 Title</calcite-tab-title>\n  </calcite-tab-nav>\n\n  <calcite-tab active>Tab 1 Content</calcite-tab>\n  <calcite-tab>Tab 2 Content</calcite-tab>\n</calcite-tabs>\n```\n",
-        "Bordered": "```html\n<calcite-tabs bordered>\n  <calcite-tab-nav slot=\"tab-nav\">\n    <calcite-tab-title tab=\"tab1\">Tab 1 Title</calcite-tab-title>\n    <calcite-tab-title tab=\"tab2\">Tab 2 Title</calcite-tab-title>\n    <calcite-tab-title tab=\"tab3\">Tab 3 Title</calcite-tab-title>\n    <calcite-tab-title tab=\"tab4\" active>Tab 4 Title</calcite-tab-title>\n  </calcite-tab-nav>\n  <calcite-tab tab=\"tab1\">Tab 1 Content</calcite-tab>\n  <calcite-tab tab=\"tab2\">Tab 2 Content</calcite-tab>\n  <calcite-tab tab=\"tab3\">Tab 3 Content</calcite-tab>\n  <calcite-tab tab=\"tab4\" active>Tab 4 Content</calcite-tab>\n</calcite-tabs>\n```\n"
+        "Basic": "`calcite-tabs` uses several sub-components ([calcite-tab-nav](../tab-nav), [calcite-tab](../tab), [calcite-tab-title](../tab-title)) to create a tabbed interface with optional client side storage. Place your content inside of the `<calcite-tab>` element:\n\n```html\n<calcite-tabs>\n  <calcite-tab-nav slot=\"tab-nav\">\n    <calcite-tab-title selected>Tab 1 Title</calcite-tab-title>\n    <calcite-tab-title>Tab 2 Title</calcite-tab-title>\n  </calcite-tab-nav>\n\n  <calcite-tab selected>Tab 1 Content</calcite-tab>\n  <calcite-tab>Tab 2 Content</calcite-tab>\n</calcite-tabs>\n```\n",
+        "Bordered": "```html\n<calcite-tabs bordered>\n  <calcite-tab-nav slot=\"tab-nav\">\n    <calcite-tab-title tab=\"tab1\">Tab 1 Title</calcite-tab-title>\n    <calcite-tab-title tab=\"tab2\">Tab 2 Title</calcite-tab-title>\n    <calcite-tab-title tab=\"tab3\">Tab 3 Title</calcite-tab-title>\n    <calcite-tab-title tab=\"tab4\" selected>Tab 4 Title</calcite-tab-title>\n  </calcite-tab-nav>\n  <calcite-tab tab=\"tab1\">Tab 1 Content</calcite-tab>\n  <calcite-tab tab=\"tab2\">Tab 2 Content</calcite-tab>\n  <calcite-tab tab=\"tab3\">Tab 3 Content</calcite-tab>\n  <calcite-tab tab=\"tab4\" selected>Tab 4 Content</calcite-tab>\n</calcite-tabs>\n```\n"
       },
       "props": [
         {
@@ -21512,22 +21605,14 @@
         },
         {
           "name": "position",
-          "type": "\"above\" | \"below\" | \"bottom\" | \"top\"",
+          "type": "\"bottom\" | \"top\"",
           "mutable": false,
           "attr": "position",
           "reflectToAttr": true,
-          "docs": "Specifies the position of the component in relation to the `calcite-tab`s. The `\"above\"` and `\"below\"` values are deprecated.",
+          "docs": "Specifies the position of the component in relation to the `calcite-tab`s.",
           "docsTags": [],
           "default": "\"top\"",
           "values": [
-            {
-              "value": "above",
-              "type": "string"
-            },
-            {
-              "value": "below",
-              "type": "string"
-            },
             {
               "value": "bottom",
               "type": "string"
@@ -23271,27 +23356,97 @@
         },
         {
           "name": "placement",
-          "type": "Placement | VariationPlacement | AutoPlacement",
+          "type": "\"auto\" | \"top\" | \"right\" | \"bottom\" | \"left\" | \"top-start\" | \"top-end\" | \"right-start\" | \"right-end\" | \"bottom-start\" | \"bottom-end\" | \"left-start\" | \"left-end\" | \"auto-start\" | \"auto-end\" | \"leading-start\" | \"leading\" | \"leading-end\" | \"trailing-end\" | \"trailing\" | \"trailing-start\"",
           "mutable": false,
           "attr": "placement",
           "reflectToAttr": true,
           "docs": "Determines where the component will be positioned relative to the `referenceElement`.",
-          "docsTags": [
-            {
-              "name": "see",
-              "text": "[LogicalPlacement](https://github.com/Esri/calcite-components/blob/master/src/utils/floating-ui.ts#L25)"
-            }
-          ],
+          "docsTags": [],
           "default": "\"auto\"",
           "values": [
             {
-              "type": "Placement"
+              "value": "auto",
+              "type": "string"
+            },
+            {
+              "value": "top",
+              "type": "string"
+            },
+            {
+              "value": "right",
+              "type": "string"
+            },
+            {
+              "value": "bottom",
+              "type": "string"
+            },
+            {
+              "value": "left",
+              "type": "string"
             },
             {
-              "type": "VariationPlacement"
+              "value": "top-start",
+              "type": "string"
+            },
+            {
+              "value": "top-end",
+              "type": "string"
+            },
+            {
+              "value": "right-start",
+              "type": "string"
+            },
+            {
+              "value": "right-end",
+              "type": "string"
             },
             {
-              "type": "AutoPlacement"
+              "value": "bottom-start",
+              "type": "string"
+            },
+            {
+              "value": "bottom-end",
+              "type": "string"
+            },
+            {
+              "value": "left-start",
+              "type": "string"
+            },
+            {
+              "value": "left-end",
+              "type": "string"
+            },
+            {
+              "value": "auto-start",
+              "type": "string"
+            },
+            {
+              "value": "auto-end",
+              "type": "string"
+            },
+            {
+              "value": "leading-start",
+              "type": "string"
+            },
+            {
+              "value": "leading",
+              "type": "string"
+            },
+            {
+              "value": "leading-end",
+              "type": "string"
+            },
+            {
+              "value": "trailing-end",
+              "type": "string"
+            },
+            {
+              "value": "trailing",
+              "type": "string"
+            },
+            {
+              "value": "trailing-start",
+              "type": "string"
             }
           ],
           "optional": false,