@getflip/swirl-components 0.116.0 → 0.118.0

package/components.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2023-11-27T14:41:28",
+  "timestamp": "2023-12-01T10:01:54",
   "compiler": {
     "name": "@stencil/core",
     "version": "3.3.1",
@@ -698,6 +698,23 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "closeButtonIcon",
+          "type": "string",
+          "mutable": false,
+          "attr": "close-button-icon",
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "default": "\"<swirl-icon-close></swirl-icon-close>\"",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "closeButtonLabel",
           "type": "string",
@@ -876,23 +893,6 @@
       "docsTags": [],
       "usage": {},
       "props": [
-        {
-          "name": "hideBorder",
-          "type": "boolean",
-          "mutable": false,
-          "attr": "hide-border",
-          "reflectToAttr": false,
-          "docs": "",
-          "docsTags": [],
-          "default": "false",
-          "values": [
-            {
-              "type": "boolean"
-            }
-          ],
-          "optional": true,
-          "required": false
-        },
         {
           "name": "icon",
           "type": "string",
@@ -977,6 +977,10 @@
         {
           "name": "slot",
           "text": "sidebar - Content of the right sidebar"
+        },
+        {
+          "name": "slot",
+          "text": "custom-sidebar-header - Replaces the default sidebar header"
         }
       ],
       "usage": {},
@@ -1274,6 +1278,10 @@
           "name": "custom-app-bar-back-button",
           "docs": "Replaces the mobile default back button of the content app bar"
         },
+        {
+          "name": "custom-sidebar-header",
+          "docs": "Replaces the default sidebar header"
+        },
         {
           "name": "navigation",
           "docs": "The navigation area content"
@@ -2109,7 +2117,7 @@
         },
         {
           "name": "size",
-          "type": "\"m\" | \"s\"",
+          "type": "\"m\" | \"s\" | \"xs\"",
           "mutable": false,
           "attr": "size",
           "reflectToAttr": false,
@@ -2124,6 +2132,10 @@
             {
               "value": "s",
               "type": "string"
+            },
+            {
+              "value": "xs",
+              "type": "string"
             }
           ],
           "optional": true,
@@ -2159,10 +2171,14 @@
       "slots": [],
       "parts": [],
       "dependents": [
+        "swirl-shell-layout",
         "swirl-shell-navigation-item"
       ],
       "dependencies": [],
       "dependencyGraph": {
+        "swirl-shell-layout": [
+          "swirl-badge"
+        ],
         "swirl-shell-navigation-item": [
           "swirl-badge"
         ]
@@ -3336,7 +3352,6 @@
         "swirl-pdf-reader",
         "swirl-resource-list-file-item",
         "swirl-resource-list-item",
-        "swirl-shell-layout",
         "swirl-thumbnail"
       ],
       "dependencies": [],
@@ -3380,9 +3395,6 @@
         "swirl-resource-list-item": [
           "swirl-button"
         ],
-        "swirl-shell-layout": [
-          "swirl-button"
-        ],
         "swirl-thumbnail": [
           "swirl-button"
         ]
@@ -8531,12 +8543,16 @@
       "slots": [],
       "parts": [],
       "dependents": [
-        "swirl-accordion-item"
+        "swirl-accordion-item",
+        "swirl-shell-layout"
       ],
       "dependencies": [],
       "dependencyGraph": {
         "swirl-accordion-item": [
           "swirl-icon"
+        ],
+        "swirl-shell-layout": [
+          "swirl-icon"
         ]
       }
     },
@@ -8920,9 +8936,15 @@
           "docs": ""
         }
       ],
-      "dependents": [],
+      "dependents": [
+        "swirl-shell-layout"
+      ],
       "dependencies": [],
-      "dependencyGraph": {}
+      "dependencyGraph": {
+        "swirl-shell-layout": [
+          "swirl-icon-arrow-back"
+        ]
+      }
     },
     {
       "filePath": "./src/components/swirl-icon/icons/swirl-icon-arrow-downward.tsx",
@@ -9034,9 +9056,15 @@
           "docs": ""
         }
       ],
