@telesign/boreal-web-components 0.1.0-alpha.2 → 0.1.0-alpha.4

package/dist/types/components/actions/bds-toggle/bds-toggle.d.ts

@@ -0,0 +1,91 @@
+import { EventEmitter } from '../../../stencil-public-runtime';
+import { IFormControl } from "../../../mixins/index";
+import { IToggle } from './types';
+import { IToggleEventChange } from './types/IEventChange';
+declare const BdsToggle_base: abstract new (...args: any[]) => {
+    formDisabledCallback(disabled: boolean): void;
+};
+/**
+ * Toggle/Switch component for boolean selection.
+ *
+ * @summary A toggle switch form control with label positioning support.
+ *
+ * @slot - Default slot for label content (used when `label` prop is not provided).
+ * @slot help-text - Slot for help text below the toggle (used when `helperText` prop is not provided).
+ *
+ * @property {string}  name        - Name of the form control, submitted as a key in the form data.
+ * @property {boolean} disabled    - Disables the control. Defaults to `false`.
+ * @property {boolean} required    - Marks the control as required for form submission. Defaults to `false`.
+ * @property {boolean} checked     - Whether the toggle is on. Defaults to `false`.
+ * @property {string}  placement   - Position of the label relative to the switch. Accepts `TOGGLE_PLACEMENT` values. Defaults to `"left"`.
+ * @property {string}  label       - Label displayed next to the toggle. Defaults to `""`.
+ * @property {string}  helperText  - Help text displayed below the toggle. Defaults to `""`.
+ * @property {string}  value       - Value submitted with the form data when checked. Defaults to `"on"`.
+ *
+ * @fires valueChange - Emitted when the checked state changes (for 2-way binding / v-model). Payload: `boolean`.
+ * @fires bdsChange   - Emitted when the user toggles the switch. Payload: `IToggleEventChange`.
+ */
+export declare class BdsToggle extends BdsToggle_base implements IToggle, IFormControl<boolean> {
+    private inheritedAttributes;
+    el: HTMLBdsToggleElement;
+    internals: ElementInternals;
+    /** Name of the form control, submitted as a key in the form data. */
+    readonly name: IToggle['name'];
+    /** Disables the control. Defaults to `false`. */
+    readonly disabled: IToggle['disabled'];
+    /** Marks the control as required for form submission. Defaults to `false`. */
+    readonly required: IToggle['required'];
+    /** Tooltip content attached to the label. Rendered via `bds-typography` `tooltipText` prop. */
+    readonly info: IToggle['info'];
+    /** When `true`, applies the error visual state. */
+    readonly error: IToggle['error'];
+    /** Message shown below the input when `error` is `true`. Replaces `helperText`. */
+    readonly errorMessage: IToggle['errorMessage'];
+    /** Whether the toggle is on. Defaults to `false`. */
+    readonly checked: IToggle['checked'];
+    /**
+     * Position of the label relative to the switch.
+     * Accepts `TOGGLE_PLACEMENT` values. Defaults to `TOGGLE_PLACEMENT.LEFT`.
+     */
+    readonly placement: IToggle['placement'];
+    /** Label displayed next to the toggle. Defaults to `""`. */
+    readonly label: IToggle['label'];
+    /** Help text displayed below the toggle. Defaults to `""`. */
+    readonly helperText: IToggle['helperText'];
+    /**
+     * Value submitted with the form data when checked.
+     * Behaves like the `value` attribute of a native `<input type="checkbox">`. Defaults to `"on"`.
+     */
+    readonly value: IToggle['value'];
+    /** Emitted when the checked state changes. Useful for 2-way binding / v-model. Payload: `boolean`. */
+    valueChange: EventEmitter<boolean>;
+    /** Emitted when the user toggles the switch. Payload: `{ checked: boolean, value: string }`. */
+    bdsChange: EventEmitter<IToggleEventChange>;
+    private readonly _id;
+    /** Internal mirror of the `disabled` prop, kept in sync via `@Watch` and `formDisabledCallback`. */
+    private isDisabled;
+    /** `true` when the last triggered validation run returned invalid. Drives the error visual state. */
+    private validationError;
+    /** Error message from the last failed validator. Shown in the footer when `validationError` is `true`. */
+    private validationMessage;
+    /** Local mirror of the `checked` prop, kept in sync via `@Watch` and `formStateRestoreCallback`. */
+    private isChecked;
+    componentWillLoad(): void;
+    onCheckedChange(newValue: boolean): void;
+    onDisabledChange(next: boolean): void;
+    formAssociatedCallback(): void;
+    formDisabledCallback(disabled: boolean): void;
+    formResetCallback(): void;
+    formStateRestoreCallback(state: unknown, _mode: string): void;
+    private syncFormValue;
+    private validate;
+    private toggle;
+    private handleClick;
+    private handleKeyDown;
+    private get containerClasses();
+    private get canShowLabel();
+    private handleInvalid;
+    render(): any;
+}
+export {};
+//# sourceMappingURL=bds-toggle.d.ts.map

