@esri/calcite-components 1.0.0-next.708 → 1.0.0-next.709

package/dist/extras/docs-json.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2023-01-05T17:06:08",
+  "timestamp": "2023-01-05T17:48:59",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.20.0",
@@ -8253,8 +8253,8 @@
         "calcite-pagination",
         "calcite-pick-list-item",
         "calcite-popover",
-        "calcite-radio-group-item",
         "calcite-rating",
+        "calcite-segmented-control-item",
         "calcite-select",
         "calcite-stepper-item",
         "calcite-tab-title",
@@ -8341,10 +8341,10 @@
         "calcite-popover": [
           "calcite-icon"
         ],
-        "calcite-radio-group-item": [
+        "calcite-rating": [
           "calcite-icon"
         ],
-        "calcite-rating": [
+        "calcite-segmented-control-item": [
           "calcite-icon"
         ],
         "calcite-select": [
@@ -16393,42 +16393,43 @@
       "dependencyGraph": {}
     },
     {
-      "filePath": "./src/components/radio-group/radio-group.tsx",
+      "filePath": "./src/components/rating/rating.tsx",
       "encapsulation": "shadow",
-      "tag": "calcite-radio-group",
-      "readme": "# calcite-radio-group\n",
+      "tag": "calcite-rating",
+      "readme": "# calcite-rating\n",
       "docs": "",
-      "docsTags": [
-        {
-          "name": "slot",
-          "text": "- A slot for adding `calcite-radio-group-item`s."
-        }
-      ],
+      "docsTags": [],
       "usage": {
-        "Basic": "```html\n<calcite-radio-group layout=\"horizontal\" appearance=\"solid\" scale=\"m\" width=\"auto\">\n  <calcite-radio-group-item value=\"apple\" checked>Apple</calcite-radio-group-item>\n  <calcite-radio-group-item value=\"mango\">Mango</calcite-radio-group-item>\n  <calcite-radio-group-item value=\"tomato\">Tomato</calcite-radio-group-item>\n  <calcite-radio-group-item value=\"banana\">Banana</calcite-radio-group-item>\n</calcite-radio-group>\n```\n"
+        "Basic": "```html\n<calcite-rating show-chip scale=\"m\" value=\"0\" average=\"4.4\" count=\"10\"></calcite-rating>\n```\n"
       },
       "props": [
         {
-          "name": "appearance",
-          "type": "\"outline\" | \"outline-fill\" | \"solid\"",
+          "name": "average",
+          "type": "number",
           "mutable": false,
-          "attr": "appearance",
+          "attr": "average",
           "reflectToAttr": true,
-          "docs": "Specifies the appearance style of the component.",
+          "docs": "Specifies a cumulative average from previous ratings to display.",
           "docsTags": [],
-          "default": "\"solid\"",
           "values": [
             {
-              "value": "outline",
-              "type": "string"
-            },
-            {
-              "value": "outline-fill",
-              "type": "string"
-            },
+              "type": "number"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "count",
+          "type": "number",
+          "mutable": false,
+          "attr": "count",
+          "reflectToAttr": true,
+          "docs": "Specifies the number of previous ratings to display.",
+          "docsTags": [],
+          "values": [
             {
-              "value": "solid",
-              "type": "string"
+              "type": "number"
             }
           ],
           "optional": false,
@@ -16452,26 +16453,15 @@
           "required": false
         },
         {
-          "name": "layout",
-          "type": "\"grid\" | \"horizontal\" | \"vertical\"",
-          "mutable": false,
-          "attr": "layout",
-          "reflectToAttr": true,
-          "docs": "Defines the layout of the component.",
+          "name": "messageOverrides",
+          "type": "{ rating?: string; stars?: string; }",
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "Use this property to override individual strings used by the component.",
           "docsTags": [],
-          "default": "\"horizontal\"",
           "values": [
             {
-              "value": "grid",
-              "type": "string"
-            },
-            {
-              "value": "horizontal",
-              "type": "string"
-            },
-            {
-              "value": "vertical",
-              "type": "string"
+              "type": "{ rating?: string; stars?: string; }"
             }
           ],
           "optional": false,
@@ -16493,6 +16483,23 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "readOnly",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "read-only",
+          "reflectToAttr": true,
+          "docs": "When `true`, the component's value can be read, but cannot be modified.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "scale",
           "type": "\"l\" | \"m\" | \"s\"",
@@ -16520,19 +16527,17 @@
           "required": false
         },
         {
-          "name": "selectedItem",
-          "type": "HTMLCalciteRadioGroupItemElement",
-          "mutable": true,
-          "reflectToAttr": false,
-          "docs": "The component's selected item `HTMLElement`.",
-          "docsTags": [
-            {
-              "name": "readonly"
-            }
-          ],
+          "name": "showChip",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "show-chip",
+          "reflectToAttr": true,
+          "docs": "When `true`, and if available, displays the `average` and/or `count` data summary in a `calcite-chip`.",
+          "docsTags": [],
+          "default": "false",
           "values": [
             {
-              "type": "HTMLCalciteRadioGroupItemElement"
+              "type": "boolean"
             }
           ],
           "optional": false,
@@ -16540,38 +16545,16 @@
         },
         {
           "name": "value",
-          "type": "string",
+          "type": "number",
           "mutable": true,
           "attr": "value",
-          "reflectToAttr": false,
-          "docs": "The component's `selectedItem` value.",
-          "docsTags": [],
-          "default": "null",
-          "values": [
-            {
-              "type": "string"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
-        {
-          "name": "width",
-          "type": "\"auto\" | \"full\"",
-          "mutable": false,
-          "attr": "width",
           "reflectToAttr": true,
-          "docs": "Specifies the width of the component.",
+          "docs": "The component's value.",
           "docsTags": [],
-          "default": "\"auto\"",
+          "default": "0",
           "values": [
             {
-              "value": "auto",
-              "type": "string"
-            },
-            {
-              "value": "full",
-              "type": "string"
+              "type": "number"
             }
           ],
           "optional": false,
@@ -16593,88 +16576,64 @@
       ],
       "events": [
         {
-          "event": "calciteRadioGroupChange",
+          "event": "calciteRatingChange",
           "detail": "void",
           "bubbles": true,
           "cancelable": false,
           "composed": true,
-          "docs": "Fires when the selected option changes, where the event detail is the new value.",
+          "docs": "Fires when the component's value changes.",
           "docsTags": []
         }
       ],
-      "listeners": [
-        {
-          "event": "calciteInternalRadioGroupItemChange",
-          "capture": false,
-          "passive": false
-        },
-        {
-          "event": "keydown",
-          "capture": false,
-          "passive": false
-        }
-      ],
-      "styles": [],
-      "slots": [
+      "listeners": [],
+      "styles": [
         {
-          "name": "",
-          "docs": "A slot for adding `calcite-radio-group-item`s."
+          "name": "--calcite-rating-spacing-unit",
+          "annotation": "prop",
+          "docs": "The amount of left and right margin spacing between each rating star."
         }
       ],
+      "slots": [],
       "parts": [],
       "dependents": [],
-      "dependencies": [],
-      "dependencyGraph": {}
+      "dependencies": [
+        "calcite-chip",
+        "calcite-icon"
+      ],
+      "dependencyGraph": {
+        "calcite-rating": [
+          "calcite-chip",
+          "calcite-icon"
+        ],
+        "calcite-chip": [
+          "calcite-icon"
+        ]
+      }
     },
     {
-      "filePath": "./src/components/radio-group-item/radio-group-item.tsx",
+      "filePath": "./src/components/scrim/scrim.tsx",
       "encapsulation": "shadow",
-      "tag": "calcite-radio-group-item",
-      "readme": "# calcite-radio-group-item\n",
+      "tag": "calcite-scrim",
+      "readme": "# calcite-scrim\n",
       "docs": "",
-      "docsTags": [],
-      "usage": {},
-      "props": [
-        {
-          "name": "checked",
-          "type": "boolean",
-          "mutable": true,
-          "attr": "checked",
-          "reflectToAttr": true,
-          "docs": "When `true`, the component is checked.",
-          "docsTags": [],
-          "default": "false",
-          "values": [
-            {
-              "type": "boolean"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
+      "docsTags": [
         {
-          "name": "iconEnd",
-          "type": "string",
-          "mutable": false,
-          "attr": "icon-end",
-          "reflectToAttr": true,
-          "docs": "Specifies an icon to display at the end of the component.",
-          "docsTags": [],
-          "values": [
-            {
-              "type": "string"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
+          "name": "slot",
+          "text": "- A slot for adding custom content, primarily loading information."
+        }
+      ],
+      "usage": {
+        "Basic": "```html\n<div style=\"position: relative; width: 200px; height: 200px; overflow: auto;\">\n  <calcite-scrim>\n    <p>I'm a panel that is not loading.</p>\n    <p>This content can have any zIndex and it will not be placed above</p>\n    <p>.</p>\n    <p>.</p>\n    <p>.</p>\n    <p>.</p>\n  </calcite-scrim>\n</div>\n```\n",
+        "Loading-scrim-panel": "```html\n<div style=\"position: relative; width: 200px; height: 200px; overflow: auto;\">\n  <calcite-scrim loading>\n    <p>I'm a panel that is not loading.</p>\n    <p>I have a loading spinner over my content.</p>\n    <p>.</p>\n    <p>.</p>\n    <p>.</p>\n    <p>.</p>\n  </calcite-scrim>\n</div>\n```\n"
+      },
+      "props": [
         {
-          "name": "iconFlipRtl",
+          "name": "loading",
           "type": "boolean",
           "mutable": false,
-          "attr": "icon-flip-rtl",
+          "attr": "loading",
           "reflectToAttr": true,
-          "docs": "When `true`, the icon will be flipped when the element direction is right-to-left (`\"rtl\"`).",
+          "docs": "When `true`, a busy indicator is displayed.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -16686,32 +16645,15 @@
           "required": false
         },
         {
-          "name": "iconStart",
-          "type": "string",
-          "mutable": false,
-          "attr": "icon-start",
-          "reflectToAttr": true,
-          "docs": "Specifies an icon to display at the start of the component.",
-          "docsTags": [],
-          "values": [
-            {
-              "type": "string"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
-        {
-          "name": "value",
-          "type": "any",
+          "name": "messageOverrides",
+          "type": "{ loading?: string; }",
           "mutable": true,
-          "attr": "value",
           "reflectToAttr": false,
-          "docs": "The component's value.",
+          "docs": "Use this property to override individual strings used by the component.",
           "docsTags": [],
           "values": [
             {
-              "type": "any"
+              "type": "{ loading?: string; }"
             }
           ],
           "optional": false,
@@ -16721,57 +16663,92 @@
       "methods": [],
       "events": [],
       "listeners": [],
-      "styles": [],
-      "slots": [],
-      "parts": [],
-      "dependents": [],
+      "styles": [
+        {
+          "name": "--calcite-scrim-background",
+          "annotation": "prop",
+          "docs": "Specifies the background color of the scrim."
+        }
+      ],
+      "slots": [
+        {
+          "name": "",
+          "docs": "A slot for adding custom content, primarily loading information."
+        }
+      ],
+      "parts": [],
+      "dependents": [
+        "calcite-block",
+        "calcite-list",
+        "calcite-modal",
+        "calcite-panel",
+        "calcite-pick-list",
+        "calcite-value-list"
+      ],
       "dependencies": [
-        "calcite-icon"
+        "calcite-loader"
       ],
       "dependencyGraph": {
-        "calcite-radio-group-item": [
-          "calcite-icon"
+        "calcite-scrim": [
+          "calcite-loader"
+        ],
+        "calcite-block": [
+          "calcite-scrim"
+        ],
+        "calcite-list": [
+          "calcite-scrim"
+        ],
+        "calcite-modal": [
+          "calcite-scrim"
+        ],
+        "calcite-panel": [
+          "calcite-scrim"
+        ],
+        "calcite-pick-list": [
+          "calcite-scrim"
+        ],
+        "calcite-value-list": [
+          "calcite-scrim"
         ]
       }
     },
     {
-      "filePath": "./src/components/rating/rating.tsx",
+      "filePath": "./src/components/segmented-control/segmented-control.tsx",
       "encapsulation": "shadow",
-      "tag": "calcite-rating",
-      "readme": "# calcite-rating\n",
+      "tag": "calcite-segmented-control",
+      "readme": "# calcite-segmented-control\n",
       "docs": "",
-      "docsTags": [],
+      "docsTags": [
+        {
+          "name": "slot",
+          "text": "- A slot for adding `calcite-segmented-control-item`s."
+        }
+      ],
       "usage": {
-        "Basic": "```html\n<calcite-rating show-chip scale=\"m\" value=\"0\" average=\"4.4\" count=\"10\"></calcite-rating>\n```\n"
+        "Basic": "```html\n<calcite-segmented-control layout=\"horizontal\" appearance=\"solid\" scale=\"m\" width=\"auto\">\n  <calcite-segmented-control-item value=\"apple\" checked>Apple</calcite-segmented-control-item>\n  <calcite-segmented-control-item value=\"mango\">Mango</calcite-segmented-control-item>\n  <calcite-segmented-control-item value=\"tomato\">Tomato</calcite-segmented-control-item>\n  <calcite-segmented-control-item value=\"banana\">Banana</calcite-segmented-control-item>\n</calcite-segmented-control>\n```\n"
       },
       "props": [
         {
-          "name": "average",
-          "type": "number",
+          "name": "appearance",
+          "type": "\"outline\" | \"outline-fill\" | \"solid\"",
           "mutable": false,
-          "attr": "average",
+          "attr": "appearance",
           "reflectToAttr": true,
-          "docs": "Specifies a cumulative average from previous ratings to display.",
+          "docs": "Specifies the appearance style of the component.",
           "docsTags": [],
+          "default": "\"solid\"",
           "values": [
             {
-              "type": "number"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
-        {
-          "name": "count",
-          "type": "number",
-          "mutable": false,
-          "attr": "count",
-          "reflectToAttr": true,
-          "docs": "Specifies the number of previous ratings to display.",
-          "docsTags": [],
-          "values": [
+              "value": "outline",
+              "type": "string"
+            },
             {
-              "type": "number"
+              "value": "outline-fill",
+              "type": "string"
+            },
+            {
+              "value": "solid",
+              "type": "string"
             }
           ],
           "optional": false,
@@ -16795,15 +16772,26 @@
           "required": false
         },
         {
-          "name": "messageOverrides",
-          "type": "{ rating?: string; stars?: string; }",
-          "mutable": true,
-          "reflectToAttr": false,
-          "docs": "Use this property to override individual strings used by the component.",
+          "name": "layout",
+          "type": "\"grid\" | \"horizontal\" | \"vertical\"",
+          "mutable": false,
+          "attr": "layout",
+          "reflectToAttr": true,
+          "docs": "Defines the layout of the component.",
           "docsTags": [],
+          "default": "\"horizontal\"",
           "values": [
             {
-              "type": "{ rating?: string; stars?: string; }"
+              "value": "grid",
+              "type": "string"
+            },
+            {
+              "value": "horizontal",
+              "type": "string"
+            },
+            {
+              "value": "vertical",
+              "type": "string"
             }
           ],
           "optional": false,
@@ -16825,23 +16813,6 @@
           "optional": false,
           "required": false
         },
-        {
-          "name": "readOnly",
-          "type": "boolean",
-          "mutable": false,
-          "attr": "read-only",
-          "reflectToAttr": true,
-          "docs": "When `true`, the component's value can be read, but cannot be modified.",
-          "docsTags": [],
-          "default": "false",
-          "values": [
-            {
-              "type": "boolean"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
         {
           "name": "scale",
           "type": "\"l\" | \"m\" | \"s\"",
@@ -16869,17 +16840,19 @@
           "required": false
         },
         {
-          "name": "showChip",
-          "type": "boolean",
-          "mutable": false,
-          "attr": "show-chip",
-          "reflectToAttr": true,
-          "docs": "When `true`, and if available, displays the `average` and/or `count` data summary in a `calcite-chip`.",
-          "docsTags": [],
-          "default": "false",
+          "name": "selectedItem",
+          "type": "HTMLCalciteSegmentedControlItemElement",
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "The component's selected item `HTMLElement`.",
+          "docsTags": [
+            {
+              "name": "readonly"
+            }
+          ],
           "values": [
             {
-              "type": "boolean"
+              "type": "HTMLCalciteSegmentedControlItemElement"
             }
           ],
           "optional": false,
@@ -16887,16 +16860,38 @@
         },
         {
           "name": "value",
-          "type": "number",
+          "type": "string",
           "mutable": true,
           "attr": "value",
+          "reflectToAttr": false,
+          "docs": "The component's `selectedItem` value.",
+          "docsTags": [],
+          "default": "null",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "width",
+          "type": "\"auto\" | \"full\"",
+          "mutable": false,
+          "attr": "width",
           "reflectToAttr": true,
-          "docs": "The component's value.",
+          "docs": "Specifies the width of the component.",
           "docsTags": [],
-          "default": "0",
+          "default": "\"auto\"",
           "values": [
             {
-              "type": "number"
+              "value": "auto",
+              "type": "string"
+            },
+            {
+              "value": "full",
+              "type": "string"
             }
           ],
           "optional": false,
@@ -16918,64 +16913,88 @@
       ],
       "events": [
         {
-          "event": "calciteRatingChange",
+          "event": "calciteRadioGroupChange",
           "detail": "void",
           "bubbles": true,
           "cancelable": false,
           "composed": true,
-          "docs": "Fires when the component's value changes.",
+          "docs": "Fires when the selected option changes, where the event detail is the new value.",
           "docsTags": []
         }
       ],
-      "listeners": [],
-      "styles": [
+      "listeners": [
         {
-          "name": "--calcite-rating-spacing-unit",
-          "annotation": "prop",
-          "docs": "The amount of left and right margin spacing between each rating star."
+          "event": "calciteInternalRadioGroupItemChange",
+          "capture": false,
+          "passive": false
+        },
+        {
+          "event": "keydown",
+          "capture": false,
+          "passive": false
+        }
+      ],
+      "styles": [],
+      "slots": [
+        {
+          "name": "",
+          "docs": "A slot for adding `calcite-segmented-control-item`s."
         }
       ],
-      "slots": [],
       "parts": [],
       "dependents": [],
-      "dependencies": [
-        "calcite-chip",
-        "calcite-icon"
-      ],
-      "dependencyGraph": {
-        "calcite-rating": [
-          "calcite-chip",
-          "calcite-icon"
-        ],
-        "calcite-chip": [
-          "calcite-icon"
-        ]
-      }
+      "dependencies": [],
+      "dependencyGraph": {}
     },
     {
-      "filePath": "./src/components/scrim/scrim.tsx",
+      "filePath": "./src/components/segmented-control-item/segmented-control-item.tsx",
       "encapsulation": "shadow",
-      "tag": "calcite-scrim",
-      "readme": "# calcite-scrim\n",
+      "tag": "calcite-segmented-control-item",
+      "readme": "# calcite-segmented-control-item\n",
       "docs": "",
-      "docsTags": [
-        {
-          "name": "slot",
-          "text": "- A slot for adding custom content, primarily loading information."
-        }
-      ],
-      "usage": {
-        "Basic": "```html\n<div style=\"position: relative; width: 200px; height: 200px; overflow: auto;\">\n  <calcite-scrim>\n    <p>I'm a panel that is not loading.</p>\n    <p>This content can have any zIndex and it will not be placed above</p>\n    <p>.</p>\n    <p>.</p>\n    <p>.</p>\n    <p>.</p>\n  </calcite-scrim>\n</div>\n```\n",
-        "Loading-scrim-panel": "```html\n<div style=\"position: relative; width: 200px; height: 200px; overflow: auto;\">\n  <calcite-scrim loading>\n    <p>I'm a panel that is not loading.</p>\n    <p>I have a loading spinner over my content.</p>\n    <p>.</p>\n    <p>.</p>\n    <p>.</p>\n    <p>.</p>\n  </calcite-scrim>\n</div>\n```\n"
-      },
+      "docsTags": [],
+      "usage": {},
       "props": [
         {
-          "name": "loading",
+          "name": "checked",
           "type": "boolean",
+          "mutable": true,
+          "attr": "checked",
+          "reflectToAttr": true,
+          "docs": "When `true`, the component is checked.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "iconEnd",
+          "type": "string",
           "mutable": false,
-          "attr": "loading",
+          "attr": "icon-end",
           "reflectToAttr": true,
-          "docs": "When `true`, a busy indicator is displayed.",
+          "docs": "Specifies an icon to display at the end of the component.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "iconFlipRtl",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "icon-flip-rtl",
+          "reflectToAttr": true,
+          "docs": "When `true`, the icon will be flipped when the element direction is right-to-left (`\"rtl\"`).",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -16987,15 +17006,32 @@
           "required": false
         },
         {
-          "name": "messageOverrides",
-          "type": "{ loading?: string; }",
+          "name": "iconStart",
+          "type": "string",
+          "mutable": false,
+          "attr": "icon-start",
+          "reflectToAttr": true,
+          "docs": "Specifies an icon to display at the start of the component.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "value",
+          "type": "any",
           "mutable": true,
+          "attr": "value",
           "reflectToAttr": false,
-          "docs": "Use this property to override individual strings used by the component.",
+          "docs": "The component's value.",
           "docsTags": [],
           "values": [
             {
-              "type": "{ loading?: string; }"
+              "type": "any"
             }
           ],
           "optional": false,
@@ -17005,52 +17041,16 @@
       "methods": [],
       "events": [],
       "listeners": [],
-      "styles": [
-        {
-          "name": "--calcite-scrim-background",
-          "annotation": "prop",
-          "docs": "Specifies the background color of the scrim."
-        }
-      ],
-      "slots": [
-        {
-          "name": "",
-          "docs": "A slot for adding custom content, primarily loading information."
-        }
-      ],
+      "styles": [],
+      "slots": [],
       "parts": [],
-      "dependents": [
-        "calcite-block",
-        "calcite-list",
-        "calcite-modal",
-        "calcite-panel",
-        "calcite-pick-list",
-        "calcite-value-list"
-      ],
+      "dependents": [],
       "dependencies": [
-        "calcite-loader"
+        "calcite-icon"
       ],
       "dependencyGraph": {
-        "calcite-scrim": [
-          "calcite-loader"
-        ],
-        "calcite-block": [
-          "calcite-scrim"
-        ],
-        "calcite-list": [
-          "calcite-scrim"
-        ],
-        "calcite-modal": [
-          "calcite-scrim"
-        ],
-        "calcite-panel": [
-          "calcite-scrim"
-        ],
-        "calcite-pick-list": [
-          "calcite-scrim"
-        ],
-        "calcite-value-list": [
-          "calcite-scrim"
+        "calcite-segmented-control-item": [
+          "calcite-icon"
         ]
       }
     },