-      "dependents": [],
+      "dependents": [
+        "swirl-shell-layout"
+      ],
       "dependencies": [],
-      "dependencyGraph": {}
+      "dependencyGraph": {
+        "swirl-shell-layout": [
+          "swirl-icon-arrow-forward"
+        ]
+      }
     },
     {
       "filePath": "./src/components/swirl-icon/icons/swirl-icon-arrow-left.tsx",
@@ -10633,9 +10661,9 @@
       "dependencyGraph": {}
     },
     {
-      "filePath": "./src/components/swirl-icon/icons/swirl-icon-double-arrow-left.tsx",
+      "filePath": "./src/components/swirl-icon/icons/swirl-icon-dock-left.tsx",
       "encapsulation": "shadow",
-      "tag": "swirl-icon-double-arrow-left",
+      "tag": "swirl-icon-dock-left",
       "docs": "",
       "docsTags": [],
       "usage": {},
@@ -10686,6 +10714,66 @@
       "dependencies": [],
       "dependencyGraph": {}
     },
+    {
+      "filePath": "./src/components/swirl-icon/icons/swirl-icon-double-arrow-left.tsx",
+      "encapsulation": "shadow",
+      "tag": "swirl-icon-double-arrow-left",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "size",
+          "type": "16 | 20 | 24 | 28",
+          "mutable": false,
+          "attr": "size",
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "default": "24",
+          "values": [
+            {
+              "value": "16",
+              "type": "number"
+            },
+            {
+              "value": "20",
+              "type": "number"
+            },
+            {
+              "value": "24",
+              "type": "number"
+            },
+            {
+              "value": "28",
+              "type": "number"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [
+        {
+          "name": "icon",
+          "docs": ""
+        }
+      ],
+      "dependents": [
+        "swirl-shell-layout"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "swirl-shell-layout": [
+          "swirl-icon-double-arrow-left"
+        ]
+      }
+    },
     {
       "filePath": "./src/components/swirl-icon/icons/swirl-icon-double-arrow-right.tsx",
       "encapsulation": "shadow",
@@ -10736,9 +10824,15 @@
           "docs": ""
         }
       ],
-      "dependents": [],
+      "dependents": [
+        "swirl-shell-layout"
+      ],
       "dependencies": [],
-      "dependencyGraph": {}
+      "dependencyGraph": {
+        "swirl-shell-layout": [
+          "swirl-icon-double-arrow-right"
+        ]
+      }
     },
     {
       "filePath": "./src/components/swirl-icon/icons/swirl-icon-download.tsx",
@@ -13200,9 +13294,15 @@
           "docs": ""
         }
       ],
-      "dependents": [],
+      "dependents": [
+        "swirl-shell-layout"
+      ],
       "dependencies": [],
