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

package/dist/types/components/feedback/bds-banner/bds-banner.d.ts

@@ -0,0 +1,71 @@
+import { EventEmitter } from '../../../stencil-public-runtime';
+import type { IBanner } from './types/IBanner';
+/**
+ * Banner component used to display important messages with different status variants.
+ *
+ * @summary Displays a dismissible banner with an icon, title, body content, and optional actions.
+ *
+ * @slot title - Slot for the banner title text.
+ * @slot - Default slot for the main body content of the banner.
+ * @slot actions - Slot for action buttons or links displayed at the end of the banner.
+ *
+ * @attr {"info"|"success"|"warning"|"danger"} variant - Status variant of the banner, affects color and icon. Defaults to "info".
+ * @attr {boolean} enable-close - When true, renders a close button that triggers the close event.
+ * @attr {string} idComponent - Unique identifier for the banner element.
+ *
+ * @property {string} idComponent - Unique identifier for the banner element.
+ * @property {"info"|"success"|"warning"|"danger"} variant - Visual style variant: 'info', 'success', 'warning', or 'danger'. Defaults to "info".
+ * @property {boolean} enableClose - Shows a close button that allows users to dismiss the banner. Defaults to false.
+ *
+ * @fires close - Emitted when the banner is closed via the close button or `closeBanner` method.
+ *
+ * @method closeBanner - Programmatic method to close the banner and emit the `close` event.
+ *
+ */
+export declare class BdsBanner implements IBanner {
+    private inheritedAttributes;
+    /**
+     * Reference to the host element.
+     */
+    el: HTMLBdsBannerElement;
+    /**
+     * Internal state tracking the banner's closing animation.
+     */
+    isClosing: boolean;
+    /**
+     * Controls the visibility of the banner. Set to false to hide the banner.
+     */
+    isOpen: boolean;
+    /**
+     * Unique identifier for the banner element.
+     */
+    readonly idComponent: string;
+    /**
+     * Visual style variant: 'info', 'success', 'warning', or 'danger'.
+     * @default "info"
+     */
+    readonly variant: IBanner['variant'];
+    /**
+     * Shows a close button that allows users to dismiss the banner.
+     * @default false
+     */
+    readonly enableClose: IBanner['enableClose'];
+    /**
+     * Emitted when the banner is closed via the close button or handleClose method.
+     */
+    close: EventEmitter<void>;
+    componentWillLoad(): void;
+    /**
+     * Programmatic method to close the banner and emit the `close` event
+     */
+    closeBanner(): Promise<void>;
+    private handleCloseBanner;
+    private handleEscapeKeyClose;
+    private handleAnimationEnd;
+    private getIconName;
+    private getAttributes;
+    private getStyles;
+    private renderCloseIcon;
+    render(): any;
+}
+//# sourceMappingURL=bds-banner.d.ts.map

package/dist/types/components/feedback/bds-banner/types/IBanner.d.ts

@@ -0,0 +1,10 @@
+import type { StatusVariant } from "../../../../types/index";
+import type { EventEmitter } from '../../../../stencil-public-runtime';
+export interface IBanner {
+    variant: StatusVariant;
+    enableClose: boolean;
+    isOpen: boolean;
+    isClosing: boolean;
+    close: EventEmitter<void>;
+}
+//# sourceMappingURL=IBanner.d.ts.map

package/dist/types/components/my-component/my-component.d.ts

@@ -0,0 +1,16 @@
+export declare class MyComponent {
+    /**
+     * The first name
+     */
+    readonly first: string;
+    /**
+     * The middle name
+     */
+    readonly middle: string;
+    /**
+     * The last name
+     */
+    readonly last: string;
+    render(): any;
+}
+//# sourceMappingURL=my-component.d.ts.map

package/dist/types/components/titles-text/bds-typography/bds-typography.d.ts

