@oiz/stzh-components 2.1.0 → 2.2.0

package/dist/types/index.d.ts

@@ -126,6 +126,10 @@ export declare type StzhCardCollapseEvent = {
   component: "stzh-card";
   collapsed: boolean;
 };
+export declare type StzhCardClickEvent = {
+  component: "stzh-card";
+  originalEvent: MouseEvent;
+};
 export declare type StzhCardStarClickEvent = {
   component: "stzh-card";
   starred: boolean;
@@ -134,6 +138,18 @@ export declare type StzhCardHeaderActionClickEvent = {
   component: "stzh-card";
   action: StzhCardHeaderAction;
 };
+export declare type StzhMicrositeTeaserlistTag = {
+  id: string;
+  name: string;
+};
+export declare type StzhMicrositeTeaserlistItem = {
+  title?: string;
+  description?: string;
+  image?: string;
+  link: string;
+  tags: string[];
+  teaserid: string;
+};
 export declare type StzhCardListCollapseAllEvent = {
   component: "stzh-card-list";
   allCollapsed: boolean;
@@ -220,11 +236,21 @@ export declare type StzhDatalistItemEntry = {
   meta?: string;
   icon?: string;
   href?: string;
+  rel?: string;
+  target?: string;
+  items?: StzhDatalistItemEntry[];
 };
-export declare type StzhDatalistItemActionClickEvent = {
+export declare type StzhDatalistDirectionChangeEvent = {
   component: "stzh-datalist";
+  value: "vertical" | "horizontal";
+};
+export declare type StzhDatalistHideBorderChangeEvent = {
+  component: "stzh-datalist";
+  value: boolean;
+};
+export declare type StzhDatalistItemActionClickEvent = {
+  component: "stzh-datalist-item";
   originalEvent: MouseEvent;
-  item: StzhDatalistItemEntry;
 };
 export declare type StzhDatamessagelistItemEntryMeta = {
   label: string;
@@ -281,6 +307,47 @@ export declare type StzhChipBlurEvent = {
   component: "stzh-chip";
   originalEvent: FocusEvent;
 };
+export declare type StzhVbzMajortickerDisturbance = {
+  id: string;
+  head: string;
+  text: string;
+  startDate: Date;
+  endDate: Date;
+  altStart: string;
+  altEnd: string;
+  infoUrl?: VbzTickerInfoUrl;
+};
+export declare type StzhVbzMajortickerDisturbanceFetchedEvent = {
+  component: "stzh-vbz-majorticker";
+  disturbance: StzhVbzMajortickerDisturbance | null;
+};
+export declare type VbzTickerInfoUrl = {
+  name: string;
+  url: string;
+};
+export declare type VbzTickerDisturbance = {
+  id: string;
+  head: string;
+  startDate: Date;
+  endDate: Date;
+  altStart: string;
+  altEnd: string;
+  baseType?: string;
+  infoUrl?: VbzTickerInfoUrl;
+  category: typeof VBZ.DISTURBANCE_INFORMATION | typeof VBZ.DISTURBANCE_CONSTRUCTION | typeof VBZ.DISTURBANCE_NORMAL | typeof VBZ.DISTURBANCE_EVENT | typeof VBZ.DISTURBANCE_BUS;
+};
+export declare type VbzTickerLine = {
+  line: VBZ.Lines;
+  name: string;
+  disturbances: VbzTickerDisturbance[];
+  alert: boolean;
+  category: "2" | "16" | "32" | "64" | "128" | "256" | "512";
+};
+export declare type StzhVbzLinechipLine = {
+  color: string;
+  background: string;
+  comment?: string;
+};
 export declare type StzhVbzLinechipFocusEvent = {
   component: "stzh-vbz-linechip";
   originalEvent: FocusEvent;
@@ -300,6 +367,10 @@ export declare type ContactaddressNumber = {
   label: string;
   number: string;
 };
+export declare type StzhContactaddressAvailabilityItem = {
+  weekday: string;
+  hours: string[];
+};
 export declare type StzhOverlayOpenEvent = {
   component: "stzh-overlay";
 };
@@ -381,6 +452,10 @@ export declare type StzhRadioBlurEvent = {
   component: "stzh-radio";
   originalEvent: FocusEvent;
 };
+export declare type StzhLangnavChangeEvent = {
+  component: "stzh-langnav";
+  value: string;
+};
 export declare type StzhDropdownChangeEvent = {
   component: "stzh-dropdown";
   value: string;
@@ -542,6 +617,15 @@ export declare namespace Font {
   type Curves = "p1" | "p2" | "caption" | "h4" | "h3" | "h2" | "h1" | "hero" | "default";
 }
 export declare namespace VBZ {
+  const BASE_TYPE_GLOBAL = "GLOBAL";
+  const CHANNEL_TICKER = "ticker";
+  const CHANNEL_INFO_URL_FILTER = "stadt-zuerich.ch/vbz";
+  const DISTURBANCE_GLOBAL = "__global__";
+  const DISTURBANCE_INFORMATION = "0";
+  const DISTURBANCE_CONSTRUCTION = "1";
+  const DISTURBANCE_NORMAL = "2";
+  const DISTURBANCE_EVENT = "4";
+  const DISTURBANCE_BUS = "5";
   type Lines = "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "10" | "11" | "12" | "13" | "14" | "15" | "16" | "17" | "19" | "20" | "21" | "23" | "24" | "25" | "29" | "31" | "32" | "33" | "34" | "35" | "36" | "37" | "38" | "39" | "40" | "45" | "46" | "54" | "61" | "62" | "63" | "64" | "66" | "67" | "69" | "70" | "72" | "73" | "75" | "76" | "77" | "78" | "79" | "80" | "83" | "89" | "91" | "94" | "95" | "99" | "151" | "152" | "153" | "156" | "161" | "162" | "163" | "165" | "184" | "185" | "200" | "201" | "215" | "220" | "235" | "236" | "245" | "301" | "302" | "303" | "304" | "305" | "306" | "307" | "308" | "309" | "311" | "314" | "315" | "317" | "321" | "323" | "325" | "350" | "444" | "445" | "701" | "702" | "703" | "704" | "705" | "720" | "721" | "725" | "726" | "727" | "742" | "743" | "744" | "745" | "747" | "748" | "751" | "752" | "753" | "754" | "759" | "760" | "765" | "768" | "781" | "786" | "787" | "910" | "912" | "916" | "917" | "918" | "919" | "E" | "N" | "N1" | "N2" | "N4" | "N5" | "N6" | "N7" | "N8" | "N9" | "N10" | "N11" | "N12" | "N13" | "N14" | "N15" | "N16" | "N17" | "N18" | "N19" | "N30" | "N31" | "N32" | "N33" | "N34" | "N45" | "N72" | "N78" | "SN1" | "SN4" | "SN5" | "SN6" | "SN7" | "SN8" | "SN9" | "S2" | "S3" | "S4" | "S5" | "S6" | "S7" | "S8" | "S9" | "S10" | "S11" | "S14" | "S15" | "S16" | "S18" | "S19" | "S20" | "S21" | "S23" | "S24" | "S25";
 }
 export * from './components';

package/dist/vscode-data.json

@@ -417,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"
@@ -526,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",
@@ -670,7 +686,7 @@
         },
         {
           "name": "heading",
-          "description": "Heading"
+          "description": "Heading (or use heading slot instead)"
         },
         {
           "name": "hide-footer-border",
@@ -684,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)"
@@ -712,9 +732,17 @@
           "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)"
+        },
+        {
+          "name": "with-arrow",
+          "description": "Whether card arrow is shown in footer area"
         }
       ]
     },
@@ -725,6 +753,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"
@@ -823,13 +867,9 @@
       "name": "stzh-chart",
       "description": {
         "kind": "markdown",
-        "value": "The STZH chart component.\n<mark>Beta version, do not use in production yet.</mark>\n\nUses the [`sszvis` chart library](https://statistikstadtzuerich.github.io/sszvis/)."
+        "value": "The STZH chart component.\n\nUses the [`sszvis` chart library](https://statistikstadtzuerich.github.io/sszvis/)."
       },
       "attributes": [
-        {
-          "name": "caption",
-          "description": "Caption"
-        },
         {
           "name": "chart-id",
           "description": "Chart id"
@@ -967,12 +1007,16 @@
       "attributes": [
         {
           "name": "a11y-describedby",
-          "description": "Id for element which describes the button"
+          "description": "Id for element which describes the link/button"
         },
         {
           "name": "a11y-label",
           "description": "Accessible label for screen readers to replace visible text"
         },
+        {
+          "name": "a11y-tabindex",
+          "description": "Tabindex of link/button"
+        },
         {
           "name": "active",
           "description": "Active"
@@ -1057,7 +1101,7 @@
       "name": "stzh-chip-select",
       "description": {
         "kind": "markdown",
-        "value": "The STZH figure component."
+        "value": "The STZH chipselect component."
       },
       "attributes": [
         {
@@ -1066,7 +1110,7 @@
         },
         {
           "name": "data",
-          "description": "Data"
+          "description": "The list of chips"
         },
         {
           "name": "description",
@@ -1078,7 +1122,7 @@
         },
         {
           "name": "disabled",
-          "description": "Whether the element is disabled or not"
+          "description": "Whether all chips are disabled or not"
         },
         {
           "name": "error",
@@ -1143,8 +1187,12 @@
       },
       "attributes": [
         {
-          "name": "company",
-          "description": "Company Title"
+          "name": "availability",
+          "description": "Availability times"
+        },
+        {
+          "name": "availability-title",
+          "description": "Availability title"
         },
         {
           "name": "heading",
@@ -1154,6 +1202,10 @@
           "name": "location",
           "description": "Location / city"
         },
+        {
+          "name": "main-heading",
+          "description": "Main heading"
+        },
         {
           "name": "name",
           "description": "Name"
@@ -1231,6 +1283,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",
@@ -1309,7 +1373,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"
         }
       ]
     },
@@ -1510,6 +1639,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": {
@@ -1909,6 +2051,10 @@
           "name": "hidden-title",
           "description": "Overwrite hidden h1 title"
         },
+        {
+          "name": "hide-close",
+          "description": "Hide close button"
+        },
         {
           "name": "main-title",
           "description": "Main title"
@@ -1930,9 +2076,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"
         }
       ]
     },
@@ -2532,6 +2686,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": {
@@ -2539,6 +2726,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"
@@ -2628,6 +2831,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",
@@ -2904,6 +3111,27 @@
       },
       "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": {
@@ -3550,6 +3778,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": {
@@ -3975,6 +4216,38 @@
         }
       ]
     },
