@esri/calcite-components 1.5.0-next.32 → 1.5.0-next.34

package/dist/extras/docs-json.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2023-08-02T16:02:22",
+  "timestamp": "2023-08-03T02:24:56",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.22.3",
@@ -8677,14 +8677,14 @@
         },
         {
           "name": "messageOverrides",
-          "type": "{ dragHandle?: string; }",
+          "type": "{ dragHandle?: string; dragHandleActive?: string; dragHandleChange?: string; dragHandleCommit?: string; dragHandleIdle?: string; }",
           "mutable": false,
           "reflectToAttr": false,
           "docs": "Use this property to override individual strings used by the component.",
           "docsTags": [],
           "values": [
             {
-              "type": "{ dragHandle?: string; }"
+              "type": "{ dragHandle?: string; dragHandleActive?: string; dragHandleChange?: string; dragHandleCommit?: string; dragHandleIdle?: string; }"
             }
           ],
           "optional": false,
@@ -8713,6 +8713,15 @@
           "composed": true,
           "docs": "Emitted when the handle is activated and the up or down arrow key is pressed.",
           "docsTags": []
+        },
+        {
+          "event": "calciteInternalHandleChange",
+          "detail": "HandleChange",
+          "bubbles": true,
+          "cancelable": false,
+          "composed": true,
+          "docs": "Emitted when the handle is activated or deactivated.",
+          "docsTags": []
         }
       ],
       "listeners": [],
@@ -8720,7 +8729,8 @@
       "slots": [],
       "parts": [],
       "dependents": [
-        "calcite-block"
+        "calcite-block",
+        "calcite-list-item"
       ],
       "dependencies": [
         "calcite-icon"
@@ -8731,6 +8741,9 @@
         ],
         "calcite-block": [
           "calcite-handle"
+        ],
+        "calcite-list-item": [
+          "calcite-handle"
         ]
       }
     },