-      "dependencyGraph": {}
+      "dependencyGraph": {
+        "swirl-shell-layout": [
+          "swirl-icon-menu"
+        ]
+      }
     },
     {
       "filePath": "./src/components/swirl-icon/icons/swirl-icon-menu-book.tsx",
@@ -18094,6 +18194,22 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "description",
+          "type": "string",
+          "mutable": false,
+          "attr": "description",
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "disabled",
           "type": "boolean",
@@ -21231,42 +21347,50 @@
     },
     {
       "filePath": "./src/components/swirl-shell-layout/swirl-shell-layout.tsx",
-      "encapsulation": "shadow",
+      "encapsulation": "scoped",
       "tag": "swirl-shell-layout",
       "docs": "",
       "docsTags": [
         {
           "name": "slot",
-          "text": "logo-expanded - Logo shown inside expanded sidebar."
+          "text": "logo - Logo shown inside header."
         },
         {
           "name": "slot",
-          "text": "logo-collapsed - Logo shown inside collapsed sidebar."
+          "text": "header-tools - Tools positioned on the header's right-hand side."
         },
         {
           "name": "slot",
-          "text": "tools - Items shown in the upper sidebar part."
+          "text": "mobile-header-tools - Tools positioned in the mobile drawer header."
         },
         {
           "name": "slot",
-          "text": "main-navigation - Items shown in the lower sidebar part."
+          "text": "nav - Items shown in the lower sidebar part."
         },
         {
           "name": "slot",
-          "text": "banner - Used to show a swirl-banner on top of the page."
+          "text": "mobile-logo - Logo shown inside the mobile navigation drawer."
         },
         {
           "name": "slot",
-          "text": "main - Contents of the main area."
+          "text": "default - Contents of the main area."
+        },
+        {
+          "name": "slot",
+          "text": "sidebar-app-bar - Contents of the right sidebar header."
+        },
+        {
+          "name": "slot",
+          "text": "sidebar - Contents of the right sidebar."
         }
       ],
       "usage": {},
       "props": [
         {
-          "name": "hideSidebar",
+          "name": "brandedHeader",
           "type": "boolean",
           "mutable": false,
-          "attr": "hide-sidebar",
+          "attr": "branded-header",
           "reflectToAttr": false,
           "docs": "",
           "docsTags": [],
@@ -21279,10 +21403,61 @@
           "required": false
         },
         {
-          "name": "mainNavigationLabel",
+          "name": "browserBackButtonLabel",
+          "type": "string",
+          "mutable": false,
+          "attr": "browser-back-button-label",
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "default": "\"Navigate back\"",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "browserForwardButtonLabel",
+          "type": "string",
+          "mutable": false,
+          "attr": "browser-forward-button-label",
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "default": "\"Navigate forward\"",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "hideMobileNavigationButtonLabel",
+          "type": "string",
+          "mutable": false,
+          "attr": "hide-mobile-navigation-button-label",
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "default": "\"Close navigation\"",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "navigationLabel",
           "type": "string",
           "mutable": false,
-          "attr": "main-navigation-label",
+          "attr": "navigation-label",
           "reflectToAttr": false,
           "docs": "",
           "docsTags": [],
@@ -21292,7 +21467,89 @@
               "type": "string"
             }
           ],
-          "optional": false,
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "navigationToggleLabel",
+          "type": "string",
+          "mutable": false,
+          "attr": "navigation-toggle-label",
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "default": "\"Toggle navigation\"",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "sidebarActive",
+          "type": "boolean",
+          "mutable": true,
+          "attr": "sidebar-active",
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "sidebarToggleBadge",
+          "type": "string",
+          "mutable": false,
+          "attr": "sidebar-toggle-badge",
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "sidebarToggleBadgeAriaLabel",
+          "type": "string",
+          "mutable": false,
+          "attr": "sidebar-toggle-badge-aria-label",
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "sidebarToggleIcon",
+          "type": "string",
+          "mutable": false,
+          "attr": "sidebar-toggle-icon",
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "default": "\"notifications\"",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": true,
           "required": false
         },
         {
@@ -21309,71 +21566,136 @@
               "type": "string"
             }
           ],
-          "optional": false,
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "skipLinkLabel",
+          "type": "string",
+          "mutable": false,
+          "attr": "skip-link-label",
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "default": "\"Skip to main content\"",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": true,
           "required": false
         }
       ],
       "methods": [
         {
-          "name": "collapseSidebar",
+          "name": "hideMobileNavigation",
           "returns": {
             "type": "Promise<void>",
             "docs": ""
           },
-          "signature": "collapseSidebar() => Promise<void>",
+          "signature": "hideMobileNavigation() => Promise<void>",
           "parameters": [],
-          "docs": "Collapse the left sidebar.",
+          "docs": "Hides the mobile navigation.",
           "docsTags": []
         },
         {
-          "name": "extendSidebar",
+          "name": "showMobileNavigation",
           "returns": {
             "type": "Promise<void>",
             "docs": ""
           },
-          "signature": "extendSidebar() => Promise<void>",
+          "signature": "showMobileNavigation() => Promise<void>",
           "parameters": [],
-          "docs": "Extend the left sidebar.",
+          "docs": "Opens the mobile navigation.",
           "docsTags": []
         }
       ],
