@oiz/stzh-components 2.1.0-beta → 2.2.0-beta

package/dist/vscode-data.json

@@ -109,6 +109,9 @@
           "name": "variant",
           "description": "Variant determining what position the action buttons are",
           "values": [
+            {
+              "name": "cta"
+            },
             {
               "name": "dialog"
             },
@@ -230,7 +233,7 @@
       "name": "stzh-anchornav",
       "description": {
         "kind": "markdown",
-        "value": "The STZH anchornav component.\n\n```html\n<stzh-anchornav\n  items='[\n    {\n      \"label\": \"Laboris laborum aute id laboris culpa esse aliquip nisi anim velit. Minim sunt eiusmod do laborum amet ut magna. Labore dolore id nostrud enim Lorem pariatur ad dolore id eiusmod adipisicing laboris laborum minim. Reprehenderit deserunt ut occaecat sit sit ullamco laborum deserunt. Eu pariatur est exercitation ea ut tempor laborum. Amet veniam consectetur cupidatat Lorem eu ipsum.\",\n      \"href\": \"#laboris\"\n    },\n    {\n      \"label\": \"Lorem Ipsum\",\n      \"href\": \"#lorem\"\n    },\n    {\n      \"label\": \"Lorem Ipsum\",\n      \"href\": \"#lorem\"\n    },\n    {\n      \"label\": \"Lorem Ipsum\",\n      \"href\": \"#lorem\"\n    },\n    {\n      \"label\": \"Lorem Ipsum\",\n      \"href\": \"#lorem\"\n    },\n    {\n      \"label\": \"Lorem Ipsum\",\n      \"href\": \"#lorem\"\n    },\n    {\n      \"label\": \"Lorem Ipsum\",\n      \"href\": \"#lorem\"\n    }\n  ]'\n></stzh-anchornav>\n```"
+        "value": "The STZH anchornav component.\n<mark>Beta version, do not use in production yet.</mark>\n\n```html\n<stzh-anchornav\n  items='[\n    {\n      \"label\": \"Laboris laborum aute id laboris culpa esse aliquip nisi anim velit. Minim sunt eiusmod do laborum amet ut magna. Labore dolore id nostrud enim Lorem pariatur ad dolore id eiusmod adipisicing laboris laborum minim. Reprehenderit deserunt ut occaecat sit sit ullamco laborum deserunt. Eu pariatur est exercitation ea ut tempor laborum. Amet veniam consectetur cupidatat Lorem eu ipsum.\",\n      \"href\": \"#laboris\"\n    },\n    {\n      \"label\": \"Lorem Ipsum\",\n      \"href\": \"#lorem\"\n    },\n    {\n      \"label\": \"Lorem Ipsum\",\n      \"href\": \"#lorem\"\n    },\n    {\n      \"label\": \"Lorem Ipsum\",\n      \"href\": \"#lorem\"\n    },\n    {\n      \"label\": \"Lorem Ipsum\",\n      \"href\": \"#lorem\"\n    },\n    {\n      \"label\": \"Lorem Ipsum\",\n      \"href\": \"#lorem\"\n    },\n    {\n      \"label\": \"Lorem Ipsum\",\n      \"href\": \"#lorem\"\n    }\n  ]'\n></stzh-anchornav>\n```"
       },
       "attributes": [
         {
@@ -341,7 +344,7 @@
       "name": "stzh-audio",
       "description": {
         "kind": "markdown",
-        "value": "The STZH audio component.\n\nInternally, the [`vidstack` library](https://www.vidstack.io/) is used."
+        "value": "The STZH audio component.\n<mark>Beta version, do not use in production yet.</mark>\n\nInternally, the [`vidstack` library](https://www.vidstack.io/) is used."
       },
       "attributes": [
         {
@@ -414,10 +417,18 @@
         "value": "The STZH button component."
       },
       "attributes": [
+        {
+          "name": "a11y-controls",
+          "description": "Aria controls of link/button"
+        },
         {
           "name": "a11y-describedby",
           "description": "Id for element which describes the button (this will be overwritten if description prop or slot is used, used by stzh-radiogroup)"
         },
+        {
+          "name": "a11y-expanded",
+          "description": "Aria expanded of link/button"
+        },
         {
           "name": "a11y-label",
           "description": "Accessible label for screen readers to replace visible text"
@@ -475,6 +486,10 @@
           "name": "disabled",
           "description": "Whether the button is disabled"
         },
+        {
+          "name": "download",
+          "description": "Download attribute of link (if `href` used)"
+        },
         {
           "name": "effect",
           "description": "Effect/Animation used",
@@ -519,10 +534,18 @@
           "name": "label",
           "description": "Label"
         },
+        {
+          "name": "link-accesskey",
+          "description": "Access key of link (usually a number e.g. 1)"
+        },
         {
           "name": "name",
           "description": "The name of the input element (if type is radio)"
         },
+        {
+          "name": "rel",
+          "description": "Rel (if href is used)"
+        },
         {
           "name": "size",
           "description": "Size variant",
@@ -663,7 +686,7 @@
         },
         {
           "name": "heading",
-          "description": "Heading"
+          "description": "Heading (or use heading slot instead)"
         },
         {
           "name": "hide-footer-border",
@@ -677,6 +700,10 @@
           "name": "hide-movement-actions",
           "description": "Whether movement menu items should be shown.\nHas no effect if card is not inside a `card-list` element, which has `sortableEnabled` property set to true."
         },
+        {
+          "name": "href",
+          "description": "Href of card"
+        },
         {
           "name": "name",
           "description": "The name of the input element (if card is selectable)"
@@ -705,6 +732,10 @@
           "name": "subtitle-interactive",
           "description": "Whether subtitle should be rendered as button and event `stzhSubtitleClick` executed on click"
         },
+        {
+          "name": "target",
+          "description": "target if the button is used as link (if href used)"
+        },
         {
           "name": "value",
           "description": "The value of the input element (if card is selectable)"
@@ -718,6 +749,22 @@
         "value": "The STZH card list component."
       },
       "attributes": [
+        {
+          "name": "description",
+          "description": "Description message (use description slot as alternative)"
+        },
+        {
+          "name": "layout",
+          "description": "",
+          "values": [
+            {
+              "name": "fullwidth"
+            },
+            {
+              "name": "subpages"
+            }
+          ]
+        },
         {
           "name": "show-toggle-link",
           "description": "Whether collapse/expand toggle link"
@@ -812,6 +859,19 @@
         }
       ]
     },
+    {
+      "name": "stzh-chart",
+      "description": {
+        "kind": "markdown",
+        "value": "The STZH chart component.\n\nUses the [`sszvis` chart library](https://statistikstadtzuerich.github.io/sszvis/)."
+      },
+      "attributes": [
+        {
+          "name": "chart-id",
+          "description": "Chart id"
+        }
+      ]
+    },
     {
       "name": "stzh-checkbox",
       "description": {
@@ -962,12 +1022,12 @@
           "description": "Disabled"
         },
         {
-          "name": "icon",
-          "description": "Icon (use instead of icon slot)"
+          "name": "href",
+          "description": "`href` if the chip should be used as link"
         },
         {
-          "name": "invert",
-          "description": "Invert (only available for tag variant)"
+          "name": "icon",
+          "description": "Icon (use instead of icon slot)"
         },
         {
           "name": "label",
@@ -993,6 +1053,10 @@
             }
           ]
         },
+        {
+          "name": "target",
+          "description": "Target if the button is used as link (if `href` used)"
+        },
         {
           "name": "type",
           "description": "Type",
@@ -1029,7 +1093,7 @@
       "name": "stzh-chip-select",
       "description": {
         "kind": "markdown",
-        "value": "The STZH figure component."
+        "value": "The STZH chipselect component."
       },
       "attributes": [
         {
@@ -1038,7 +1102,7 @@
         },
         {
           "name": "data",
-          "description": "Data"
+          "description": "The list of chips"
         },
         {
           "name": "description",
@@ -1050,7 +1114,7 @@
         },
         {
           "name": "disabled",
-          "description": "Whether the element is disabled or not"
+          "description": "Whether all chips are disabled or not"
         },
         {
           "name": "error",
@@ -1082,7 +1146,7 @@
       "name": "stzh-clamp",
       "description": {
         "kind": "markdown",
-        "value": "The STZH clamp component.\n\n```html\n<stzh-clamp>Long text to clamp</stzh-clamp>\n```"
+        "value": "The STZH clamp component.\n<mark>Beta version, do not use in production yet.</mark>\n\n```html\n<stzh-clamp>Long text to clamp</stzh-clamp>\n```"
       },
       "attributes": [
         {
@@ -1107,6 +1171,87 @@
         }
       ]
     },
+    {
+      "name": "stzh-contactaddress",
+      "description": {
+        "kind": "markdown",
+        "value": "The STZH contactaddress component.\n<mark>Beta version, do not use in production yet.</mark>"
+      },
+      "attributes": [
+        {
+          "name": "availability",
+          "description": "Availability times"
+        },
+        {
+          "name": "availability-title",
+          "description": "Availability title"
+        },
+        {
+          "name": "heading",
+          "description": "Heading"
+        },
+        {
+          "name": "location",
+          "description": "Location / city"
+        },
+        {
+          "name": "main-heading",
+          "description": "Main heading"
+        },
+        {
+          "name": "name",
+          "description": "Name"
+        },
+        {
+          "name": "numbers",
+          "description": "Numbers\nArray of objects that can include the attributes `type` = `tel`|`fax`, `label` and `number`."
+        },
+        {
+          "name": "po-box-heading",
+          "description": "Post office box heading"
+        },
+        {
+          "name": "pobox-location",
+          "description": "Post office box location / city"
+        },
+        {
+          "name": "pobox-postal-code",
+          "description": "Post office box postal code"
+        },
+        {
+          "name": "pobox-title",
+          "description": "Post office box title"
+        },
+        {
+          "name": "postal-code",
+          "description": "Postal code"
+        },
+        {
+          "name": "street",
+          "description": "Street"
+        },
+        {
+          "name": "street-info",
+          "description": "Additional street info"
+        },
+        {
+          "name": "type",
+          "description": "Type",
+          "values": [
+            {
+              "name": "Organization"
+            },
+            {
+              "name": "Person"
+            }
+          ]
+        },
+        {
+          "name": "with-border",
+          "description": "Whether to display border or not"
+        }
+      ]
+    },
     {
       "name": "stzh-container",
       "description": {
@@ -1130,6 +1275,18 @@
         "value": "The STZH datalist component."
       },
       "attributes": [
+        {
+          "name": "current-direction",
+          "description": "Current direction in use (readonly)",
+          "values": [
+            {
+              "name": "horizontal"
+            },
+            {
+              "name": "vertical"
+            }
+          ]
+        },
         {
           "name": "direction",
           "description": "Direction",
@@ -1208,7 +1365,72 @@
         },
         {
           "name": "items",
-          "description": "Items in datalist\nArray of objects that must at least include `value` attribute.\nCan optionally contain `label`, `meta`, `icon`, `href` attribute:\n`[{\"value\":\"Value 1\", \"label\": \"Label 1\"}, {\"value\":\"Value 2\", \"label\": \"Label 2\"}]`"
+          "description": "Items in datalist\nArray of objects that must at least include `value` attribute.\nCan optionally contain `label`, `meta`, `icon`, `href` attribute and be nested to display deeper levels:\n`[{\"value\":\"Value 1\", \"label\": \"Label 1\"}, {\"value\":\"Value 2\", \"label\": \"Label 2\", \"items\": [...]}]`"
+        }
+      ]
+    },
+    {
+      "name": "stzh-datalist-item",
+      "description": {
+        "kind": "markdown",
+        "value": "The STZH datalist component."
+      },
+      "attributes": [
+        {
+          "name": "a11y-controls",
+          "description": "Aria controls of link/button"
+        },
+        {
+          "name": "a11y-expanded",
+          "description": "Aria expanded of link/button"
+        },
+        {
+          "name": "direction",
+          "description": "Direction",
+          "values": [
+            {
+              "name": "horizontal"
+            },
+            {
+              "name": "vertical"
+            }
+          ]
+        },
+        {
+          "name": "download",
+          "description": "Download attribute of link (if `href` used)"
+        },
+        {
+          "name": "hide-border",
+          "description": "Hide border lines"
+        },
+        {
+          "name": "href",
+          "description": "Link"
+        },
+        {
+          "name": "icon",
+          "description": "Icon of action button (if href is used, will only be for presentation and default to link icon)"
+        },
+        {
+          "name": "label",
+          "description": "Label"
+        },
+        {
+          "name": "meta",
+          "description": "Meta"
+        },
+        {
+          "name": "rel",
+          "description": "Rel (if href is used)"
+        },
+        {
+          "name": "target",
+          "description": "Target (if href is used)"
+        },
+        {
+          "name": "value",
+          "description": "Value"
         }
       ]
     },
@@ -1409,6 +1631,19 @@
         }
       ]
     },
+    {
+      "name": "stzh-details",
+      "description": {
+        "kind": "markdown",
+        "value": "The STZH details item component.\n<mark>Beta version, do not use in production yet.</mark>\n\nFor revealing more content when trigger element is clicked.\nSets `aria-expanded` and `aria-controls` attribute to the trigger element."
+      },
+      "attributes": [
+        {
+          "name": "open",
+          "description": "Whether fold is open"
+        }
+      ]
+    },
     {
       "name": "stzh-dialog",
       "description": {
@@ -1782,6 +2017,10 @@
               "name": "egov"
             }
           ]
+        },
+        {
+          "name": "with-border",
+          "description": "Whether to display separation border"
         }
       ]
     },