@@ -13444,10 +13457,42 @@
       "usage": {
         "Advanced": "```html\n<calcite-list>\n  <calcite-list-item label=\"Princess Bubblegum\" description=\"Ruler of The Candy Kingdom\">\n    <calcite-action icon=\"drag\" label=\"drag\" scale=\"s\" slot=\"actions-start\"></calcite-action>\n    <calcite-icon scale=\"l\" icon=\"effects\" slot=\"content-start\"></calcite-icon>\n    <calcite-avatar\n      scale=\"l\"\n      slot=\"content-start\"\n      thumbnail=\"https://slm-assets.secondlife.com/assets/19947929/view_large/Capture_du_2018-03-04_20-40-56.jpg?1520192584\"\n    ></calcite-avatar>\n    <calcite-icon scale=\"s\" icon=\"check\" slot=\"content-end\" style=\"color: var(--calcite-ui-success)\"></calcite-icon>\n    <calcite-action icon=\"ellipsis\" label=\"menu\" slot=\"actions-end\"></calcite-action>\n    <calcite-action icon=\"x\" label=\"remove\" slot=\"actions-end\"></calcite-action>\n  </calcite-list-item>\n  <calcite-list-item label=\"Finn Mertens\" description=\"Part owner of the Tree House\">\n    <calcite-action icon=\"drag\" label=\"drag\" scale=\"s\" slot=\"actions-start\"></calcite-action>\n    <calcite-icon scale=\"l\" icon=\"running\" slot=\"content-start\"></calcite-icon>\n    <calcite-avatar\n      scale=\"l\"\n      slot=\"content-start\"\n      thumbnail=\"https://www.seekpng.com/png/detail/90-906849_89kib-1024x631-finn-finn-adventure-time-face.png\"\n    ></calcite-avatar>\n    <calcite-icon scale=\"s\" icon=\"check\" slot=\"content-end\" style=\"color: var(--calcite-ui-success)\"></calcite-icon>\n    <calcite-action icon=\"ellipsis\" label=\"menu\" slot=\"actions-end\"></calcite-action>\n    <calcite-action icon=\"x\" label=\"remove\" slot=\"actions-end\"></calcite-action>\n  </calcite-list-item>\n  <calcite-list-item label=\"Jake T. Dog\" description=\"Part owner of the Tree House\">\n    <calcite-action icon=\"drag\" label=\"drag\" scale=\"s\" slot=\"actions-start\"></calcite-action>\n    <calcite-icon scale=\"l\" icon=\"walking\" slot=\"content-start\"></calcite-icon>\n    <calcite-avatar\n      scale=\"l\"\n      slot=\"content-start\"\n      thumbnail=\"https://static.wikia.nocookie.net/adventuretimewithfinnandjake/images/c/c9/603138_454321168018988_647044807_n.png/revision/latest/scale-to-width-down/250?cb=20140624024310\"\n    ></calcite-avatar>\n    <calcite-icon\n      scale=\"s\"\n      icon=\"exclamation-mark-triangle\"\n      slot=\"content-end\"\n      style=\"color: var(--calcite-ui-danger)\"\n    ></calcite-icon>\n    <calcite-action icon=\"ellipsis\" label=\"menu\" slot=\"actions-end\"></calcite-action>\n    <calcite-action icon=\"x\" label=\"remove\" slot=\"actions-end\"></calcite-action>\n  </calcite-list-item>\n</calcite-list>\n```\n",
         "Basic": "```html\n<calcite-list>\n  <calcite-list-item\n    label=\"Cras iaculis ultricies nulla.\"\n    description=\"Lorem ipsum dolor sit amet, consectetuer adipiscing elit.\"\n  ></calcite-list-item>\n  <calcite-list-item\n    label=\"Ut aliquam sollicitudin leo.\"\n    description=\"Aliquam tincidunt mauris eu risus.\"\n  ></calcite-list-item>\n  <calcite-list-item\n    label=\"Vestibulum commodo felis quis tortor.\n  \"\n    description=\"Vestibulum auctor dapibus neque.\n  \"\n  ></calcite-list-item>\n</calcite-list>\n```\n",
+        "DragEnabled": "```html\n<calcite-list drag-enabled>\n  <calcite-list-item label=\"test1\" value=\"test1\" description=\"hello world 1\">\n    <calcite-icon icon=\"banana\" slot=\"content-start\"></calcite-icon>\n  </calcite-list-item>\n  <calcite-list-item label=\"test2\" value=\"test2\" description=\"hello world 2\">\n    <calcite-icon icon=\"accessibility\" slot=\"content-start\"></calcite-icon>\n  </calcite-list-item>\n  <calcite-list-item label=\"test3\" value=\"test3\" description=\"hello world 3\">\n    <calcite-icon icon=\"article\" slot=\"content-start\"></calcite-icon>\n  </calcite-list-item>\n  <calcite-list-item disabled label=\"test4\" value=\"test4\" description=\"hello world 4\">\n    <calcite-icon icon=\"compass\" slot=\"content-start\"></calcite-icon>\n  </calcite-list-item>\n</calcite-list>\n```\n",
+        "DragEnabledNested": "```html\n<calcite-list drag-enabled group=\"mygroup\" selection-mode=\"multiple\">\n  <calcite-list-item open label=\"My Item 1\" description=\"hello world\">\n    <calcite-list drag-enabled group=\"mygroup\" selection-mode=\"multiple\">\n      <calcite-list-item open label=\"My Item 2\" description=\"hello world\">\n        <calcite-list drag-enabled group=\"mygroup\" selection-mode=\"multiple\">\n          <calcite-list-item label=\"My Item 3\" description=\"hello world\">\n            <calcite-list drag-enabled group=\"mygroup\" selection-mode=\"multiple\"></calcite-list>\n          </calcite-list-item>\n          <calcite-list-item label=\"My Item 4\" description=\"hello world\"></calcite-list-item>\n        </calcite-list>\n      </calcite-list-item>\n      <calcite-list-item label=\"My Item 5\" description=\"hello world\"></calcite-list-item>\n    </calcite-list>\n  </calcite-list-item>\n  <calcite-list-item label=\"My Item 6\" description=\"hello world\"></calcite-list-item>\n  <calcite-list-item label=\"My Item 7\" description=\"hello world\"></calcite-list-item>\n</calcite-list>\n```\n",
         "Grouped": "```html\n<calcite-list>\n  <calcite-list-item-group heading=\"Digits\">\n    <calcite-list-item\n      label=\"One\"\n      description=\"Lorem ipsum dolor sit amet, consectetuer adipiscing elit.\"\n    ></calcite-list-item>\n    <calcite-list-item label=\"Two\" description=\"Aliquam tincidunt mauris eu risus.\"></calcite-list-item>\n    <calcite-list-item label=\"Three\" description=\"Vestibulum auctor dapibus neque.\"></calcite-list-item>\n  </calcite-list-item-group>\n  <calcite-list-item-group heading=\"Letters\">\n    <calcite-list-item\n      label=\"A\"\n      description=\"Lorem ipsum dolor sit amet, consectetuer adipiscing elit.\"\n    ></calcite-list-item>\n    <calcite-list-item label=\"B\" description=\"Aliquam tincidunt mauris eu risus.\"></calcite-list-item>\n    <calcite-list-item\n      label=\"C\"\n      description=\"Lorem ipsum dolor sit amet, consectetuer adipiscing elit.\"\n    ></calcite-list-item>\n  </calcite-list-item-group>\n</calcite-list>\n```\n",
         "Nested": "```html\n<calcite-list>\n  <calcite-list-item\n    label=\"Cras iaculis ultricies nulla.\"\n    description=\"Lorem ipsum dolor sit amet, consectetuer adipiscing elit.\"\n  >\n    <calcite-list-item label=\"Ut aliquam sollicitudin leo.\" description=\"Aliquam tincidunt mauris eu risus.\">\n      <calcite-list-item\n        label=\"Vestibulum commodo felis quis tortor.\"\n        description=\"Vestibulum auctor dapibus neque.\"\n      ></calcite-list-item></calcite-list-item\n  ></calcite-list-item>\n</calcite-list>\n```\n"
       },
       "props": [
+        {
+          "name": "canPull",
+          "type": "(event: DragEvent) => boolean",
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "When provided, the method will be called to determine whether the element can  move from the list.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "(event: DragEvent) => boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "canPut",
+          "type": "(event: DragEvent) => boolean",
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "When provided, the method will be called to determine whether the element can be added from another list.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "(event: DragEvent) => boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "disabled",
           "type": "boolean",
@@ -13465,6 +13510,23 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "dragEnabled",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "drag-enabled",
+          "reflectToAttr": true,
+          "docs": "When `true`, `calcite-list-item`s are sortable via a draggable button.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "filterEnabled",
           "type": "boolean",
@@ -13554,6 +13616,22 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "group",
+          "type": "string",
+          "mutable": false,
+          "attr": "group",
+          "reflectToAttr": true,
+          "docs": "The list's group identifier.\n\nTo drag elements from one list into another, both lists must have the same group value.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "label",
           "type": "string",
@@ -13674,6 +13752,15 @@
         }
       ],
       "events": [
+        {
+          "event": "calciteInternalListDefaultSlotChange",
+          "detail": "DragEvent",
+          "bubbles": true,
+          "cancelable": false,
+          "composed": true,
+          "docs": "Emitted when the default slot has changes in order to notify parent lists.",
+          "docsTags": []
+        },
         {
           "event": "calciteListChange",
           "detail": "void",
@@ -13691,6 +13778,15 @@
           "composed": true,
           "docs": "Emits when the component's filter has changed.",
           "docsTags": []
+        },
+        {
+          "event": "calciteListOrderChange",
+          "detail": "DragEvent",
+          "bubbles": true,
+          "cancelable": false,
+          "composed": true,
+          "docs": "Emitted when the order of the list has changed.",
+          "docsTags": []
         }
       ],
       "listeners": [
@@ -13709,6 +13805,16 @@
           "capture": false,
           "passive": false
         },