-      "events": [],
-      "listeners": [],
+      "events": [
+        {
+          "event": "sidebarToggleClick",
+          "detail": "MouseEvent",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "",
+          "docsTags": []
+        },
+        {
+          "event": "skipLinkClick",
+          "detail": "MouseEvent",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "",
+          "docsTags": []
+        }
+      ],
+      "listeners": [
+        {
+          "event": "keydown",
+          "target": "window",
+          "capture": false,
+          "passive": false
+        }
+      ],
       "styles": [],
       "slots": [
         {
-          "name": "banner",
-          "docs": "Used to show a swirl-banner on top of the page."
+          "name": "default",
+          "docs": "Contents of the main area."
         },
         {
-          "name": "logo-collapsed",
-          "docs": "Logo shown inside collapsed sidebar."
+          "name": "header-tools",
+          "docs": "Tools positioned on the header's right-hand side."
         },
         {
-          "name": "logo-expanded",
-          "docs": "Logo shown inside expanded sidebar."
+          "name": "logo",
+          "docs": "Logo shown inside header."
         },
         {
-          "name": "main",
-          "docs": "Contents of the main area."
+          "name": "mobile-header-tools",
+          "docs": "Tools positioned in the mobile drawer header."
         },
         {
-          "name": "main-navigation",
+          "name": "mobile-logo",
+          "docs": "Logo shown inside the mobile navigation drawer."
+        },
+        {
+          "name": "nav",
           "docs": "Items shown in the lower sidebar part."
         },
         {
-          "name": "tools",
-          "docs": "Items shown in the upper sidebar part."
+          "name": "sidebar",
+          "docs": "Contents of the right sidebar."
+        },
+        {
+          "name": "sidebar-app-bar",
+          "docs": "Contents of the right sidebar header."
         }
       ],
       "parts": [],
       "dependents": [],
       "dependencies": [
-        "swirl-button"
+        "swirl-icon-menu",
+        "swirl-icon-double-arrow-left",
+        "swirl-icon-double-arrow-right",
+        "swirl-visually-hidden",
+        "swirl-icon-arrow-back",
+        "swirl-icon-arrow-forward",
+        "swirl-icon",
+        "swirl-badge"
       ],
       "dependencyGraph": {
         "swirl-shell-layout": [
-          "swirl-button"
+          "swirl-icon-menu",
+          "swirl-icon-double-arrow-left",
+          "swirl-icon-double-arrow-right",
+          "swirl-visually-hidden",
+          "swirl-icon-arrow-back",
+          "swirl-icon-arrow-forward",
+          "swirl-icon",
+          "swirl-badge"
         ]
       }
     },
@@ -27864,7 +28186,7 @@
     },
     {
       "filePath": "./src/components/swirl-visually-hidden/swirl-visually-hidden.tsx",
-      "encapsulation": "shadow",
+      "encapsulation": "scoped",
       "tag": "swirl-visually-hidden",
       "docs": "",
       "docsTags": [],
@@ -27882,6 +28204,7 @@
         "swirl-pagination",
         "swirl-radio",
         "swirl-resource-list",
+        "swirl-shell-layout",
         "swirl-spinner",
         "swirl-switch",
         "swirl-table",
@@ -27904,6 +28227,9 @@
         "swirl-resource-list": [
           "swirl-visually-hidden"
         ],
+        "swirl-shell-layout": [
+          "swirl-visually-hidden"
+        ],
         "swirl-spinner": [
           "swirl-visually-hidden"
         ],