package/dist/types/components/actions/bds-toggle/types/IEventChange.d.ts

@@ -0,0 +1,5 @@
+export interface IToggleEventChange {
+    checked: boolean;
+    value: string;
+}
+//# sourceMappingURL=IEventChange.d.ts.map

package/dist/types/components/actions/bds-toggle/types/IToggle.d.ts

@@ -0,0 +1,12 @@
+import { ComponentInterface } from '../../../../stencil-public-runtime';
+import { TogglePlacementType } from './types';
+import { IFormProps } from "../../../../types/IFormProps";
+export interface IToggle extends ComponentInterface, IFormProps {
+    name: string;
+    disabled: boolean;
+    required: boolean;
+    placement: TogglePlacementType;
+    checked: boolean;
+    value: string;
+}
+//# sourceMappingURL=IToggle.d.ts.map

package/dist/types/components/actions/bds-toggle/types/enum.d.ts

@@ -0,0 +1,5 @@
+export declare const TOGGLE_PLACEMENT: {
+    readonly LEFT: "left";
+    readonly RIGHT: "right";
+};
+//# sourceMappingURL=enum.d.ts.map

package/dist/types/components/actions/bds-toggle/types/index.d.ts

@@ -0,0 +1,5 @@
+export * from './IToggle';
+export * from './types';
+export * from './enum';
+export * from './IEventChange';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/components/actions/bds-toggle/types/types.d.ts

@@ -0,0 +1,3 @@
+import { TOGGLE_PLACEMENT } from './enum';
+export type TogglePlacementType = (typeof TOGGLE_PLACEMENT)[keyof typeof TOGGLE_PLACEMENT];
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1,31 @@
+import type { IBadge } from './types/IBadge';
+/**
+ * Badge component for displaying contextual status information with optional icon support.
+ *
+ * @summary A compact label component that communicates status or category using color-coded variants. Supports an optional icon slot and a disabled state.
+ *
+ * @slot - The text content of the badge.
+ * @slot icon - An icon displayed before the badge text content.
+ *
+ * @attr {string} variant - Controls the visual style of the badge. Accepted values: 'default' | 'info' | 'success' | 'warning' | 'danger'. Default is 'default'.
+ * @attr {boolean} disabled - Disables the badge when true, reducing opacity and preventing pointer interaction. Default is false.
+ *
+ * @property {string} variant - Controls the visual style of the badge. Accepted values: 'default' | 'info' | 'success' | 'warning' | 'danger'. Default is 'default'.
+ * @property {boolean} disabled - Disables the badge when true, reducing opacity and preventing pointer interaction. Default is false.
+ */
+export declare class BdsBadge implements IBadge {
+    /** Controls the visual style of the badge. Accepted values: 'default' | 'info' | 'success' | 'warning' | 'danger'. Default is 'default'. */
+    readonly variant: IBadge['variant'];
+    /** Disables the badge when true, reducing opacity and preventing pointer interaction. Default is false. */
+    readonly disabled: IBadge['disabled'];
+    /** Reference to the host element, used for prop validation warnings. */
+    el: HTMLBdsBadgeElement;
+    /** Validates the `variant` prop against allowed values and resets to the default if invalid. */
+    private checkPropValues;
+    /** Runs prop validation before the component is first rendered. */
+    componentWillLoad(): void;
+    /** Builds the BEM class map applied to the host element based on the current prop values. */
+    private get badgeClasses();
+    render(): any;
+}
+//# sourceMappingURL=bds-badge.d.ts.map

