@telesign/boreal-web-components 0.1.0-alpha.0

package/custom-elements.json

@@ -0,0 +1,764 @@
+{
+  "schemaVersion": "2.1.0",
+  "modules": [
+    {
+      "kind": "javascript-module",
+      "path": "src/components/feedback/bds-banner/bds-banner.tsx",
+      "declarations": [
+        {
+          "kind": "class",
+          "customElement": true,
+          "tagName": "bds-banner",
+          "name": "BdsBanner",
+          "description": "Banner component used to display important messages with different status variants.",
+          "attributes": [
+            {
+              "name": "enable-close",
+              "description": "Shows a close button that allows users to dismiss the banner.",
+              "type": {
+                "text": "boolean",
+                "references": [
+                  {
+                    "name": "IBanner",
+                    "module": "./types/IBanner"
+                  }
+                ]
+              },
+              "default": "false",
+              "fieldName": "enableClose"
+            },
+            {
+              "name": "id-component",
+              "description": "Unique identifier for the banner element.",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "fieldName": "idComponent"
+            },
+            {
+              "name": "variant",
+              "description": "Visual style variant: 'info', 'success', 'warning', or 'danger'.",
+              "type": {
+                "text": "\"danger\" | \"info\" | \"success\" | \"warning\"",
+                "references": [
+                  {
+                    "name": "IBanner",
+                    "module": "./types/IBanner"
+                  }
+                ]
+              },
+              "default": "STATUS_VARIANT.INFO",
+              "fieldName": "variant"
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "enableClose",
+              "description": "Shows a close button that allows users to dismiss the banner.",
+              "type": {
+                "text": "boolean",
+                "references": [
+                  {
+                    "name": "IBanner",
+                    "module": "./types/IBanner"
+                  }
+                ]
+              },
+              "default": "false",
+              "readonly": true,
+              "attribute": "enable-close"
+            },
+            {
+              "kind": "field",
+              "name": "idComponent",
+              "description": "Unique identifier for the banner element.",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "readonly": true,
+              "attribute": "id-component"
+            },
+            {
+              "kind": "field",
+              "name": "variant",
+              "description": "Visual style variant: 'info', 'success', 'warning', or 'danger'.",
+              "type": {
+                "text": "\"danger\" | \"info\" | \"success\" | \"warning\"",
+                "references": [
+                  {
+                    "name": "IBanner",
+                    "module": "./types/IBanner"
+                  }
+                ]
+              },
+              "default": "STATUS_VARIANT.INFO",
+              "readonly": true,
+              "attribute": "variant"
+            },
+            {
+              "kind": "method",
+              "name": "closeBanner",
+              "description": "Programmatic method to close the banner and emit the `close` event",
+              "return": {
+                "type": {
+                  "text": "Promise<void>",
+                  "references": [
+                    {
+                      "name": "Promise",
+                      "package": "global:"
+                    }
+                  ]
+                }
+              }
+            }
+          ],
+          "events": [
+            {
+              "name": "close",
+              "description": "Emitted when the banner is closed via the close button or handleClose method.",
+              "type": {
+                "text": "CustomEvent<void>"
+              }
+            }
+          ],
+          "slots": [
+            {
+              "name": "",
+              "description": "Default slot for the main body content of the banner."
+            },
+            {
+              "name": "actions",
+              "description": "Slot for action buttons or links displayed at the end of the banner."
+            },
+            {
+              "name": "title",
+              "description": "Slot for the banner title text."
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "BdsBanner",
+          "declaration": {
+            "name": "BdsBanner"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "bds-banner",
+          "declaration": {
+            "name": "BdsBanner"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/components/titles-text/bds-typography/bds-typography.tsx",
+      "declarations": [
+        {
+          "kind": "class",
+          "customElement": true,
+          "tagName": "bds-typography",
+          "name": "BdsTypography",
+          "description": "Typography component for displaying text with various styles, sizes, and interactive features.",
+          "attributes": [
+            {
+              "name": "align",
+              "description": "Text alignment.",
+              "type": {
+                "text": "\"center\" | \"end\" | \"inherit\" | \"start\"",
+                "references": [
+                  {
+                    "name": "ITypography",
+                    "module": "./types/ITypography"
+                  }
+                ]
+              },
+              "default": "ALIGNMENT.START",
+              "fieldName": "align"
+            },
+            {
+              "name": "custom-class",
+              "description": "Additional custom CSS class.",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "fieldName": "customClass"
+            },
+            {
+              "name": "element",
+              "description": "HTML tag used for rendering.",
+              "type": {
+                "text": "\"a\" | \"div\" | \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"label\" | \"p\" | \"span\"",
+                "references": [
+                  {
+                    "name": "ITypography",
+                    "module": "./types/ITypography"
+                  }
+                ]
+              },
+              "default": "TAG_ELEMENT.P",
+              "fieldName": "element"
+            },
+            {
+              "name": "ellipsis",
+              "description": "Enables text ellipsis.",
+              "type": {
+                "text": "boolean",
+                "references": [
+                  {
+                    "name": "ITypography",
+                    "module": "./types/ITypography"
+                  }
+                ]
+              },
+              "default": "false",
+              "fieldName": "ellipsis"
+            },
+            {
+              "name": "filename",
+              "description": "Suggested download filename.",
+              "type": {
+                "text": "string",
+                "references": [
+                  {
+                    "name": "ITypography",
+                    "module": "./types/ITypography"
+                  }
+                ]
+              },
+              "default": "FILENAME",
+              "fieldName": "filename"
+            },
+            {
+              "name": "href",
+              "description": "Link href when rendered as anchor.",
+              "type": {
+                "text": "string",
+                "references": [
+                  {
+                    "name": "ITypography",
+                    "module": "./types/ITypography"
+                  }
+                ]
+              },
+              "default": "null",
+              "fieldName": "href"
+            },
+            {
+              "name": "html-for",
+              "description": "For attribute when rendered as a label.",
+              "type": {
+                "text": "string",
+                "references": [
+                  {
+                    "name": "ITypography",
+                    "module": "./types/ITypography"
+                  }
+                ]
+              },
+              "default": "undefined",
+              "fieldName": "htmlFor"
+            },
+            {
+              "name": "is-downloadable",
+              "description": "Enables download behavior for anchor.",
+              "type": {
+                "text": "boolean",
+                "references": [
+                  {
+                    "name": "ITypography",
+                    "module": "./types/ITypography"
+                  }
+                ]
+              },
+              "default": "false",
+              "fieldName": "isDownloadable"
+            },
+            {
+              "name": "is-required",
+              "description": "Marks the field as required.",
+              "type": {
+                "text": "boolean",
+                "references": [
+                  {
+                    "name": "ITypography",
+                    "module": "./types/ITypography"
+                  }
+                ]
+              },
+              "default": "false",
+              "fieldName": "isRequired"
+            },
+            {
+              "name": "max-lines",
+              "description": "Max lines when ellipsis is enabled.",
+              "type": {
+                "text": "number",
+                "references": [
+                  {
+                    "name": "ITypography",
+                    "module": "./types/ITypography"
+                  }
+                ]
+              },
+              "default": "1",
+              "fieldName": "maxLines"
+            },
+            {
+              "name": "size",
+              "description": "Typography size token.",
+              "type": {
+                "text": "\"lg\" | \"md\" | \"sm\" | \"xl\" | \"xs\"",
+                "references": [
+                  {
+                    "name": "ITypography",
+                    "module": "./types/ITypography"
+                  }
+                ]
+              },
+              "default": "SIZES.M",
+              "fieldName": "size"
+            },
+            {
+              "name": "state",
+              "description": "Visual state (if supported by variant).",
+              "type": {
+                "text": "\"active\" | \"default\" | \"disabled\" | \"error\" | \"focus\" | \"hover\" | \"visited\"",
+                "references": [
+                  {
+                    "name": "ITypography",
+                    "module": "./types/ITypography"
+                  }
+                ]
+              },
+              "default": "STATES.DEFAULT",
+              "fieldName": "state"
+            },
+            {
+              "name": "target",
+              "description": "Anchor target.",
+              "type": {
+                "text": "\"\" | \"_blank\" | \"_parent\" | \"_self\" | \"_top\"",
+                "references": [
+                  {
+                    "name": "ITypography",
+                    "module": "./types/ITypography"
+                  }
+                ]
+              },
+              "default": "null",
+              "fieldName": "target"
+            },
+            {
+              "name": "tooltip-text",
+              "description": "Tooltip text (variant must support it).",
+              "type": {
+                "text": "string",
+                "references": [
+                  {
+                    "name": "ITypography",
+                    "module": "./types/ITypography"
+                  }
+                ]
+              },
+              "default": "''",
+              "fieldName": "tooltipText"
+            },
+            {
+              "name": "variant",
+              "description": "Typography visual variant.",
+              "type": {
+                "text": "\"caption\" | \"code\" | \"display\" | \"heading\" | \"helper\" | \"label\" | \"link\" | \"subheading\"",
+                "references": [
+                  {
+                    "name": "ITypography",
+                    "module": "./types/ITypography"
+                  }
+                ]
+              },
+              "default": "VARIANT_TYPOGRAPHY.DISPLAY",
+              "fieldName": "variant"
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "align",
+              "description": "Text alignment.",
+              "type": {
+                "text": "\"center\" | \"end\" | \"inherit\" | \"start\"",
+                "references": [
+                  {
+                    "name": "ITypography",
+                    "module": "./types/ITypography"
+                  }
+                ]
+              },
+              "default": "ALIGNMENT.START",
+              "readonly": true,
+              "attribute": "align"
+            },
+            {
+              "kind": "field",
+              "name": "customClass",
+              "description": "Additional custom CSS class.",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "readonly": true,
+              "attribute": "custom-class"
+            },
+            {
+              "kind": "field",
+              "name": "element",
+              "description": "HTML tag used for rendering.",
+              "type": {
+                "text": "\"a\" | \"div\" | \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"label\" | \"p\" | \"span\"",
+                "references": [
+                  {
+                    "name": "ITypography",
+                    "module": "./types/ITypography"
+                  }
+                ]
+              },
+              "default": "TAG_ELEMENT.P",
+              "readonly": true,
+              "attribute": "element"
+            },
+            {
+              "kind": "field",
+              "name": "ellipsis",
+              "description": "Enables text ellipsis.",
+              "type": {
+                "text": "boolean",
+                "references": [
+                  {
+                    "name": "ITypography",
+                    "module": "./types/ITypography"
+                  }
+                ]
+              },
+              "default": "false",
+              "readonly": true,
+              "attribute": "ellipsis"
+            },
+            {
+              "kind": "field",
+              "name": "filename",
+              "description": "Suggested download filename.",
+              "type": {
+                "text": "string",
+                "references": [
+                  {
+                    "name": "ITypography",
+                    "module": "./types/ITypography"
+                  }
+                ]
+              },
+              "default": "FILENAME",
+              "readonly": true,
+              "attribute": "filename"
+            },
+            {
+              "kind": "field",
+              "name": "href",
+              "description": "Link href when rendered as anchor.",
+              "type": {
+                "text": "string",
+                "references": [
+                  {
+                    "name": "ITypography",
+                    "module": "./types/ITypography"
+                  }
+                ]
+              },
+              "default": "null",
+              "readonly": true,
+              "attribute": "href"
+            },
+            {
+              "kind": "field",
+              "name": "htmlFor",
+              "description": "For attribute when rendered as a label.",
+              "type": {
+                "text": "string",
+                "references": [
+                  {
+                    "name": "ITypography",
+                    "module": "./types/ITypography"
+                  }
+                ]
+              },
+              "default": "undefined",
+              "readonly": true,
+              "attribute": "html-for"
+            },
+            {
+              "kind": "field",
+              "name": "isDownloadable",
+              "description": "Enables download behavior for anchor.",
+              "type": {
+                "text": "boolean",
+                "references": [
+                  {
+                    "name": "ITypography",
+                    "module": "./types/ITypography"
+                  }
+                ]
+              },
+              "default": "false",
+              "readonly": true,
+              "attribute": "is-downloadable"
+            },
+            {
+              "kind": "field",
+              "name": "isRequired",
+              "description": "Marks the field as required.",
+              "type": {
+                "text": "boolean",
+                "references": [
+                  {
+                    "name": "ITypography",
+                    "module": "./types/ITypography"
+                  }
+                ]
+              },
+              "default": "false",
+              "readonly": true,
+              "attribute": "is-required",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "maxLines",
+              "description": "Max lines when ellipsis is enabled.",
+              "type": {
+                "text": "number",
+                "references": [
+                  {
+                    "name": "ITypography",
+                    "module": "./types/ITypography"
+                  }
+                ]
+              },
+              "default": "1",
+              "readonly": true,
+              "attribute": "max-lines"
+            },
+            {
+              "kind": "field",
+              "name": "size",
+              "description": "Typography size token.",
+              "type": {
+                "text": "\"lg\" | \"md\" | \"sm\" | \"xl\" | \"xs\"",
+                "references": [
+                  {
+                    "name": "ITypography",
+                    "module": "./types/ITypography"
+                  }
+                ]
+              },
+              "default": "SIZES.M",
+              "readonly": true,
+              "attribute": "size",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "state",
+              "description": "Visual state (if supported by variant).",
+              "type": {
+                "text": "\"active\" | \"default\" | \"disabled\" | \"error\" | \"focus\" | \"hover\" | \"visited\"",
+                "references": [
+                  {
+                    "name": "ITypography",
+                    "module": "./types/ITypography"
+                  }
+                ]
+              },
+              "default": "STATES.DEFAULT",
+              "readonly": true,
+              "attribute": "state",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "target",
+              "description": "Anchor target.",
+              "type": {
+                "text": "\"\" | \"_blank\" | \"_parent\" | \"_self\" | \"_top\"",
+                "references": [
+                  {
+                    "name": "ITypography",
+                    "module": "./types/ITypography"
+                  }
+                ]
+              },
+              "default": "null",
+              "readonly": true,
+              "attribute": "target"
+            },
+            {
+              "kind": "field",
+              "name": "tooltipText",
+              "description": "Tooltip text (variant must support it).",
+              "type": {
+                "text": "string",
+                "references": [
+                  {
+                    "name": "ITypography",
+                    "module": "./types/ITypography"
+                  }
+                ]
+              },
+              "default": "''",
+              "readonly": true,
+              "attribute": "tooltip-text"
+            },
+            {
+              "kind": "field",
+              "name": "variant",
+              "description": "Typography visual variant.",
+              "type": {
+                "text": "\"caption\" | \"code\" | \"display\" | \"heading\" | \"helper\" | \"label\" | \"link\" | \"subheading\"",
+                "references": [
+                  {
+                    "name": "ITypography",
+                    "module": "./types/ITypography"
+                  }
+                ]
+              },
+              "default": "VARIANT_TYPOGRAPHY.DISPLAY",
+              "readonly": true,
+              "attribute": "variant",
+              "reflects": true
+            }
+          ],
+          "slots": [
+            {
+              "name": "",
+              "description": "The text displayed in the typography."
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "BdsTypography",
+          "declaration": {
+            "name": "BdsTypography"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "bds-typography",
+          "declaration": {
+            "name": "BdsTypography"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/components/my-component/my-component.tsx",
+      "declarations": [
+        {
+          "kind": "class",
+          "customElement": true,
+          "tagName": "my-component",
+          "name": "MyComponent",
+          "attributes": [
+            {
+              "name": "first",
+              "description": "The first name",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "fieldName": "first"
+            },
+            {
+              "name": "last",
+              "description": "The last name",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "fieldName": "last"
+            },
+            {
+              "name": "middle",
+              "description": "The middle name",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "fieldName": "middle"
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "first",
+              "description": "The first name",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "readonly": true,
+              "attribute": "first"
+            },
+            {
+              "kind": "field",
+              "name": "last",
+              "description": "The last name",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "readonly": true,
+              "attribute": "last"
+            },
+            {
+              "kind": "field",
+              "name": "middle",
+              "description": "The middle name",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "readonly": true,
+              "attribute": "middle"
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "MyComponent",
+          "declaration": {
+            "name": "MyComponent"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "my-component",
+          "declaration": {
+            "name": "MyComponent"
+          }
+        }
+      ]
+    }
+  ]
+}