@@ -1804,6 +2043,10 @@
           "name": "hidden-title",
           "description": "Overwrite hidden h1 title"
         },
+        {
+          "name": "hide-close",
+          "description": "Hide close button"
+        },
         {
           "name": "main-title",
           "description": "Main title"
@@ -1825,9 +2068,17 @@
           "name": "href",
           "description": "Portal link (for logo)"
         },
+        {
+          "name": "metabar-stay",
+          "description": "Whether grey metabar should stay (on top) on mobile"
+        },
         {
           "name": "prevent-appnav-placeholder",
           "description": "Prevent creating a appnav placeholder element\nwith the size of appnav inside header parent element.\nThis prevents the fixed appnav to overlap\ncontent at the end on mikro breakpoint,\nbut could lead to problems with certain layouts."
+        },
+        {
+          "name": "sticky-disabled",
+          "description": "Whether sticky behaviour should be disabled"
         }
       ]
     },
@@ -2427,6 +2678,39 @@
         }
       ]
     },
+    {
+      "name": "stzh-langnav",
+      "description": {
+        "kind": "markdown",
+        "value": "The STZH langnav component.\n<mark>Beta version, do not use in production yet.</mark>"
+      },
+      "attributes": [
+        {
+          "name": "language-active",
+          "description": "Active language of langnav"
+        },
+        {
+          "name": "languages",
+          "description": "Available language in langnav"
+        },
+        {
+          "name": "popover-placement",
+          "description": "Popover placement",
+          "values": [
+            {
+              "name": "bottom"
+            },
+            {
+              "name": "top"
+            }
+          ]
+        },
+        {
+          "name": "prevent-urlchange",
+          "description": "Whether to prevent the default behaviour of changing the `location.href`"
+        }
+      ]
+    },
     {
       "name": "stzh-link",
       "description": {
@@ -2434,6 +2718,22 @@
         "value": "The STZH link component."
       },
       "attributes": [
+        {
+          "name": "a11y-controls",
+          "description": "Aria controls of link/button"
+        },
+        {
+          "name": "a11y-describedby",
+          "description": "Id for element which describes the button (this will be overwritten if description prop or slot is used, used by stzh-radiogroup)"
+        },
+        {
+          "name": "a11y-expanded",
+          "description": "Aria expanded of link/button"
+        },
+        {
+          "name": "a11y-label",
+          "description": "Accessible label for screen readers to replace visible text"
+        },
         {
           "name": "active",
           "description": "Active status"
@@ -2483,6 +2783,10 @@
           "name": "disabled",
           "description": "Disabled status"
         },
+        {
+          "name": "download",
+          "description": "Download attribute of link (if `href` used)"
+        },
         {
           "name": "fullwidth",
           "description": "Whether the link is full width"
@@ -2519,6 +2823,10 @@
           "name": "link-accesskey",
           "description": "Access key of link (usually a number e.g. 1)"
         },
+        {
+          "name": "rel",
+          "description": "Rel (if href is used)"
+        },
         {
           "name": "size",
           "description": "Size variant",
@@ -2795,11 +3103,32 @@
       },
       "attributes": []
     },
+    {
+      "name": "stzh-microsite-teaserlist",
+      "description": {
+        "kind": "markdown",
+        "value": "The STZH microsite teaserlist component.\n<mark>Beta version, do not use in production yet.</mark>"
+      },
+      "attributes": [
+        {
+          "name": "api",
+          "description": "API URL (`{lang}` is replaced in the URL)"
+        },
+        {
+          "name": "step-items",
+          "description": "Numbers of item shown with each load more action"
+        },
+        {
+          "name": "tags",
+          "description": "Tags"
+        }
+      ]
+    },
     {
       "name": "stzh-olmap",
       "description": {
         "kind": "markdown",
-        "value": "The STZH olmap component."
+        "value": "The STZH olmap component.\n<mark>Beta version, do not use in production yet.</mark>"
       },
       "attributes": [
         {
@@ -2873,7 +3202,7 @@
       "name": "stzh-pagebottom",
       "description": {
         "kind": "markdown",
-        "value": "The STZH pagebottom component."
+        "value": "The STZH pagebottom component.\n<mark>Beta version, do not use in production yet.</mark>"
       },
       "attributes": [
         {
@@ -2910,6 +3239,27 @@
       },
       "attributes": []
     },
+    {
+      "name": "stzh-pagetitle-hero",
+      "description": {
+        "kind": "markdown",
+        "value": "The STZH pagetitle hero component.\n<mark>Beta version, do not use in production yet.</mark>"
+      },
+      "attributes": [
+        {
+          "name": "heading",
+          "description": "Heading"
+        },
+        {
+          "name": "lead-author",
+          "description": "Lead author"
+        },
+        {
+          "name": "subtitle",
+          "description": "Subtitle"
+        }
+      ]
+    },
     {
       "name": "stzh-popover",
       "description": {
@@ -3407,7 +3757,7 @@
       "name": "stzh-share",
       "description": {
         "kind": "markdown",
-        "value": "The STZH share component.\n\nEnables sharing the current page on different social networks or by email."
+        "value": "The STZH share component.\n<mark>Beta version, do not use in production yet.</mark>\n\nEnables sharing the current page on different social networks or by email."
       },
       "attributes": [
         {
@@ -3420,6 +3770,19 @@
         }
       ]
     },
+    {
+      "name": "stzh-sitemap",
+      "description": {
+        "kind": "markdown",
+        "value": "The STZH sitemap component.\n<mark>Beta version, do not use in production yet.</mark>"
+      },
+      "attributes": [
+        {
+          "name": "items",
+          "description": "Items in sitemap\nArray of objects that must at least include `value` attribute.\nCan optionally contain `label`, `meta`, `icon`, `href` attribute and be nested to display deeper levels:\n`[{\"value\":\"Value 1\", \"label\": \"Label 1\"}, {\"value\":\"Value 2\", \"label\": \"Label 2\", \"items\": [...]}]`"
+        }
+      ]
+    },
     {
       "name": "stzh-skiplink",
       "description": {
@@ -3508,7 +3871,7 @@
       "name": "stzh-sticky",
       "description": {
         "kind": "markdown",
-        "value": "The STZH sticky component.\n\nMakes slotted content sticky with help of `position: sticky` and adds additional events when element gets stucked. To make it work, parent elements are not allowed to have a overflow set to `auto`, `hidden` or `scroll`.\n\nWhen element is stuck `is-stuck` attribute will be added to the host element. Additionally `is-stuck-top` or `is-stuck-bottom` will be added."
+        "value": "The STZH sticky component.\n<mark>Beta version, do not use in production yet.</mark>\n\nMakes slotted content sticky with help of `position: sticky` and adds additional events when element gets stucked. To make it work, parent elements are not allowed to have a overflow set to `auto`, `hidden` or `scroll`.\n\nWhen element is stuck `is-stuck` attribute will be added to the host element. Additionally `is-stuck-top` or `is-stuck-bottom` will be added."
       },
       "attributes": [
         {
@@ -3845,6 +4208,34 @@
         }
       ]
     },
+    {
+      "name": "stzh-textandimage",
+      "description": {
+        "kind": "markdown",
+        "value": "The STZH textandimage component.\n<mark>Beta version, do not use in production yet.</mark>"
+      },
+      "attributes": [
+        {
+          "name": "floating",
+          "description": "Whether to float left content"
+        },
+        {
+          "name": "size",
+          "description": "Size variant",
+          "values": [
+            {
+              "name": "default"
+            },
+            {
+              "name": "large"
+            },
+            {
+              "name": "small"
+            }
+          ]
+        }
+      ]
+    },
     {
       "name": "stzh-toggle",
       "description": {
@@ -4152,15 +4543,15 @@
             {
               "name": "2"
             },
-            {
-              "name": "3"
-            },
             {
               "name": "4"
             },
             {
               "name": "5"
             },
+            {
+              "name": "3"
+            },
             {
               "name": "6"
             },
@@ -4708,7 +5099,7 @@
       "attributes": [
         {
           "name": "api",
-          "description": "API URL(`{lang}` are replaced in the URL)"
+          "description": "API URL (`{lang}` is replaced in the URL)"
         },
         {
           "name": "data",
@@ -4733,7 +5124,7 @@
       "attributes": [
         {
           "name": "api",
-          "description": "API URL(`{lang}` are replaced in the URL)"
+          "description": "API URL (`{lang}` is replaced in the URL)"
         },
         {
           "name": "data",