package/dist/types/components/feedback/bds-badge/types/IBadge.d.ts

@@ -0,0 +1,6 @@
+import { BadgeVariant } from './enum';
+export interface IBadge {
+    variant: BadgeVariant;
+    disabled: boolean;
+}
+//# sourceMappingURL=IBadge.d.ts.map

package/dist/types/components/feedback/bds-badge/types/enum.d.ts

@@ -0,0 +1,9 @@
+export declare const BADGE_VARIANT: {
+    readonly DEFAULT: "default";
+    readonly INFO: "info";
+    readonly SUCCESS: "success";
+    readonly WARNING: "warning";
+    readonly DANGER: "danger";
+};
+export type BadgeVariant = (typeof BADGE_VARIANT)[keyof typeof BADGE_VARIANT];
+//# sourceMappingURL=enum.d.ts.map

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

@@ -10,16 +10,15 @@ import type { IBanner } from './types/IBanner';
  * @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.
+ * @attr {boolean} closable - When true, renders a close button that triggers the close event.
  *
- * @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.
+ * @property {boolean} closable - Shows a close button that allows users to close the banner. Defaults to false.
+ * @property {boolean} closeButtonLabel - Aria label for the close button when visible.
  *
- * @fires close - Emitted when the banner is closed via the close button or `closeBanner` method.
+ * @fires bdsClose - Emitted when the banner is closed via the close button or `close` method.
  *