+    {
+      "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": "fullwidth",
+          "description": "Whether display columns fullwidth on every breakpoint (not just mobile)"
+        },
+        {
+          "name": "size",
+          "description": "Size variant",
+          "values": [
+            {
+              "name": "default"
+            },
+            {
+              "name": "large"
+            },
+            {
+              "name": "small"
+            }
+          ]
+        }
+      ]
+    },
     {
       "name": "stzh-toggle",
       "description": {
@@ -4282,15 +4555,15 @@
             {
               "name": "2"
             },
-            {
-              "name": "3"
-            },
             {
               "name": "4"
             },
             {
               "name": "5"
             },
+            {
+              "name": "3"
+            },
             {
               "name": "6"
             },
@@ -4838,7 +5111,7 @@
       "attributes": [
         {
           "name": "api",
-          "description": "API URL(`{lang}` are replaced in the URL)"
+          "description": "API URL (`{lang}` is replaced in the URL)"
         },
         {
           "name": "data",
@@ -4863,7 +5136,7 @@
       "attributes": [
         {
           "name": "api",
-          "description": "API URL(`{lang}` are replaced in the URL)"
+          "description": "API URL (`{lang}` is replaced in the URL)"
         },
         {
           "name": "data",

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@oiz/stzh-components",
-    "version": "2.1.0",
+    "version": "2.2.0",
     "description": "STZH Web Components Library",
     "main": "dist/index.cjs.js",
     "module": "dist/index.js",