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

package/dist/collection/components/forms/bds-checkbox/bds-checkbox-card/bds-checkbox-card.js

@@ -0,0 +1,443 @@
+import { formAssociatedMixin } from "../../../../mixins/index";
+import { Host, Mixin, h, } from "@stencil/core";
+import { useFormCheckbox } from "../utils";
+/**
+ * @summary Checkbox card component is a selectable card-based checkbox option.
+ *
+ * @slot - Label content when no `label` prop is provided.
+ * @slot icon - Optional icon rendered to the left of the label.
+ * @slot description - Optional descriptive text rendered below the label.
+ */
+export class BdsCheckboxCard extends Mixin(formAssociatedMixin) {
+    constructor() {
+        this.isDisabled = false;
+        this.isInvalid = false;
+        this.isIndeterminate = false;
+        /** Disables the control. */
+        this.disabled = false;
+        /** Marks the control as required for form submission. */
+        this.required = false;
+        // ---------------------------------------------------------------------------
+        // Props
+        // ---------------------------------------------------------------------------
+        /** Value submitted with the form when this checkbox is selected. */
+        this.value = 'on';
+        /** Label text displayed next to the checkbox indicator. Falls back to the default slot when empty. */
+        this.label = '';
+        /** Whether this checkbox card is selected. */
+        this.checked = false;
+        /** Whether the checkbox card shows an indeterminate visual state. */
+        this.indeterminate = false;
+        /** Whether the checkbox card is in an error state. */
+        this.error = false;
+        this.formCheckbox = useFormCheckbox(this, this.value);
+        this.handleClick = () => this.toggle();
+        this.handleKeyDown = (e) => {
+            if (e.key === ' ') {
+                e.preventDefault();
+                this.toggle();
+            }
+        };
+        super();
+    }
+    componentWillLoad() {
+        this.isDisabled = this.disabled;
+        this.isIndeterminate = this.indeterminate;
+    }
+    componentDidLoad() {
+        this.formCheckbox.syncFormValue();
+    }
+    onDisabledChange(next) {
+        this.isDisabled = next;
+    }
+    onIndeterminateChange(next) {
+        this.isIndeterminate = next;
+    }
+    onCheckedChange(next) {
+        this.checked = next !== false;
+        this.formCheckbox.syncFormValue();
+    }
+    /** Reports the group's validity state to the user, showing native validation UI if invalid. */
+    async checkValidity() {
+        return this.internals.checkValidity();
+    }
+    /** Reports the group's validity state to the user, showing native validation UI if invalid. */
+    async reportValidity() {
+        return this.internals.reportValidity();
+    }
+    handleInvalid(_event) {
+        this.isInvalid = true;
+    }
+    toggle() {
+        if (this.isDisabled)
+            return;
+        if (this.isIndeterminate)
+            this.isIndeterminate = false;
+        this.checked = !this.checked;
+        this.bdsChange.emit({ checked: this.checked, value: this.value });
+        this.valueChange.emit(this.checked);
+    }
+    get hostClasses() {
+        return {
+            'bds-checkbox-card': true,
+            'bds-checkbox-card--checked': this.checked,
+            'bds-checkbox-card--indeterminate': this.isIndeterminate,
+            'bds-checkbox-card--disabled': this.isDisabled,
+            'bds-checkbox-card--error': this.isError,
+        };
+    }
+    // ---------------------------------------------------------------------------
+    // Form-associated callbacks (IFormControl)
+    // ---------------------------------------------------------------------------
+    formAssociatedCallback() {
+        this.formCheckbox.formAssociatedCallback();
+    }
+    formResetCallback() {
+        this.formCheckbox.formResetCallback();
+    }
+    formStateRestoreCallback(state) {
+        this.formCheckbox.formStateRestoreCallback(state);
+    }
+    formDisabledCallback(disabled) {
+        this.formCheckbox.formDisabledCallback(disabled);
+    }
+    get isError() {
+        const error = this.error && !this.disabled;
+        return error || this.isInvalid;
+    }
+    render() {
+        return (h(Host, { key: 'cb39b373d8bbbbe137a74a001f91c73b444d0c8e', class: this.hostClasses, role: "checkbox", "aria-checked": this.isIndeterminate ? 'mixed' : `${this.checked}`, "aria-disabled": this.isDisabled ? 'true' : null, "aria-required": this.required ? 'true' : null, "aria-invalid": this.isError ? 'true' : null, "aria-label": this.label || this.name || undefined, tabIndex: this.isDisabled ? -1 : 0, onClick: this.handleClick, onKeyDown: this.handleKeyDown }, h("bds-checkbox", { key: '3375dc0b18a424f5f140143626b2bcdc73c298b0', name: this.name, class: "bds-checkbox-card__checkbox", ref: () => this.checkboxElement, value: this.value, checked: this.checked, indeterminate: this.isIndeterminate, disabled: this.isDisabled, error: this.isError, tabIndex: -1, "aria-hidden": "true", onBdsChange: e => e.preventDefault() }), h("div", { key: 'beba4396fb8c0830ffdb05b62482f0ff63aab0d7', class: "bds-checkbox-card__card" }, h("div", { key: 'f369995cc0dbeecfd7670d271ff041240a6dcb65', class: "bds-checkbox-card__content" }, h("div", { key: '12848e5aef69157ca5d144a2815e7b64a654cbe6', class: "bds-checkbox-card__header" }, h("div", { key: '18c72637c1dfb0037b7d2e7fc8cb5004bdeafb0b', class: "bds-checkbox-card__icon" }, h("slot", { key: '7e2979ea18f5c29ecdf629851378aa9efb9e39f6', name: "icon" })), h("div", { key: '0aedaf532433d3deb899f6f6fd6826589850fd71', class: "bds-checkbox-card__title" }, this.label || h("slot", { key: '43a0a9b10edc6f4ee73b5995912889728648d5d6' }))), h("div", { key: '8c89db4ab52395c75f8a1a826ace5aa0f0dbae10', class: "bds-checkbox-card__description" }, h("slot", { key: '174e70254d531fa80d8d19b419587837a4a676ea', name: "description" }))))));
+    }
+    static get is() { return "bds-checkbox-card"; }
+    static get formAssociated() { return true; }
+    static get originalStyleUrls() {
+        return {
+            "$": ["bds-checkbox-card.scss"]
+        };
+    }
+    static get styleUrls() {
+        return {
+            "$": ["bds-checkbox-card.css"]
+        };
+    }
+    static get properties() {
+        return {
+            "name": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "ICheckboxCard['name']",
+                    "resolved": "string",
+                    "references": {
+                        "ICheckboxCard": {
+                            "location": "import",
+                            "path": "./types/ICheckboxCard",
+                            "id": "src/components/forms/bds-checkbox/bds-checkbox-card/types/ICheckboxCard.ts::ICheckboxCard",
+                            "referenceLocation": "ICheckboxCard"
+                        }
+                    }
+                },
+                "required": true,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "Name of the form control, submitted as a key in the form data."
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": true,
+                "attribute": "name"
+            },
+            "disabled": {
+                "type": "boolean",
+                "mutable": false,
+                "complexType": {
+                    "original": "ICheckboxCard['disabled']",
+                    "resolved": "boolean",
+                    "references": {
+                        "ICheckboxCard": {
+                            "location": "import",
+                            "path": "./types/ICheckboxCard",
+                            "id": "src/components/forms/bds-checkbox/bds-checkbox-card/types/ICheckboxCard.ts::ICheckboxCard",
+                            "referenceLocation": "ICheckboxCard"
+                        }
+                    }
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "Disables the control."
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": true,
+                "attribute": "disabled",
+                "defaultValue": "false"
+            },
+            "required": {
+                "type": "boolean",
+                "mutable": false,
+                "complexType": {
+                    "original": "ICheckboxCard['required']",
+                    "resolved": "boolean",
+                    "references": {
+                        "ICheckboxCard": {
+                            "location": "import",
+                            "path": "./types/ICheckboxCard",
+                            "id": "src/components/forms/bds-checkbox/bds-checkbox-card/types/ICheckboxCard.ts::ICheckboxCard",
+                            "referenceLocation": "ICheckboxCard"
+                        }
+                    }
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "Marks the control as required for form submission."
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": true,
+                "attribute": "required",
+                "defaultValue": "false"
+            },
+            "value": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "ICheckboxCard['value']",
+                    "resolved": "string",
+                    "references": {
+                        "ICheckboxCard": {
+                            "location": "import",
+                            "path": "./types/ICheckboxCard",
+                            "id": "src/components/forms/bds-checkbox/bds-checkbox-card/types/ICheckboxCard.ts::ICheckboxCard",
+                            "referenceLocation": "ICheckboxCard"
+                        }
+                    }
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "Value submitted with the form when this checkbox is selected."
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": true,
+                "attribute": "value",
+                "defaultValue": "'on'"
+            },
+            "label": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "ICheckboxCard['label']",
+                    "resolved": "string",
+                    "references": {
+                        "ICheckboxCard": {
+                            "location": "import",
+                            "path": "./types/ICheckboxCard",
+                            "id": "src/components/forms/bds-checkbox/bds-checkbox-card/types/ICheckboxCard.ts::ICheckboxCard",
+                            "referenceLocation": "ICheckboxCard"
+                        }
+                    }
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "Label text displayed next to the checkbox indicator. Falls back to the default slot when empty."
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": false,
+                "attribute": "label",
+                "defaultValue": "''"
+            },
+            "checked": {
+                "type": "boolean",
+                "mutable": true,
+                "complexType": {
+                    "original": "ICheckboxCard['checked']",
+                    "resolved": "boolean",
+                    "references": {
+                        "ICheckboxCard": {
+                            "location": "import",
+                            "path": "./types/ICheckboxCard",
+                            "id": "src/components/forms/bds-checkbox/bds-checkbox-card/types/ICheckboxCard.ts::ICheckboxCard",
+                            "referenceLocation": "ICheckboxCard"
+                        }
+                    }
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "Whether this checkbox card is selected."
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": true,
+                "attribute": "checked",
+                "defaultValue": "false"
+            },
+            "indeterminate": {
+                "type": "boolean",
+                "mutable": false,
+                "complexType": {
+                    "original": "ICheckboxCard['indeterminate']",
+                    "resolved": "boolean",
+                    "references": {
+                        "ICheckboxCard": {
+                            "location": "import",
+                            "path": "./types/ICheckboxCard",
+                            "id": "src/components/forms/bds-checkbox/bds-checkbox-card/types/ICheckboxCard.ts::ICheckboxCard",
+                            "referenceLocation": "ICheckboxCard"
+                        }
+                    }
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "Whether the checkbox card shows an indeterminate visual state."
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": true,
+                "attribute": "indeterminate",
+                "defaultValue": "false"
+            },
+            "error": {
+                "type": "boolean",
+                "mutable": false,
+                "complexType": {
+                    "original": "ICheckboxCard['error']",
+                    "resolved": "boolean",
+                    "references": {
+                        "ICheckboxCard": {
+                            "location": "import",
+                            "path": "./types/ICheckboxCard",
+                            "id": "src/components/forms/bds-checkbox/bds-checkbox-card/types/ICheckboxCard.ts::ICheckboxCard",
+                            "referenceLocation": "ICheckboxCard"
+                        }
+                    }
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "Whether the checkbox card is in an error state."
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": true,
+                "attribute": "error",
+                "defaultValue": "false"
+            }
+        };
+    }
+    static get states() {
+        return {
+            "isDisabled": {},
+            "isInvalid": {},
+            "isIndeterminate": {}
+        };
+    }
+    static get events() {
+        return [{
+                "method": "valueChange",
+                "name": "valueChange",
+                "bubbles": true,
+                "cancelable": true,
+                "composed": true,
+                "docs": {
+                    "tags": [],
+                    "text": "Emitted when the checked state changes. Useful for 2-way binding / v-model."
+                },
+                "complexType": {
+                    "original": "any",
+                    "resolved": "any",
+                    "references": {}
+                }
+            }, {
+                "method": "bdsChange",
+                "name": "bdsChange",
+                "bubbles": true,
+                "cancelable": true,
+                "composed": true,
+                "docs": {
+                    "tags": [],
+                    "text": "Emitted when the user toggles this checkbox card."
+                },
+                "complexType": {
+                    "original": "any",
+                    "resolved": "any",
+                    "references": {}
+                }
+            }];
+    }
+    static get methods() {
+        return {
+            "checkValidity": {
+                "complexType": {
+                    "signature": "() => Promise<boolean>",
+                    "parameters": [],
+                    "references": {
+                        "Promise": {
+                            "location": "global",
+                            "id": "global::Promise"
+                        }
+                    },
+                    "return": "Promise<boolean>"
+                },
+                "docs": {
+                    "text": "Reports the group's validity state to the user, showing native validation UI if invalid.",
+                    "tags": []
+                }
+            },
+            "reportValidity": {
+                "complexType": {
+                    "signature": "() => Promise<boolean>",
+                    "parameters": [],
+                    "references": {
+                        "Promise": {
+                            "location": "global",
+                            "id": "global::Promise"
+                        }
+                    },
+                    "return": "Promise<boolean>"
+                },
+                "docs": {
+                    "text": "Reports the group's validity state to the user, showing native validation UI if invalid.",
+                    "tags": []
+                }
+            }
+        };
+    }
+    static get elementRef() { return "el"; }
+    static get watchers() {
+        return [{
+                "propName": "disabled",
+                "methodName": "onDisabledChange"
+            }, {
+                "propName": "indeterminate",
+                "methodName": "onIndeterminateChange"
+            }, {
+                "propName": "checked",
+                "methodName": "onCheckedChange"
+            }];
+    }
+    static get listeners() {
+        return [{
+                "name": "invalid",
+                "method": "handleInvalid",
+                "target": undefined,
+                "capture": false,
+                "passive": false
+            }];
+    }
+    static get attachInternalsMemberName() { return "internals"; }
+}

package/dist/collection/components/forms/bds-checkbox/bds-checkbox-group/bds-checkbox-group.css

@@ -0,0 +1,55 @@
+@charset "UTF-8";
+/**
+* Common SCSS placeholder selectors shared across form and layout components.
+* This file is injected globally via `injectGlobalPaths` in `stencil.config.ts`,
+* so all component stylesheets can `@extend` these placeholders without an explicit import.
+*
+* NOTE: Placeholders must only use raw CSS values — `$boreal-*` token variables
+* are not available at this level util use style-guidelines.
+*/
+/**
+ * TODO: Refactor to use styleguidelines this work as first draft
+ **/
+/**
+* This file contains mixins and functions for common interactions styles such as focus rings and transitions.
+* These are used across multiple components to ensure consistency in interaction feedback.
+*/
+.bds-checkbox-group {
+  /**
+   * @prop --layout-count: Defines the number of columns for horizontal orientation. Default is 1.
+   */
+  --bds-divider-gap: var(--boreal-spacing-3xs);
+  display: flex;
+  flex-direction: column;
+  gap: var(--boreal-spacing-2xs);
+}
+.bds-checkbox-group__options {
+  display: grid;
+  grid-template-columns: 1fr;
+  gap: var(--boreal-spacing-xs);
+}
+.bds-checkbox-group[orientation=horizontal] .bds-checkbox-group__options {
+  grid-template-columns: repeat(var(--layout-count, 1), auto);
+  justify-content: start;
+}
+.bds-checkbox-group[type=checkboxbutton] .bds-checkbox-group__options {
+  display: inline-flex;
+  gap: 0;
+  padding: var(--boreal-spacing-3xs);
+  border: 1px solid var(--boreal-stroke-default-light);
+  background-color: var(--boreal-ui-inverse);
+  border-radius: var(--boreal-radius-xs);
+  overflow: hidden;
+}
+.bds-checkbox-group[type=checkboxbutton][orientation=vertical] .bds-checkbox-group__options {
+  flex-direction: column;
+}
+.bds-checkbox-group[type=checkboxbutton].bds-checkbox-group--error .bds-checkbox-group__options {
+  border-color: var(--boreal-stroke-danger-base);
+}
+.bds-checkbox-group[type=checkboxbutton].bds-checkbox-group--error bds-checkbox-button.bds-checkbox-button--error {
+  color: var(--boreal-stroke-danger-base);
+}
+.bds-checkbox-group[type=checkboxbutton].bds-checkbox-group--error bds-divider[data-injected] {
+  --bds-divider-color: var(--boreal-stroke-danger-base);
+}