@@ -0,0 +1,99 @@
+import type { ITypography } from './types/ITypography';
+/**
+ * Typography component for displaying text with various styles, sizes, and interactive features.
+ *
+ * @summary A comprehensive typography component that supports multiple text variants, sizes, alignments, states, and link functionality.
+ *
+ * @slot - The text displayed in the typography.
+ *
+ * @attr {string} variant - The variant of the typography for styling the text. Options: label, display, heading, subheading, helper, link, code, caption
+ * @attr {string} element - Defines the HTML element. For `heading` variant, the text size adjusts to the HTML heading level (`h1` through `h6`).
+ * @attr {string} state - The state of the typography. Only available for the `helper` and `label` variants. Options: default, error, disabled, hover, active, focus, visited
+ * @attr {string} align - The text alignment. Options: start, center, end, inherit
+ * @attr {string} size - The size of the typography. For `display` variant all options are available (`xl`, `lg`, `md`, `sm`), while for `link` variant only `md` and `sm` are available.
+ * @attr {boolean} is-required - Shows a required indicator when used with `label` variant.
+ * @attr {boolean} ellipsis - Truncates text with an ellipsis when it overflows.
+ * @attr {number} max-lines - Maximum number of lines to show before truncating with ellipsis.
+ * @attr {string} href - URL when the typography is an `a` element and a `link` variant.
+ * @attr {string} target - Specifies where to open the link. Options: _self, _blank, _top, _parent
+ * @attr {boolean} is-downloadable - Makes the `link` download a file.
+ * @attr {string} filename - Suggested filename when downloading a file from the `link`.
+ * @attr {string} html-for - The for attribute when rendered as a label
+ * @attr {string} tooltip-text - Text to display inside the tooltip when hovering the info icon. Only applicable for `heading`, `subheading`, and `label` variants.
+ * @attr {string} custom-class - Additional custom CSS class
+ *
+ * @property {string} variant - The variant of the typography for styling the text. Options: label, display, heading, subheading, helper, link, code, caption
+ * @property {string} element - Defines the HTML element. For `heading` variant, the text size adjusts to the HTML heading level (`h1` through `h6`).
+ * @property {string} state - The state of the typography. Only available for the `helper` and `label` variants. Options: default, error, disabled, hover, active, focus, visited
+ * @property {string} align - The text alignment. Options: start, center, end, inherit
+ * @property {string} size - The size of the typography. For `display` variant all options are available (`xl`, `lg`, `md`, `sm`), while for `link` variant only `md` and `sm` are available.
+ * @property {boolean} isRequired - Shows a required indicator when used with `label` variant.
+ * @property {boolean} ellipsis - Truncates text with an ellipsis when it overflows.
+ * @property {number} maxLines - Maximum number of lines to show before truncating with ellipsis.
+ * @property {string} href - URL when the typography is an `a` element and a `link` variant.
+ * @property {string} target - Specifies where to open the link. Options: _self, _blank, _top, _parent
+ * @property {boolean} isDownloadable - Makes the `link` download a file.
+ * @property {string} filename - Suggested filename when downloading a file from the `link`.
+ * @property {string} htmlFor - The for attribute when rendered as a label
+ * @property {string} tooltipText - Text to display inside the tooltip when hovering the info icon. Only applicable for `heading`, `subheading`, and `label` variants.
+ * @property {string} customClass - Additional custom CSS class
+ *
+ * @default 'display' - Default variant value
+ * @default 'p' - Default element value
+ * @default 'start' - Default align value
+ * @default 'md' - Default size value
+ * @default 'default' - Default state value
+ * @default false - Default isRequired state
+ * @default false - Default ellipsis state
+ * @default 1 - Default maxLines value
+ * @default '' - Default href value
+ * @default '' - Default target value
+ * @default false - Default isDownloadable state
+ * @default 'download' - Default filename value
+ * @default '' - Default tooltipText value
+ */
+export declare class BdsTypography implements ITypography {
+    private inheritedAttributes;
+    /** Host element reference. */
+    el: HTMLBdsTypographyElement;
+    /** Typography visual variant. */
+    readonly variant: ITypography['variant'];
+    /** Typography size token. */
+    readonly size: ITypography['size'];
+    /** Visual state (if supported by variant). */
+    readonly state: ITypography['state'];
+    /** Additional custom CSS class. */
+    readonly customClass: string;
+    /** HTML tag used for rendering. */
+    readonly element: ITypography['element'];
+    /** Text alignment. */
+    readonly align: ITypography['align'];
+    /** Enables text ellipsis. */
+    readonly ellipsis: ITypography['ellipsis'];
+    /** Max lines when ellipsis is enabled. */
+    readonly maxLines: ITypography['maxLines'];
+    /** Tooltip text (variant must support it). */
+    readonly tooltipText: ITypography['tooltipText'];
+    /** Marks the field as required. */
+    readonly isRequired: ITypography['isRequired'];
+    /** For attribute when rendered as a label. */
+    readonly htmlFor: ITypography['htmlFor'];
+    /** Link href when rendered as anchor. */
+    readonly href: ITypography['href'];
+    /** Anchor target. */
+    readonly target: ITypography['target'];
+    /** Enables download behavior for anchor. */
+    readonly isDownloadable: ITypography['isDownloadable'];
+    /** Suggested download filename. */
+    readonly filename: ITypography['filename'];
+    /** Sanitized href for security. */
+    sanitizedHref: string;
+    updateSanitizedHref(): Promise<void>;
+    componentWillLoad(): Promise<void>;
+    get getTagName(): string;
+    private getVariantConfig;
+    private getAccessibilityTags;
+    private getVariantStateStyles;
+    render(): any;
+}
+//# sourceMappingURL=bds-typography.d.ts.map