+        {
+          "event": "calciteInternalHandleChange",
+          "capture": false,
+          "passive": false
+        },
+        {
+          "event": "calciteHandleNudge",
+          "capture": false,
+          "passive": false
+        },
         {
           "event": "calciteInternalListItemSelect",
           "capture": false,
@@ -13718,6 +13824,11 @@
           "event": "calciteInternalListItemChange",
           "capture": false,
           "passive": false
+        },
+        {
+          "event": "calciteInternalListItemGroupDefaultSlotChange",
+          "capture": false,
+          "passive": false
         }
       ],
       "styles": [],
@@ -13991,7 +14102,18 @@
           "docsTags": []
         }
       ],
-      "listeners": [],
+      "listeners": [
+        {
+          "event": "calciteInternalListItemGroupDefaultSlotChange",
+          "capture": false,
+          "passive": false
+        },
+        {
+          "event": "calciteInternalListDefaultSlotChange",
+          "capture": false,
+          "passive": false
+        }
+      ],
       "styles": [],
       "slots": [
         {
@@ -14023,13 +14145,18 @@
       "dependents": [],
       "dependencies": [
         "calcite-icon",
+        "calcite-handle",
         "calcite-action"
       ],
       "dependencyGraph": {
         "calcite-list-item": [
           "calcite-icon",
+          "calcite-handle",
           "calcite-action"
         ],
+        "calcite-handle": [
+          "calcite-icon"
+        ],
         "calcite-action": [
           "calcite-loader",
           "calcite-icon"
@@ -14085,7 +14212,17 @@
         }
       ],
       "methods": [],
-      "events": [],
+      "events": [
+        {
+          "event": "calciteInternalListItemGroupDefaultSlotChange",
+          "detail": "DragEvent",
+          "bubbles": true,
+          "cancelable": false,
+          "composed": true,
+          "docs": "Emitted when the default slot has changes in order to notify parent lists.",
+          "docsTags": []
+        }
+      ],
       "listeners": [],
       "styles": [],
       "slots": [
@@ -20558,6 +20695,36 @@
       ],
       "usage": {},
       "props": [
+        {
+          "name": "canPull",
+          "type": "(event: DragEvent) => boolean",
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "When provided, the method will be called to determine whether the element can  move from the list.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "(event: DragEvent) => boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "canPut",
+          "type": "(event: DragEvent) => boolean",
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "When provided, the method will be called to determine whether the element can be added from another list.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "(event: DragEvent) => boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "disabled",
           "type": "boolean",
@@ -24979,6 +25146,36 @@
         "Drag-and-drop": "Renders a value list with drag and drop capability between the items.\n\n```html\n<calcite-value-list drag-enabled>\n  <calcite-value-list-item label=\"Rent\" description=\"Mortgage + housing costs\" value=\"rent\"> </calcite-value-list-item>\n  <calcite-value-list-item label=\"Food\" description=\"its what you eat.\" value=\"food\"> </calcite-value-list-item>\n  <calcite-value-list-item label=\"Utilities\" value=\"utilities\"> </calcite-value-list-item>\n  <calcite-value-list-item label=\"Entertainment\" description=\"Toys and leisure\" value=\"entertainment\">\n  </calcite-value-list-item>\n</calcite-value-list>\n```\n"
       },
       "props": [
+        {
+          "name": "canPull",
+          "type": "(event: DragEvent) => boolean",
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "When provided, the method will be called to determine whether the element can  move from the list.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "(event: DragEvent) => boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "canPut",
+          "type": "(event: DragEvent) => boolean",
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "When provided, the method will be called to determine whether the element can be added from another list.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "(event: DragEvent) => boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "disabled",
           "type": "boolean",