- * @method closeBanner - Programmatic method to close the banner and emit the `close` event.
+ * @method close - Programmatic method to close the banner and emit the `bdsClose` event.
  *
  */
 export declare class BdsBanner implements IBanner {
@@ -36,29 +35,34 @@ export declare class BdsBanner implements IBanner {
      * 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.
+     * Shows a close button that allows users to close the banner.
      * @default false
      */
-    readonly enableClose: IBanner['enableClose'];
+    readonly closable: boolean;
+    /**
+     * The aria label for the close button.
+     * @default ""
+     */
+    readonly closeButtonLabel: IBanner['closeButtonLabel'];
     /**
-     * Emitted when the banner is closed via the close button or handleClose method.
+     * Emitted when the banner is closed via the close button or close method.
      */
-    close: EventEmitter<void>;
+    bdsClose: EventEmitter<void>;
     componentWillLoad(): void;
     /**
-     * Programmatic method to close the banner and emit the `close` event
+     * Programmatic method to close the banner and emit the `bdsClose` event
+     */
+    open(): Promise<void>;
+    /**
+     * Programmatic method to close the banner and emit the `bdsClose` event
      */
-    closeBanner(): Promise<void>;
+    close(): Promise<void>;
     private handleCloseBanner;
     private handleEscapeKeyClose;
     private handleAnimationEnd;

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

@@ -2,9 +2,8 @@ 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>;
+    closable: boolean;
+    closeButtonLabel: string;
+    bdsClose: EventEmitter<void>;
 }
 //# sourceMappingURL=IBanner.d.ts.map

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

@@ -0,0 +1,32 @@
+import { ISpinner } from './types/ISpinner';
+/**
+ * Spinner component used to indicate a loading or processing state.
+ *
+ * @summary Displays an animated circular spinner to communicate that content is loading.
+ *
+ * @attr {"small"|"medium"|"large"} size - Size of the spinner. Defaults to "small".
+ * @attr {string} label - Accessible label announced by screen readers. Defaults to "Loading".
+ *
+ * @property {"small"|"medium"|"large"} size - Controls the visual size of the spinner.
+ * @property {string} label - Text used as the accessible label for screen readers.
+ *
+ */
+export declare class BdsSpinner implements ISpinner {
+    /**
+     * Controls the visual size of the spinner.
+     * @default "small"
+     */
+    readonly size: ISpinner['size'];
+    /**
+     * Accessible label announced by screen readers to describe the loading state.
+     * @default "Loading"
+     */
+    readonly label: ISpinner['label'];
+    /** variable to store local HTMLElement */
+    el: HTMLBdsSpinnerElement;
+    checkPropValues(): void;
+    componentWillLoad(): void;
+    private get getClassMap();
+    render(): any;
+}
+//# sourceMappingURL=bds-spinner.d.ts.map

package/dist/types/components/feedback/bds-spinner/types/ISpinner.d.ts

@@ -0,0 +1,6 @@
+import { SpinnerSizes } from './types';
+export interface ISpinner {
+    size: SpinnerSizes;
+    label: string;
+}
+//# sourceMappingURL=ISpinner.d.ts.map

package/dist/types/components/feedback/bds-spinner/types/enum.d.ts

@@ -0,0 +1,6 @@
+export declare const SPINNER_SIZES: {
+    readonly SMALL: "sm";
+    readonly MEDIUM: "md";
+    readonly LARGE: "lg";
+};
+//# sourceMappingURL=enum.d.ts.map

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

@@ -0,0 +1,3 @@
+import { SPINNER_SIZES } from './enum';
+export type SpinnerSizes = (typeof SPINNER_SIZES)[keyof typeof SPINNER_SIZES];
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1,26 @@
+import { IStatus } from './types/IStatus';
+/**
+ * Status badge component for communicating the current state of an item or process.
+ *
+ * @slot - The label content of the badge, typically plain text.
+ * @slot icon - Icon content rendered before the label.
+ *
+ */
+export declare class BdsStatus implements IStatus {
+    /** state is a string attribute. Controls the visual state variant of the status badge.
+     * Determines the background, accent, and text colors applied to the element.
+     * An invalid value falls back to `"neutral"` and a warning is set on the host element. */
+    readonly state: IStatus['state'];
+    /** indicator is a string attribute. Controls the type of indicator rendered before the slotted label.
+     * An invalid value falls back to `"none"` and a warning is set on the host element. */
+    readonly indicator: IStatus['indicator'];
+    el: HTMLBdsStatusElement;
+    /** Validates the `state` prop against the set of allowed values.
+     * Falls back to `"neutral"` when an invalid value is detected. */
+    checkPropValues(): void;
+    /** Before component rendered */
+    componentWillLoad(): void;
+    private get classMap();
+    render(): any;
+}
+//# sourceMappingURL=bds-status.d.ts.map

package/dist/types/components/feedback/bds-status/types/IStatus.d.ts

@@ -0,0 +1,7 @@
+import { Status } from "../../../../types/states";
+import { IndicatorTypes } from './types';
+export interface IStatus {
+    state: Status;
+    indicator: IndicatorTypes;
+}
+//# sourceMappingURL=IStatus.d.ts.map

package/dist/types/components/feedback/bds-status/types/enum.d.ts

@@ -0,0 +1,6 @@
+export declare const INDICATOR_TYPES: {
+    readonly NONE: "none";
+    readonly DOT: "dot";
+    readonly ICON: "icon";
+};
+//# sourceMappingURL=enum.d.ts.map

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

@@ -0,0 +1,3 @@
+import { INDICATOR_TYPES } from './enum';
+export type IndicatorTypes = (typeof INDICATOR_TYPES)[keyof typeof INDICATOR_TYPES];
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1,71 @@
+import { EventEmitter } from '../../../stencil-public-runtime';
+import { TagEventPayload, type ITag } from './types';
+/**
+ * Tag component used to represent categories, metadata, or removable filters.
+ *
+ * @summary Displays a label with optional leading/trailing icons and dismissal capability.
+ *
+ * @slot - Default slot for custom text content after the icon.
+ * @slot icon - Icon slot for icon content before the text.
+ *
+ * @fires bdsClose - Emitted when the tag is closed via the close button or Delete key.
+ * @fires bdsSelect - Emitted when the tag is selected via a click or Space/Enter key.
+ *
+ */
+export declare class BdsTag implements ITag {
+    private readonly _id;
+    private internalSelected;
+    /**
+     * Reference to the host element.
+     */
+    el: HTMLBdsTagElement;
+    /**
+     * Whether the tag is selectable or not.
+     * @default false
+     */
+    readonly multiselect: ITag['multiselect'];
+    /**
+     * Whether the tag is selected or not.
+     * @default false
+     */
+    readonly selected: ITag['selected'];
+    /**
+     * Aria label for the close button when visible.
+     */
+    readonly closeButtonLabel: ITag['closeButtonLabel'];
+    /**
+     * Visual color variant: 'gray', 'cyan', 'cobalt', 'teal', 'lime', 'orange', 'rose', or 'purple'.
+     * @default "gray"
+     */
+    readonly color: ITag['color'];
+    /**
+     * Hides the close button that allows users to dismiss the tag.
+     * @default false
+     */
+    readonly readonly: ITag['readonly'];
+    /**
+     * Disables interaction with the tag. Reduces opacity and prevents interactions.
+     * @default false
+     */
+    readonly disabled: ITag['disabled'];
+    /**
+     * Emitted when the tag is closed via the close button or Delete key.
+     */
+    bdsClose: EventEmitter<TagEventPayload>;
+    /**
+     * Emitted when the tag is selected via a click or Space/Enter key.
+     */
+    bdsSelect: EventEmitter<TagEventPayload>;
+    private handleClose;
+    private handleKeyDown;
+    private handleSelection;
+    componentWillLoad(): void;
+    private checkPropValues;
+    syncSelectedFromProp(newValue: boolean): void;
+    private validateMultiselectRole;
+    private getClasses;
+    private renderTag;
+    private renderCloseIcon;
+    render(): any;
+}
+//# sourceMappingURL=bds-tag.d.ts.map

package/dist/types/components/feedback/bds-tag/types/ITag.d.ts

@@ -0,0 +1,13 @@
+import type { EventEmitter } from '../../../../stencil-public-runtime';
+import { TagEventPayload, TagColor } from './types';
+export interface ITag {
+    color: TagColor;
+    readonly: boolean;
+    selected: boolean;
+    multiselect: boolean;
+    disabled: boolean;
+    closeButtonLabel: string;
+    bdsClose: EventEmitter<TagEventPayload>;
+    bdsSelect: EventEmitter<TagEventPayload>;
+}
+//# sourceMappingURL=ITag.d.ts.map

package/dist/types/components/feedback/bds-tag/types/enum.d.ts

@@ -0,0 +1,11 @@
+export declare const TAG_COLORS: {
+    readonly GRAY: "gray";
+    readonly CYAN: "cyan";
+    readonly TEAL: "teal";
+    readonly LIME: "lime";
+    readonly ORANGE: "orange";
+    readonly COBALT: "cobalt";
+    readonly ROSE: "rose";
+    readonly PURPLE: "purple";
+};
+//# sourceMappingURL=enum.d.ts.map

package/dist/types/components/feedback/bds-tag/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from './enum';
+export * from './ITag';
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1,8 @@
+import { TAG_COLORS } from './enum';
+export type TagColor = (typeof TAG_COLORS)[keyof typeof TAG_COLORS];
+export type TagEventPayload = {
+    id: string;
+    selected: boolean;
+    el: HTMLElement;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types/components/forms/bds-checkbox/bds-checkbox.d.ts

@@ -0,0 +1,65 @@
+import { EventEmitter } from '../../../stencil-public-runtime';
+import type { ICheckbox, CheckboxChangeDetail } from './types/ICheckbox';
+import { type IFormControl } from "../../../mixins/form-associated.mixin";
+declare const BdsCheckbox_base: abstract new (...args: any[]) => {
+    formDisabledCallback(disabled: boolean): void;
+};
+/**
+ * Checkbox component for boolean selection with three visual states.
+ *
+ * @summary A checkbox form control with default, selected, and indeterminate states.
+ *
+ * @slot - Default slot for label content when no `label` prop is provided.
+ *
+ * @property {boolean} checked - Whether the checkbox is selected. Defaults to `false`.
+ * @property {boolean} indeterminate - Whether the checkbox shows an indeterminate ("mixed") visual state. Defaults to `false`.
+ * @property {boolean} error - Shows error styling on the checkbox. Defaults to `false`.
+ * @property {string}  value - Value submitted with the form data when checked. Defaults to `"on"`.
+ * @property {string}  label - Label displayed next to the checkbox. If not provided, the default slot is used.
+ *
+ * @fires valueChange - Emitted when the checked state changes (for 2-way binding / v-model).
+ * @fires bdsChange - Emitted when the user toggles the checkbox. Payload: `{ checked: boolean, value: string }`.
+ */
+export declare class BdsCheckbox extends BdsCheckbox_base implements ICheckbox, IFormControl<boolean> {
+    private inheritedAttributes;
+    /** Internal mirror of the `disabled` prop, kept in sync via `@Watch` and `formDisabledCallback`. */
+    private isDisabled;
+    el: HTMLBdsCheckboxElement;
+    internals: ElementInternals;
+    /** Name of the form control, submitted as a key in the form data. */
+    readonly name: string;
+    /** Disables the control. */
+    readonly disabled: boolean;
+    /** Marks the control as required for form submission. */
+    readonly required: boolean;
+    /** Whether the checkbox is selected. */
+    checked: boolean;
+    /** Whether the checkbox shows an indeterminate ("mixed") visual state. */
+    indeterminate: boolean;
+    /** Shows error styling on the checkbox. */
+    readonly error: boolean;
+    /** Value submitted with the form data when checked. */
+    readonly value: string;
+    /** Label displayed next to the checkbox. If not provided, the default slot is used. */
+    readonly label: string;
+    /** Emitted when the checked state changes (for 2-way binding / v-model). */
+    valueChange: EventEmitter<boolean>;
+    /** Emitted when the user toggles the checkbox. */
+    bdsChange: EventEmitter<CheckboxChangeDetail>;
+    componentWillLoad(): void;
+    onCheckedChange(): void;
+    onDisabledChange(next: boolean): void;
+    formAssociatedCallback(): void;
+    formResetCallback(): void;
+    formStateRestoreCallback(state: unknown, _mode: string): void;
+    formDisabledCallback(disabled: boolean): void;
+    private syncFormValue;
+    private toggle;
+    private handleClick;
+    private handleKeyDown;
+    private getAriaChecked;
+    private renderCheckIcon;
+    render(): any;
+}
+export {};
+//# sourceMappingURL=bds-checkbox.d.ts.map

package/dist/types/components/forms/bds-checkbox/types/ICheckbox.d.ts

@@ -0,0 +1,36 @@
+import type { EventEmitter } from '../../../../stencil-public-runtime';
+/**
+ * Payload emitted by the `bdsChange` event when the user toggles the checkbox.
+ *
+ * Exported so consumers can type their event handlers:
+ * ```typescript
+ * import type { CheckboxChangeDetail } from '@telesign/boreal-web-components';
+ *
+ * checkbox.addEventListener('bdsChange', (e: CustomEvent<CheckboxChangeDetail>) => {
+ *   console.log(e.detail.checked, e.detail.value);
+ * });
+ * ```
+ */
+export interface CheckboxChangeDetail {
+    /** Whether the checkbox is now checked. */
+    checked: boolean;
+    /** The value associated with the checkbox. */
+    value: string;
+}
+export interface ICheckbox {
+    /** Current checked state. */
+    checked: boolean;
+    /** Indeterminate visual state (neither fully checked nor unchecked). */
+    indeterminate: boolean;
+    /** Shows error styling. */
+    error: boolean;
+    /** Value submitted with the form when checked. */
+    value: string;
+    /** Label text. If not provided, use the default slot. */
+    label: string;
+    /** Emitted on every checked change. */
+    valueChange: EventEmitter<boolean>;
+    /** Emitted when the user toggles the checkbox. */
+    bdsChange: EventEmitter<CheckboxChangeDetail>;
+}
+//# sourceMappingURL=ICheckbox.d.ts.map