npm - @esri/calcite-components - Versions diffs - 1.0.0-next.571 → 1.0.0-next.574 - Mend

@esri/calcite-components 1.0.0-next.571 → 1.0.0-next.574

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 (896) hide show

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

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2022-08-19T21:36:51",
+  "timestamp": "2022-08-25T17:06:54",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.16.1",
@@ -24,13 +24,13 @@
       "props": [
         {
           "name": "appearance",
-          "type": "\"default\" | \"minimal\" | \"transparent\"",
+          "type": "\"default\" | \"minimal\" | \"solid\" | \"transparent\"",
           "mutable": false,
           "attr": "appearance",
           "reflectToAttr": true,
           "docs": "Specifies the appearance of the component.",
           "docsTags": [],
-          "default": "\"default\"",
+          "default": "\"solid\"",
           "values": [
             {
               "value": "default",
@@ -40,6 +40,10 @@
               "value": "minimal",
               "type": "string"
             },
+            {
+              "value": "solid",
+              "type": "string"
+            },
             {
               "value": "transparent",
               "type": "string"
@@ -674,6 +678,7 @@
         "calcite-action-group",
         "calcite-action-menu",
         "calcite-action-pad",
+        "calcite-flow-item",
         "calcite-panel",
         "calcite-pick-list-item",
         "calcite-popover",
@@ -701,6 +706,9 @@
         "calcite-action-pad": [
           "calcite-action"
         ],
+        "calcite-flow-item": [
+          "calcite-action"
+        ],
         "calcite-panel": [
           "calcite-action"
         ],
@@ -2794,7 +2802,7 @@
         },
         {
           "name": "appearance",
-          "type": "\"clear\" | \"outline\" | \"solid\" | \"transparent\"",
+          "type": "\"clear\" | \"minimal\" | \"outline\" | \"solid\" | \"transparent\"",
           "mutable": false,
           "attr": "appearance",
           "reflectToAttr": true,
@@ -2806,6 +2814,10 @@
               "value": "clear",
               "type": "string"
             },
+            {
+              "value": "minimal",
+              "type": "string"
+            },
             {
               "value": "outline",
               "type": "string"
@@ -3980,13 +3992,13 @@
         },
         {
           "name": "appearance",
-          "type": "\"default\" | \"minimal\"",
+          "type": "\"default\" | \"minimal\" | \"solid\"",
           "mutable": false,
           "attr": "appearance",
           "reflectToAttr": true,
-          "docs": "specify the appearance - default (containing border), or minimal (no containing border)",
+          "docs": "specify the appearance - solid (containing border), or minimal (no containing border)",
           "docsTags": [],
-          "default": "\"default\"",
+          "default": "\"solid\"",
           "values": [
             {
               "value": "default",
@@ -3995,6 +4007,10 @@
             {
               "value": "minimal",
               "type": "string"
+            },
+            {
+              "value": "solid",
+              "type": "string"
             }
           ],
           "optional": false,
@@ -7068,7 +7084,7 @@
         },
         {
           "name": "placement",
-          "type": "\"bottom\" | \"bottom-end\" | \"bottom-start\" | \"top\" | \"top-end\" | \"top-start\"",
+          "type": "\"bottom\" | \"bottom-end\" | \"bottom-leading\" | \"bottom-start\" | \"bottom-trailing\" | \"top\" | \"top-end\" | \"top-leading\" | \"top-start\" | \"top-trailing\"",
           "mutable": false,
           "attr": "placement",
           "reflectToAttr": true,
@@ -7089,10 +7105,18 @@
               "value": "bottom-end",
               "type": "string"
             },
+            {
+              "value": "bottom-leading",
+              "type": "string"
+            },
             {
               "value": "bottom-start",
               "type": "string"
             },
+            {
+              "value": "bottom-trailing",
+              "type": "string"
+            },
             {
               "value": "top",
               "type": "string"
@@ -7101,9 +7125,17 @@
               "value": "top-end",
               "type": "string"
             },
+            {
+              "value": "top-leading",
+              "type": "string"
+            },
             {
               "value": "top-start",
               "type": "string"
+            },
+            {
+              "value": "top-trailing",
+              "type": "string"
             }
           ],
           "optional": false,
@@ -8102,7 +8134,7 @@
       "docsTags": [
         {
           "name": "slot",
-          "text": "- A slot for adding `calcite-panel`s to the flow."
+          "text": "- A slot for adding `calcite-flow-item` or `calcite-panel`s (deprecated) to the flow."
         }
       ],
       "usage": {
@@ -8114,17 +8146,22 @@
         {
           "name": "back",
           "returns": {
-            "type": "Promise<HTMLCalcitePanelElement>",
+            "type": "Promise<HTMLCalciteFlowItemElement>",
             "docs": ""
           },
-          "signature": "back() => Promise<HTMLCalcitePanelElement>",
+          "signature": "back() => Promise<HTMLCalciteFlowItemElement>",
           "parameters": [],
-          "docs": "Removes the currently active `calcite-panel`.",
+          "docs": "Removes the currently active `calcite-flow-item` or `calcite-panel`.",
           "docsTags": []
         }
       ],
       "events": [],
       "listeners": [
+        {
+          "event": "calciteFlowItemBackClick",
+          "capture": false,
+          "passive": false
+        },
         {
           "event": "calcitePanelBackClick",
           "capture": false,
@@ -8135,7 +8172,7 @@
       "slots": [
         {
           "name": "",
-          "docs": "A slot for adding `calcite-panel`s to the flow."
+          "docs": "A slot for adding `calcite-flow-item` or `calcite-panel`s (deprecated) to the flow."
         }
       ],
       "parts": [],
@@ -8143,6 +8180,441 @@
       "dependencies": [],
       "dependencyGraph": {}
     },
+    {
+      "filePath": "./src/components/flow-item/flow-item.tsx",
+      "encapsulation": "shadow",
+      "tag": "calcite-flow-item",
+      "docs": "",
+      "docsTags": [
+        {
+          "name": "slot",
+          "text": "- A slot for adding custom content."
+        },
+        {
+          "name": "slot",
+          "text": "header-actions-start - A slot for adding actions or content to the start side of the header."
+        },
+        {
+          "name": "slot",
+          "text": "header-actions-end - A slot for adding actions or content to the end side of the header."
+        },
+        {
+          "name": "slot",
+          "text": "header-content - A slot for adding custom content to the header."
+        },
+        {
+          "name": "slot",
+          "text": "header-menu-actions - A slot for adding an overflow menu with actions inside a `calcite-dropdown`."
+        },
+        {
+          "name": "slot",
+          "text": "fab - A slot for adding a `calcite-fab` (floating action button) to perform an action."
+        },
+        {
+          "name": "slot",
+          "text": "footer-actions - A slot for adding buttons to the footer."
+        },
+        {
+          "name": "slot",
+          "text": "footer - A slot for adding custom content to the footer."
+        }
+      ],
+      "usage": {},
+      "props": [
+        {
+          "name": "beforeBack",
+          "type": "() => Promise<void>",
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "When provided, this method will be called before it is removed from the parent flow.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "() => Promise<void>"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "closable",
+          "type": "boolean",
+          "mutable": true,
+          "attr": "closable",
+          "reflectToAttr": true,
+          "docs": "When true, displays a close button in the trailing side of the header",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "closed",
+          "type": "boolean",
+          "mutable": true,
+          "attr": "closed",
+          "reflectToAttr": true,
+          "docs": "When true, flow-item will be hidden",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "description",
+          "type": "string",
+          "mutable": false,
+          "attr": "description",
+          "reflectToAttr": false,
+          "docs": "A description for the component.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "disabled",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "disabled",
+          "reflectToAttr": true,
+          "docs": "When true, interaction is prevented and the component is displayed with lower opacity.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "heading",
+          "type": "string",
+          "mutable": false,
+          "attr": "heading",
+          "reflectToAttr": false,
+          "docs": "The component header text.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "headingLevel",
+          "type": "1 | 2 | 3 | 4 | 5 | 6",
+          "mutable": false,
+          "attr": "heading-level",
+          "reflectToAttr": false,
+          "docs": "Specifies the number at which section headings should start.",
+          "docsTags": [],
+          "values": [
+            {
+              "value": "1",
+              "type": "number"
+            },
+            {
+              "value": "2",
+              "type": "number"
+            },
+            {
+              "value": "3",
+              "type": "number"
+            },
+            {
+              "value": "4",
+              "type": "number"
+            },
+            {
+              "value": "5",
+              "type": "number"
+            },
+            {
+              "value": "6",
+              "type": "number"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "heightScale",
+          "type": "\"l\" | \"m\" | \"s\"",
+          "mutable": false,
+          "attr": "height-scale",
+          "reflectToAttr": true,
+          "docs": "Specifies the maximum height of the component.",
+          "docsTags": [],
+          "values": [
+            {
+              "value": "l",
+              "type": "string"
+            },
+            {
+              "value": "m",
+              "type": "string"
+            },
+            {
+              "value": "s",
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "intlBack",
+          "type": "string",
+          "mutable": false,
+          "attr": "intl-back",
+          "reflectToAttr": false,
+          "docs": "Accessible name for the component's back button. The back button will only be shown when 'showBackButton' is true.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "intlClose",
+          "type": "string",
+          "mutable": false,
+          "attr": "intl-close",
+          "reflectToAttr": false,
+          "docs": "Accessible name for the component's close button. The close button will only be shown when 'dismissible' is true.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "intlOptions",
+          "type": "string",
+          "mutable": false,
+          "attr": "intl-options",
+          "reflectToAttr": false,
+          "docs": "Accessible name for the component's actions menu.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "loading",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "loading",
+          "reflectToAttr": true,
+          "docs": "When true, a busy indicator is displayed.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "menuOpen",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "menu-open",
+          "reflectToAttr": true,
+          "docs": "When true, the action menu items in the `header-menu-actions` slot are open.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "showBackButton",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "show-back-button",
+          "reflectToAttr": true,
+          "docs": "When true, displays a back button in the header.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "widthScale",
+          "type": "\"l\" | \"m\" | \"s\"",
+          "mutable": false,
+          "attr": "width-scale",
+          "reflectToAttr": true,
+          "docs": "Specifies the width of the component.",
+          "docsTags": [],
+          "values": [
+            {
+              "value": "l",
+              "type": "string"
+            },
+            {
+              "value": "m",
+              "type": "string"
+            },
+            {
+              "value": "s",
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        }
+      ],
+      "methods": [
+        {
+          "name": "scrollContentTo",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "signature": "scrollContentTo(options?: ScrollToOptions) => Promise<void>",
+          "parameters": [],
+          "docs": "Scrolls the component's content to a specified set of coordinates.\n\n```\n  myCalciteFlowItem.scrollContentTo({\n    left: 0, // Specifies the number of pixels along the X axis to scroll the window or element.\n    top: 0, // Specifies the number of pixels along the Y axis to scroll the window or element\n    behavior: \"auto\" // Specifies whether the scrolling should animate smoothly (smooth), or happen instantly in a single jump (auto, the default value).\n  });\n```",
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "options"
+            }
+          ]
+        },
+        {
+          "name": "setFocus",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "signature": "setFocus() => Promise<void>",
+          "parameters": [],
+          "docs": "Sets focus on the component.",
+          "docsTags": []
+        }
+      ],
+      "events": [
+        {
+          "event": "calciteFlowItemBackClick",
+          "detail": "void",
+          "bubbles": true,
+          "cancelable": false,
+          "composed": true,
+          "docs": "Fires when the back button is clicked.",
+          "docsTags": []
+        }
+      ],
+      "listeners": [],
+      "styles": [],
+      "slots": [
+        {
+          "name": "",
+          "docs": "A slot for adding custom content."
+        },
+        {
+          "name": "fab",
+          "docs": "A slot for adding a `calcite-fab` (floating action button) to perform an action."
+        },
+        {
+          "name": "footer",
+          "docs": "A slot for adding custom content to the footer."
+        },
+        {
+          "name": "footer-actions",
+          "docs": "A slot for adding buttons to the footer."
+        },
+        {
+          "name": "header-actions-end",
+          "docs": "A slot for adding actions or content to the end side of the header."
+        },
+        {
+          "name": "header-actions-start",
+          "docs": "A slot for adding actions or content to the start side of the header."
+        },
+        {
+          "name": "header-content",
+          "docs": "A slot for adding custom content to the header."
+        },
+        {
+          "name": "header-menu-actions",
+          "docs": "A slot for adding an overflow menu with actions inside a `calcite-dropdown`."
+        }
+      ],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [
+        "calcite-action",
+        "calcite-panel"
+      ],
+      "dependencyGraph": {
+        "calcite-flow-item": [
+          "calcite-action",
+          "calcite-panel"
+        ],
+        "calcite-action": [
+          "calcite-loader",
+          "calcite-icon"
+        ],
+        "calcite-panel": [
+          "calcite-action",
+          "calcite-action-menu",
+          "calcite-scrim"
+        ],
+        "calcite-action-menu": [
+          "calcite-action",
+          "calcite-popover"
+        ],
+        "calcite-popover": [
+          "calcite-action",
+          "calcite-icon"
+        ],
+        "calcite-scrim": [
+          "calcite-loader"
+        ]
+      }
+    },
     {
       "filePath": "./src/components/graph/graph.tsx",
       "encapsulation": "shadow",
@@ -9992,7 +10464,7 @@
         },
         {
           "name": "placement",
-          "type": "\"bottom\" | \"bottom-end\" | \"bottom-start\" | \"top\" | \"top-end\" | \"top-start\"",
+          "type": "\"bottom\" | \"bottom-end\" | \"bottom-leading\" | \"bottom-start\" | \"bottom-trailing\" | \"top\" | \"top-end\" | \"top-leading\" | \"top-start\" | \"top-trailing\"",
           "mutable": false,
           "attr": "placement",
           "reflectToAttr": true,
@@ -10013,10 +10485,18 @@
               "value": "bottom-end",
               "type": "string"
             },
+            {
+              "value": "bottom-leading",
+              "type": "string"
+            },
             {
               "value": "bottom-start",
               "type": "string"
             },
+            {
+              "value": "bottom-trailing",
+              "type": "string"
+            },
             {
               "value": "top",
               "type": "string"
@@ -10025,9 +10505,17 @@
               "value": "top-end",
               "type": "string"
             },
+            {
+              "value": "top-leading",
+              "type": "string"
+            },
             {
               "value": "top-start",
               "type": "string"
+            },
+            {
+              "value": "top-trailing",
+              "type": "string"
             }
           ],
           "optional": false,
@@ -14284,7 +14772,13 @@
           "mutable": false,
           "reflectToAttr": false,
           "docs": "When provided, this method will be called before it is removed from the parent flow.",
-          "docsTags": [],
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "use `calcite-flow-item` instead."
+            }
+          ],
+          "deprecation": "use `calcite-flow-item` instead.",
           "values": [
             {
               "type": "() => Promise<void>"
@@ -14491,7 +14985,13 @@
           "attr": "intl-back",
           "reflectToAttr": false,
           "docs": "Accessible name for the component's back button. The back button will only be shown when 'showBackButton' is true.",
-          "docsTags": [],
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "use `calcite-flow-item` instead."
+            }
+          ],
+          "deprecation": "use `calcite-flow-item` instead.",
           "values": [
             {
               "type": "string"
@@ -14573,8 +15073,14 @@
           "attr": "show-back-button",
           "reflectToAttr": true,
           "docs": "When true, displays a back button in the header.",
-          "docsTags": [],
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "use `calcite-flow-item` instead."
+            }
+          ],
           "default": "false",
+          "deprecation": "use `calcite-flow-item` instead.",
           "values": [
             {
               "type": "boolean"
@@ -14654,7 +15160,7 @@
             "type": "Promise<void>",
             "docs": ""
           },
-          "signature": "setFocus(focusId?: \"dismiss-button\" | \"back-button\") => Promise<void>",
+          "signature": "setFocus(focusId?: \"back-button\" | \"dismiss-button\") => Promise<void>",
           "parameters": [],
           "docs": "Sets focus on the component.",
           "docsTags": [
@@ -14673,7 +15179,13 @@
           "cancelable": false,
           "composed": true,
           "docs": "Fires when the back button is clicked.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "use `calcite-flow-item` instead."
+            }
+          ],
+          "deprecation": "use `calcite-flow-item` instead."
         },
         {
           "event": "calcitePanelDismiss",
@@ -14762,7 +15274,9 @@
         }
       ],
       "parts": [],
-      "dependents": [],
+      "dependents": [
+        "calcite-flow-item"
+      ],
       "dependencies": [
         "calcite-action",
         "calcite-action-menu",
@@ -14788,6 +15302,9 @@
         ],
         "calcite-scrim": [
           "calcite-loader"
+        ],
+        "calcite-flow-item": [
+          "calcite-panel"
         ]
       }
     },
@@ -18468,7 +18985,7 @@
       "props": [
         {
           "name": "appearance",
-          "type": "\"clear\" | \"outline\" | \"solid\" | \"transparent\"",
+          "type": "\"clear\" | \"minimal\" | \"outline\" | \"solid\" | \"transparent\"",
           "mutable": false,
           "attr": "appearance",
           "reflectToAttr": true,
@@ -18480,6 +18997,10 @@
               "value": "clear",
               "type": "string"
             },
+            {
+              "value": "minimal",
+              "type": "string"
+            },
             {
               "value": "outline",
               "type": "string"