@swisspost/design-system-components 2.1.0 → 7.1.0

package/dist/docs.json

@@ -1,9 +1,9 @@
 {
-  "timestamp": "2024-03-05T15:08:17",
+  "timestamp": "2024-05-23T13:10:24",
   "compiler": {
     "name": "@stencil/core",
-    "version": "4.12.0",
-    "typescriptVersion": "5.3.3"
+    "version": "4.18.0",
+    "typescriptVersion": "5.4.5"
   },
   "components": [
     {
@@ -20,6 +20,54 @@
       ],
       "usage": {},
       "props": [
+        {
+          "name": "headingLevel",
+          "type": "1 | 2 | 3 | 4 | 5 | 6",
+          "complexType": {
+            "original": "HeadingLevel",
+            "resolved": "1 | 2 | 3 | 4 | 5 | 6",
+            "references": {
+              "HeadingLevel": {
+                "location": "import",
+                "path": "@/types",
+                "id": "src/types/index.ts::HeadingLevel"
+              }
+            }
+          },
+          "mutable": false,
+          "attr": "heading-level",
+          "reflectToAttr": false,
+          "docs": "Defines the hierarchical level of the `post-accordion-item` headers within the headings structure.",
+          "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": true,
+          "required": false
+        },
         {
           "name": "multiple",
           "type": "boolean",
@@ -85,7 +133,7 @@
           },
           "signature": "expandAll() => Promise<void>",
           "parameters": [],
-          "docs": "Expands all `post-accordion-item`.\n\nIf `close-others` is `true` and all items are closed, it will open the first one.\nOtherwise, it will keep the opened one.",
+          "docs": "Expands all `post-accordion-item`.\n\nIf `multiple=\"true\"` is not set and all items are closed, it will open the first one.\nOtherwise, it will keep the opened one.",
           "docsTags": []
         },
         {
@@ -126,7 +174,7 @@
       "events": [],
       "listeners": [
         {
-          "event": "collapseChange",
+          "event": "postToggle",
           "capture": false,
           "passive": false
         }
@@ -192,8 +240,8 @@
             "references": {
               "HeadingLevel": {
                 "location": "import",
-                "path": "./heading-levels",
-                "id": "src/components/post-accordion-item/heading-levels.ts::HeadingLevel"
+                "path": "@/types",
+                "id": "src/types/index.ts::HeadingLevel"
               }
             }
           },
@@ -201,8 +249,14 @@
           "attr": "heading-level",
           "reflectToAttr": false,
           "docs": "Defines the hierarchical level of the accordion item header within the headings structure.",
-          "docsTags": [],
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "set the `heading-level` property on the parent `post-accordion` instead."
+            }
+          ],
           "default": "2",
+          "deprecation": "set the `heading-level` property on the parent `post-accordion` instead.",
           "values": [
             {
               "value": "1",
@@ -272,7 +326,7 @@
       "events": [],
       "listeners": [
         {
-          "event": "collapseChange",
+          "event": "postToggle",
           "capture": false,
           "passive": false
         }
@@ -488,7 +542,7 @@
       ],
       "events": [
         {
-          "event": "dismissed",
+          "event": "postDismissed",
           "detail": "void",
           "bubbles": true,
           "complexType": {
@@ -529,6 +583,334 @@
         ]
       }
     },
+    {
+      "filePath": "src/components/post-card-control/post-card-control.tsx",
+      "encapsulation": "shadow",
+      "tag": "post-card-control",
+      "readme": "# post-card-control\n\n\n",
+      "docs": "",
+      "docsTags": [
+        {
+          "name": "class",
+          "text": "PostCardControl - representing a stencil component"
+        },
+        {
+          "name": "slot",
+          "text": "default - Content to place into the `default` slot.<p>Markup accepted: <a href=\"https://developer.mozilla.org/en-US/docs/Glossary/Block-level_contentt\">block content</a>.<p className=\"alert alert-sm alert-warning\">Even if it is generally possible, we do not recommend using interactive elements in this slot because the background of the card control is clickable.<br/>This can lead to confusion when the hit box of nested interactive controls is not clearly separated from the background, is invalid HTML and click events bubbling up to the card control will unexpectedly toggle it if they're not captured.<br/>More info: <a href=\"https://accessibilityinsights.io/info-examples/web/nested-interactive/\">https://accessibilityinsights.io/info-examples/web/nested-interactive/</a></p>"
+        },
+        {
+          "name": "slot",
+          "text": "icon - To insert a custom icon into the named `icon` slot.<p>Markup accepted: <a href=\"https://developer.mozilla.org/en-US/docs/Glossary/Inline-level_content\">inline content</a>.<p className=\"alert alert-sm alert-info\">It is only meant for <code>img</code> or <code>svg</code> elements and overrides the `icon` property.</p>"
+        }
+      ],
+      "usage": {},
+      "props": [
+        {
+          "name": "checked",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "checked",
+          "reflectToAttr": false,
+          "docs": "Defines the `checked` attribute of the control. If `true`, the control is selected at its value will be included in the forms data.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "description",
+          "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "description",
+          "reflectToAttr": false,
+          "docs": "Defines the description in the control-label.",
+          "docsTags": [],
+          "default": "null",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "disabled",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "disabled",
+          "reflectToAttr": false,
+          "docs": "Defines the `disabled` attribute of the control. If `true`, the user can not interact with the control and the controls value will not be included in the forms data.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "icon",
+          "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "icon",
+          "reflectToAttr": false,
+          "docs": "Defines the icon `name` inside of the card.\n<span className=\"alert alert-sm alert-info\">If not set the icon will not show up.</span>",
+          "docsTags": [],
+          "default": "null",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "label",
+          "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "label",
+          "reflectToAttr": false,
+          "docs": "Defines the text in the control-label.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": true
+        },
+        {
+          "name": "name",
+          "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "name",
+          "reflectToAttr": false,
+          "docs": "Defines the `name` attribute of the control.\n<span className=\"alert alert-sm alert-info\">This is a required property, when the control should participate in a native `form`. If not specified, a native `form` will never contain this controls value.</span>\n<span className=\"alert alert-sm alert-info\">This is a required property, when the control is used with type `radio`.</span>",
+          "docsTags": [],
+          "default": "null",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "type",
+          "type": "\"checkbox\" | \"radio\"",
+          "complexType": {
+            "original": "'checkbox' | 'radio'",
+            "resolved": "\"checkbox\" | \"radio\"",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "type",
+          "reflectToAttr": false,
+          "docs": "Defines the `type` attribute of the control.",
+          "docsTags": [],
+          "values": [
+            {
+              "value": "checkbox",
+              "type": "string"
+            },
+            {
+              "value": "radio",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": true
+        },
+        {
+          "name": "validity",
+          "type": "\"false\" | \"true\"",
+          "complexType": {
+            "original": "null | 'true' | 'false'",
+            "resolved": "\"false\" | \"true\"",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "validity",
+          "reflectToAttr": false,
+          "docs": "Defines the validation `validity` of the control.\nTo reset validity to an undefiend state, simply remove the attribute from the control.",
+          "docsTags": [],
+          "default": "null",
+          "values": [
+            {
+              "value": "false",
+              "type": "string"
+            },
+            {
+              "value": "true",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "value",
+          "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "value",
+          "reflectToAttr": false,
+          "docs": "Defines the `value` attribute of the control. <span className=\"alert alert-sm alert-info\">This is a required property, when the control is used with type `radio`.</span>",
+          "docsTags": [],
+          "default": "null",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [
+        {
+          "name": "groupReset",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "() => Promise<void>",
+            "parameters": [],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              }
+            },
+            "return": "Promise<void>"
+          },
+          "signature": "groupReset() => Promise<void>",
+          "parameters": [],
+          "docs": "A hidden public method to reset the group controls `checked` state to `false`.",
+          "docsTags": []
+        },
+        {
+          "name": "reset",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "() => Promise<void>",
+            "parameters": [],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              }
+            },
+            "return": "Promise<void>"
+          },
+          "signature": "reset() => Promise<void>",
+          "parameters": [],
+          "docs": "A public method to reset the controls `checked` and `validity` state.\nThe validity state is set to `null`, so it's neither valid nor invalid.",
+          "docsTags": []
+        }
+      ],
+      "events": [
+        {
+          "event": "postChange",
+          "detail": "{ state: boolean; value: string; }",
+          "bubbles": true,
+          "complexType": {
+            "original": "{ state: boolean; value: string }",
+            "resolved": "{ state: boolean; value: string; }",
+            "references": {}
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "An event emitted whenever the components checked state is toggled.\nThe event payload (emitted under `event.detail.state`) is a boolean: `true` if the component is checked, `false` if it is unchecked.\n<span className=\"alert alert-sm alert-info\">If the component is used with type `radio`, it will only emit this event, when the checked state is changing to `true`.</span>",
+          "docsTags": []
+        },
+        {
+          "event": "postInput",
+          "detail": "{ state: boolean; value: string; }",
+          "bubbles": true,
+          "complexType": {
+            "original": "{ state: boolean; value: string }",
+            "resolved": "{ state: boolean; value: string; }",
+            "references": {}
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "An event emitted whenever the components checked state is toggled.\nThe event payload (emitted under `event.detail.state`) is a boolean: `true` if the component is checked, `false` if it is unchecked.",
+          "docsTags": []
+        }
+      ],
+      "listeners": [],
+      "styles": [],
+      "slots": [
+        {
+          "name": "default",
+          "docs": "Content to place into the `default` slot.<p>Markup accepted: <a href=\"https://developer.mozilla.org/en-US/docs/Glossary/Block-level_contentt\">block content</a>.<p className=\"alert alert-sm alert-warning\">Even if it is generally possible, we do not recommend using interactive elements in this slot because the background of the card control is clickable.<br/>This can lead to confusion when the hit box of nested interactive controls is not clearly separated from the background, is invalid HTML and click events bubbling up to the card control will unexpectedly toggle it if they're not captured.<br/>More info: <a href=\"https://accessibilityinsights.io/info-examples/web/nested-interactive/\">https://accessibilityinsights.io/info-examples/web/nested-interactive/</a></p>"
+        },
+        {
+          "name": "icon",
+          "docs": "To insert a custom icon into the named `icon` slot.<p>Markup accepted: <a href=\"https://developer.mozilla.org/en-US/docs/Glossary/Inline-level_content\">inline content</a>.<p className=\"alert alert-sm alert-info\">It is only meant for <code>img</code> or <code>svg</code> elements and overrides the `icon` property.</p>"
+        }
+      ],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [
+        "post-icon"
+      ],
+      "dependencyGraph": {
+        "post-card-control": [
+          "post-icon"
+        ]
+      }
+    },
     {
       "filePath": "src/components/post-collapsible/post-collapsible.tsx",
       "encapsulation": "shadow",
@@ -604,7 +986,7 @@
       ],
       "events": [
         {
-          "event": "collapseChange",
+          "event": "postToggle",
           "detail": "boolean",
           "bubbles": true,
           "complexType": {
@@ -839,15 +1221,23 @@
       "parts": [],
       "dependents": [
         "post-alert",
-        "post-rating"
+        "post-card-control",
+        "post-rating",
+        "post-tag"
       ],
       "dependencies": [],
       "dependencyGraph": {
         "post-alert": [
           "post-icon"
         ],
+        "post-card-control": [
+          "post-icon"
+        ],
         "post-rating": [
           "post-icon"
+        ],
+        "post-tag": [
+          "post-icon"
         ]
       }
     },
@@ -913,7 +1303,7 @@
               "Placement": {
                 "location": "import",
                 "path": "@floating-ui/dom",
-                "id": "../../node_modules/.pnpm/@floating-ui+dom@1.6.1/node_modules/@floating-ui/dom/dist/floating-ui.dom.d.ts::Placement"
+                "id": "../../node_modules/.pnpm/@floating-ui+dom@1.6.5/node_modules/@floating-ui/dom/dist/floating-ui.dom.d.ts::Placement"
               }
             }
           },
@@ -1162,7 +1552,7 @@
               "Placement": {
                 "location": "import",
                 "path": "@floating-ui/dom",
-                "id": "../../node_modules/.pnpm/@floating-ui+dom@1.6.1/node_modules/@floating-ui/dom/dist/floating-ui.dom.d.ts::Placement"
+                "id": "../../node_modules/.pnpm/@floating-ui+dom@1.6.5/node_modules/@floating-ui/dom/dist/floating-ui.dom.d.ts::Placement"
               }
             }
           },
@@ -1352,7 +1742,7 @@
       ],
       "events": [
         {
-          "event": "postPopoverToggled",
+          "event": "postToggle",
           "detail": "boolean",
           "bubbles": true,
           "complexType": {
@@ -1495,7 +1885,7 @@
       "methods": [],
       "events": [
         {
-          "event": "change",
+          "event": "postChange",
           "detail": "{ value: number; }",
           "bubbles": true,
           "complexType": {
@@ -1509,7 +1899,7 @@
           "docsTags": []
         },
         {
-          "event": "input",
+          "event": "postInput",
           "detail": "{ value: number; }",
           "bubbles": true,
           "complexType": {
@@ -1731,7 +2121,7 @@
       ],
       "events": [
         {
-          "event": "tabChange",
+          "event": "postChange",
           "detail": "string",
           "bubbles": true,
           "complexType": {
@@ -1767,6 +2157,129 @@
       "dependencies": [],
       "dependencyGraph": {}
     },
+    {
+      "filePath": "src/components/post-tag/post-tag.tsx",
+      "encapsulation": "shadow",
+      "tag": "post-tag",
+      "readme": "# tag\n",
+      "docs": "",
+      "docsTags": [
+        {
+          "name": "slot",
+          "text": "default - Content to place in the `default` slot.<p>Markup accepted: <a href=\"https://developer.mozilla.org/en-US/docs/Glossary/Inline-level_content\">inline content</a>.</p>"
+        }
+      ],
+      "usage": {},
+      "props": [
+        {
+          "name": "icon",
+          "type": "string",
+          "complexType": {
+            "original": "null | string",
+            "resolved": "string",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "icon",
+          "reflectToAttr": false,
+          "docs": "Defines the icon `name` inside of the component.\n<span className=\"alert alert-sm alert-info\">If not set the icon will not show up.</span>\nTo learn which icons are available, please visit our <a href=\"/?path=/docs/5704bdc4-c5b5-45e6-b123-c54d01fce2f1--docs\">icon library</a>.",
+          "docsTags": [],
+          "default": "null",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "size",
+          "type": "\"sm\"",
+          "complexType": {
+            "original": "null | 'sm'",
+            "resolved": "\"sm\"",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "size",
+          "reflectToAttr": false,
+          "docs": "Defines the size of the component.",
+          "docsTags": [],
+          "default": "null",
+          "values": [
+            {
+              "value": "sm",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "variant",
+          "type": "\"error\" | \"info\" | \"success\" | \"warning\" | \"white\" | \"yellow\"",
+          "complexType": {
+            "original": "'white' | 'info' | 'success' | 'error' | 'warning' | 'yellow'",
+            "resolved": "\"error\" | \"info\" | \"success\" | \"warning\" | \"white\" | \"yellow\"",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "variant",
+          "reflectToAttr": false,
+          "docs": "Defines the color variant of the component.",
+          "docsTags": [],
+          "values": [
+            {
+              "value": "error",
+              "type": "string"
+            },
+            {
+              "value": "info",
+              "type": "string"
+            },
+            {
+              "value": "success",
+              "type": "string"
+            },
+            {
+              "value": "warning",
+              "type": "string"
+            },
+            {
+              "value": "white",
+              "type": "string"
+            },
+            {
+              "value": "yellow",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [
+        {
+          "name": "default",
+          "docs": "Content to place in the `default` slot.<p>Markup accepted: <a href=\"https://developer.mozilla.org/en-US/docs/Glossary/Inline-level_content\">inline content</a>.</p>"
+        }
+      ],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [
+        "post-icon"
+      ],
+      "dependencyGraph": {
+        "post-tag": [
+          "post-icon"
+        ]
+      }
+    },
     {
       "filePath": "src/components/post-tooltip/post-tooltip.tsx",
       "encapsulation": "shadow",
@@ -1808,7 +2321,7 @@
               "Placement": {
                 "location": "import",
                 "path": "@floating-ui/dom",
-                "id": "../../node_modules/.pnpm/@floating-ui+dom@1.6.1/node_modules/@floating-ui/dom/dist/floating-ui.dom.d.ts::Placement"
+                "id": "../../node_modules/.pnpm/@floating-ui+dom@1.6.5/node_modules/@floating-ui/dom/dist/floating-ui.dom.d.ts::Placement"
               }
             }
           },
@@ -2013,20 +2526,20 @@
     }
   ],
   "typeLibrary": {
-    "src/components/post-accordion-item/heading-levels.ts::HeadingLevel": {
-      "declaration": "1 | 2 | 3 | 4 | 5 | 6",
+    "src/types/index.ts::HeadingLevel": {
+      "declaration": "any",
       "docstring": "",
-      "path": "src/components/post-accordion-item/heading-levels.ts"
+      "path": "src/types/index.ts"
     },
     "src/components/post-alert/alert-types.ts::AlertType": {
-      "declaration": "\"primary\" | \"success\" | \"danger\" | \"warning\" | \"info\" | \"gray\"",
+      "declaration": "\"primary\" | \"success\" | \"warning\" | \"danger\" | \"info\" | \"gray\"",
       "docstring": "",
       "path": "src/components/post-alert/alert-types.ts"
     },
-    "../../node_modules/.pnpm/@floating-ui+dom@1.6.1/node_modules/@floating-ui/dom/dist/floating-ui.dom.d.ts::Placement": {
+    "../../node_modules/.pnpm/@floating-ui+dom@1.6.5/node_modules/@floating-ui/dom/dist/floating-ui.dom.d.ts::Placement": {
       "declaration": "any",
       "docstring": "",
-      "path": "../../node_modules/.pnpm/@floating-ui+dom@1.6.1/node_modules/@floating-ui/dom/dist/floating-ui.dom.d.ts"
+      "path": "../../node_modules/.pnpm/@floating-ui+dom@1.6.5/node_modules/@floating-ui/dom/dist/floating-ui.dom.d.ts"
     }
   }
 }