package/dist/types/components/titles-text/bds-typography/types/ITypography.d.ts

@@ -0,0 +1,22 @@
+import type { Alignment } from "../../../../types/alignment";
+import type { TagElement, Variant } from './types';
+import type { State } from "../../../../types/states";
+import type { Size } from "../../../../types/size";
+export interface ITypography {
+    element: TagElement;
+    variant: Variant;
+    align: Alignment;
+    ellipsis: boolean;
+    maxLines: number;
+    tooltipText: string;
+    state: State;
+    size: Size;
+    isRequired: boolean;
+    htmlFor: string | undefined;
+    href: string | null;
+    target: '_blank' | '_parent' | '_self' | '_top' | '' | null;
+    isDownloadable: boolean;
+    filename: string;
+    sanitizedHref: string;
+}
+//# sourceMappingURL=ITypography.d.ts.map

package/dist/types/components/titles-text/bds-typography/types/enum.d.ts

@@ -0,0 +1,24 @@
+export declare const VARIANT_TYPOGRAPHY: {
+    readonly DISPLAY: "display";
+    readonly HEADING: "heading";
+    readonly SUBHEADING: "subheading";
+    readonly LABEL: "label";
+    readonly HELPER: "helper";
+    readonly LINK: "link";
+    readonly CODE: "code";
+    readonly CAPTION: "caption";
+};
+export declare const TAG_ELEMENT: {
+    readonly P: "p";
+    readonly H1: "h1";
+    readonly H2: "h2";
+    readonly H3: "h3";
+    readonly H4: "h4";
+    readonly H5: "h5";
+    readonly H6: "h6";
+    readonly SPAN: "span";
+    readonly DIV: "div";
+    readonly A: "a";
+    readonly LABEL: "label";
+};
+//# sourceMappingURL=enum.d.ts.map

package/dist/types/components/titles-text/bds-typography/types/types.d.ts

@@ -0,0 +1,4 @@
+import type { TAG_ELEMENT, VARIANT_TYPOGRAPHY } from './enum';
+export type TagElement = (typeof TAG_ELEMENT)[keyof typeof TAG_ELEMENT];
+export type Variant = (typeof VARIANT_TYPOGRAPHY)[keyof typeof VARIANT_TYPOGRAPHY];
+//# sourceMappingURL=types.d.ts.map

package/dist/types/components/titles-text/bds-typography/utils/bds-typography-utils.d.ts

@@ -0,0 +1,15 @@
+import { type State } from "../../../../types/states";
+import { type Size } from "../../../../types/size";
+import type { Variant } from '../types/types';
+import type { ITypography } from '../types/ITypography';
+export declare const FILENAME = "download";
+type VariantSettings = {
+    readonly states?: State[];
+    readonly isRequired?: boolean;
+    readonly size?: Size[];
+    readonly canUseTooltip?: boolean;
+};
+export declare const VARIANT_CONFIG: Partial<Record<Variant, VariantSettings>>;
+export declare const getAttributesByTag: (comp: ITypography, tagName: string) => Record<string, unknown>;
+export {};
+//# sourceMappingURL=bds-typography-utils.d.ts.map