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

package/dist/collection/components/forms/bds-checkbox/{bds-checkbox.js → bds-checkbox/bds-checkbox.js}

@@ -1,7 +1,9 @@
 import { Host, Mixin, h, } from "@stencil/core";
-import { formAssociatedMixin } from "../../../mixins/form-associated.mixin";
-import { setFormValue } from "../../../utils/form/index";
-import { inheritAriaAttributes } from "../../../utils/a11y/attributes";
+import { formAssociatedMixin } from "../../../../mixins/form-associated.mixin";
+import { inheritAriaAttributes } from "../../../../utils/a11y/attributes";
+import { KeyboardController, KEYBOARD } from "../../../../utils/index";
+import { useFormCheckbox } from "../utils";
+import { createId } from "../../../../utils/index";
 /**
  * Checkbox component for boolean selection with three visual states.
  *
@@ -21,11 +23,23 @@ import { inheritAriaAttributes } from "../../../utils/a11y/attributes";
 export class BdsCheckbox extends Mixin(formAssociatedMixin) {
     constructor() {
         this.inheritedAttributes = {};
+        this._keyboard = new KeyboardController();
+        this._id = createId('bds-checkbox');
         /** Internal mirror of the `disabled` prop, kept in sync via `@Watch` and `formDisabledCallback`. */
         this.isDisabled = false;
-        /** Disables the control. */
+        /** Set to true when native form validation fires the `invalid` event; cleared on reset or when value becomes valid. */
+        this.isInvalid = false;
+        // ---------------------------------------------------------------------------
+        // Props (from formAssociatedMixin — redeclared here because Stencil's spec-
+        // test compiler only sees @Prop decorators that are statically on the class)
+        // ---------------------------------------------------------------------------
+        /** Name of the form control, submitted as a key in the form data. */
+        this.name = '';
+        /** Tooltip text for the checkbox. */
+        this.info = '';
+        /** Disables the checkbox. */
         this.disabled = false;
-        /** Marks the control as required for form submission. */
+        /** Marks the checkbox as required for form submission. */
         this.required = false;
         // ---------------------------------------------------------------------------
         // Props
@@ -40,15 +54,10 @@ export class BdsCheckbox extends Mixin(formAssociatedMixin) {
         this.value = 'on';
         /** Label displayed next to the checkbox. If not provided, the default slot is used. */
         this.label = '';
+        this.formCheckbox = useFormCheckbox(this, this.value);
         this.handleClick = () => {
             this.toggle();
         };
-        this.handleKeyDown = (e) => {
-            if (e.key === ' ') {
-                e.preventDefault();
-                this.toggle();
-            }
-        };
         super();
     }
     // ---------------------------------------------------------------------------
@@ -59,13 +68,22 @@ export class BdsCheckbox extends Mixin(formAssociatedMixin) {
         this.inheritedAttributes = {
             ...inheritAriaAttributes(this.el),
         };
-        this.syncFormValue();
+    }
+    componentDidLoad() {
+        this.formCheckbox.syncFormValue();
+        this._keyboard.attach(this.el).set(KEYBOARD.Space, () => {
+            if (!this.isDisabled)
+                this.toggle();
+        });
+    }
+    disconnectedCallback() {
+        this._keyboard.detach();
     }
     // ---------------------------------------------------------------------------
     // Watchers
     // ---------------------------------------------------------------------------
     onCheckedChange() {
-        this.syncFormValue();
+        this.formCheckbox.syncFormValue();
     }
     onDisabledChange(next) {
         this.isDisabled = next;
@@ -74,26 +92,32 @@ export class BdsCheckbox extends Mixin(formAssociatedMixin) {
     // Form-associated callbacks (IFormControl)
     // ---------------------------------------------------------------------------
     formAssociatedCallback() {
-        this.syncFormValue();
+        this.formCheckbox.formAssociatedCallback();
     }
     formResetCallback() {
-        this.checked = false;
-        this.indeterminate = false;
-        setFormValue(this.internals, null);
+        this.formCheckbox.formResetCallback();
     }
-    formStateRestoreCallback(state, _mode) {
-        this.checked = state === this.value;
-        this.syncFormValue();
+    formStateRestoreCallback(state) {
+        this.formCheckbox.formStateRestoreCallback(state);
     }
     formDisabledCallback(disabled) {
-        this.isDisabled = disabled;
+        this.formCheckbox.formDisabledCallback(disabled);
+    }
+    /** 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) {
+        event.preventDefault();
+        this.isInvalid = true;
     }
     // ---------------------------------------------------------------------------
     // Private helpers
     // ---------------------------------------------------------------------------
-    syncFormValue() {
-        setFormValue(this.internals, this.checked ? this.value : null);
-    }
     toggle() {
         if (this.isDisabled)
             return;
@@ -102,13 +126,20 @@ export class BdsCheckbox extends Mixin(formAssociatedMixin) {
         this.valueChange.emit(this.checked);
         this.bdsChange.emit({ checked: this.checked, value: this.value });
     }
+    get isError() {
+        const error = this.error && !this.disabled;
+        return error || this.isInvalid;
+    }
     // ---------------------------------------------------------------------------
     // Render helpers
     // ---------------------------------------------------------------------------
     getAriaChecked() {
         if (this.indeterminate)
             return 'mixed';
-        return this.checked ? 'true' : 'false';
+        return `${this.checked}`;
+    }
+    get hideFromScreenReaders() {
+        return this.el.closest('bds-checkbox-card') !== null || this.isDisabled;
     }
     renderCheckIcon() {
         if (this.indeterminate) {
@@ -122,15 +153,18 @@ export class BdsCheckbox extends Mixin(formAssociatedMixin) {
     // ---------------------------------------------------------------------------
     // Render
     // ---------------------------------------------------------------------------
-    render() {
-        const classes = {
+    getClasses() {
+        return {
             'bds-checkbox': true,
             'bds-checkbox--checked': this.checked,
             'bds-checkbox--indeterminate': this.indeterminate,
-            'bds-checkbox--error': this.error,
+            'bds-checkbox--error': this.isError,
             'bds-checkbox--disabled': this.isDisabled,
         };
-        return (h(Host, { key: '4c2aa0c0e06451d258204ed2aaf92c41f730a2a8', class: classes, ...this.inheritedAttributes, role: "checkbox", "aria-checked": this.getAriaChecked(), "aria-disabled": this.isDisabled ? 'true' : null, tabindex: this.isDisabled ? -1 : 0, onClick: this.handleClick, onKeyDown: this.handleKeyDown }, h("span", { key: 'de6763aaef951d9236cbf4df7ac49fd09f998e93', class: "bds-checkbox__box" }, this.renderCheckIcon()), h("span", { key: '571e62e3cde00561465a155bc1399f6074516a03', class: "bds-checkbox__label" }, this.label ? this.label : h("slot", null))));
+    }
+    render() {
+        const labelId = `${this._id}-label`;
+        return (h(Host, { key: '2d1fa28a22f182826625c313ffaf3a98d0784d0c', class: this.getClasses(), ...this.inheritedAttributes, role: "checkbox", "aria-required": this.required ? 'true' : null, "aria-checked": this.getAriaChecked(), "aria-disabled": this.isDisabled ? 'true' : null, "aria-invalid": this.isError ? 'true' : null, "aria-hidden": this.hideFromScreenReaders ? 'true' : null, "aria-labelledby": labelId || undefined, tabindex: this.hideFromScreenReaders ? -1 : 0, onClick: this.handleClick }, h("input", { key: 'f8e3ca7085aa01a10e7fe397daf10f18024ce254', type: "checkbox", value: this.value, checked: this.checked, disabled: this.disabled, required: this.required, "aria-hidden": "true", tabIndex: -1, onFocus: () => this.el.focus() }), h("span", { key: '397626b30b104d317a8c48554e8b8f6396c9a441', class: "bds-checkbox__box" }, this.renderCheckIcon()), h("span", { key: 'f8aec05775f2819d3c9fd510378bb74a9e22cc5e', class: "bds-checkbox__content" }, h("span", { key: '2956fccc6a6c7aa8624bb43798ece435cec7fbc0', class: "bds-checkbox__icon" }, h("slot", { key: '845c326874e4b854b71a6f0a360e6e692629b683', name: "icon" })), h("label", { key: '35531d1619a81972e29bf5332012b51e19fa3223', id: labelId, class: "bds-checkbox__label" }, this.label.trim() !== '' ? this.label : h("slot", null)), this.required && (h("em", { key: '81ea33ec4c831dea9029680b2ed7fff230849f4a', class: "bds-checkbox__required-indicator", "aria-hidden": "true" }, "*")), this.info && (h("span", { key: '237ad3a810ac31a95e59dc819ca118e8ab94763b', class: "bds-checkbox__info" }, h("span", { key: 'b83aa05c6b5468e7f57b3f36fd5e3ac770d5b985', class: "bds-checkbox__info-icon bds-icon-info-circle", "aria-hidden": "true" }), h("bds-tooltip", { key: '572f7ab57a6144bdd5e22e0ee38a395cda7300d3' }, this.info))))));
     }
     static get is() { return "bds-checkbox"; }
     static get formAssociated() { return true; }
@@ -154,7 +188,7 @@ export class BdsCheckbox extends Mixin(formAssociatedMixin) {
                     "resolved": "string",
                     "references": {}
                 },
-                "required": true,
+                "required": false,
                 "optional": false,
                 "docs": {
                     "tags": [],
@@ -163,7 +197,28 @@ export class BdsCheckbox extends Mixin(formAssociatedMixin) {
                 "getter": false,
                 "setter": false,
                 "reflect": true,
-                "attribute": "name"
+                "attribute": "name",
+                "defaultValue": "''"
+            },
+            "info": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "Tooltip text for the checkbox."
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": true,
+                "attribute": "info",
+                "defaultValue": "''"
             },
             "disabled": {
                 "type": "boolean",
@@ -177,7 +232,7 @@ export class BdsCheckbox extends Mixin(formAssociatedMixin) {
                 "optional": false,
                 "docs": {
                     "tags": [],
-                    "text": "Disables the control."
+                    "text": "Disables the checkbox."
                 },
                 "getter": false,
                 "setter": false,
@@ -197,7 +252,7 @@ export class BdsCheckbox extends Mixin(formAssociatedMixin) {
                 "optional": false,
                 "docs": {
                     "tags": [],
-                    "text": "Marks the control as required for form submission."
+                    "text": "Marks the checkbox as required for form submission."
                 },
                 "getter": false,
                 "setter": false,
@@ -309,7 +364,8 @@ export class BdsCheckbox extends Mixin(formAssociatedMixin) {
     }
     static get states() {
         return {
-            "isDisabled": {}
+            "isDisabled": {},
+            "isInvalid": {}
         };
     }
     static get events() {
@@ -344,7 +400,7 @@ export class BdsCheckbox extends Mixin(formAssociatedMixin) {
                     "references": {
                         "CheckboxChangeDetail": {
                             "location": "import",
-                            "path": "./types/ICheckbox",
+                            "path": "../types/ICheckbox",
                             "id": "src/components/forms/bds-checkbox/types/ICheckbox.ts::CheckboxChangeDetail",
                             "referenceLocation": "CheckboxChangeDetail"
                         }
@@ -352,6 +408,44 @@ export class BdsCheckbox extends Mixin(formAssociatedMixin) {
                 }
             }];
     }
+    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 [{
@@ -362,5 +456,14 @@ export class BdsCheckbox extends Mixin(formAssociatedMixin) {
                 "methodName": "onDisabledChange"
             }];
     }
+    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-button/bds-checkbox-button.css

@@ -0,0 +1,113 @@
+@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-button {
+  display: inline-flex;
+  align-items: center;
+  justify-content: center;
+  width: 100%;
+  gap: var(--boreal-spacing-2xs);
+  padding: var(--boreal-spacing-2xs) var(--boreal-spacing-s);
+  border: 1px solid transparent;
+  border-radius: var(--boreal-radius-s);
+  background-color: var(--boreal-ui-default-base);
+  color: var(--boreal-text-default);
+  cursor: pointer;
+  outline: none;
+  transition: background-color 0.3s ease, border-color 0.3s ease, box-shadow 0.3s ease;
+}
+.bds-checkbox-button input[type=checkbox],
+.bds-checkbox-button input[type=radio] {
+  position: absolute;
+  opacity: 0;
+  width: 0;
+  height: 0;
+  margin: 0;
+  pointer-events: none;
+}
+.bds-checkbox-button [slot=icon] {
+  display: inline-flex;
+  align-items: center;
+}
+.bds-checkbox-button:hover:not(.bds-checkbox-button--disabled):not(.bds-checkbox-button--checked):not(.bds-checkbox-button--error) {
+  background-color: var(--boreal-ui-default-lighter);
+  box-shadow: var(--boreal-depth-box-shadow-xs);
+}
+.bds-checkbox-button:focus-visible, .bds-checkbox-button:focus {
+  z-index: 1;
+  background-color: var(--boreal-ui-default-lighter);
+  box-shadow: var(--boreal-depth-box-shadow-focus);
+  outline: none;
+}
+.bds-checkbox-button:active:not(.bds-checkbox-button--disabled):not(.bds-checkbox-button--checked):not(.bds-checkbox-button--error) {
+  z-index: 1;
+  background-color: var(--boreal-ui-default-lighter);
+  box-shadow: var(--boreal-depth-box-shadow-active);
+}
+.bds-checkbox-button--checked {
+  background-color: var(--boreal-ui-inverse);
+  border-color: var(--boreal-stroke-primary-base);
+  color: var(--boreal-text-primary-base);
+}
+.bds-checkbox-button--checked:hover, .bds-checkbox-button--checked:focus-visible, .bds-checkbox-button--checked:focus, .bds-checkbox-button--checked:active {
+  background-color: var(--boreal-ui-primary-lighter);
+}
+.bds-checkbox-button--error {
+  background-color: var(--boreal-ui-inverse);
+  color: var(--boreal-text-danger-base);
+}
+.bds-checkbox-button--error:hover, .bds-checkbox-button--error:focus-visible, .bds-checkbox-button--error:focus, .bds-checkbox-button--error:active {
+  background-color: var(--boreal-ui-danger-lighter);
+}
+.bds-checkbox-button--error.bds-checkbox-button--checked {
+  border-color: var(--boreal-stroke-danger-base);
+}
+.bds-checkbox-button--disabled {
+  cursor: not-allowed;
+  pointer-events: none;
+  background-color: var(--boreal-ui-inverse);
+  color: var(--boreal-text-disabled);
+}
+.bds-checkbox-button--disabled.bds-checkbox-button--checked {
+  border-color: var(--boreal-stroke-primary-light);
+  color: var(--boreal-text-primary-light);
+}
+.bds-checkbox-button__label {
+  font-family: var(--boreal-typography-font-family-primary);
+  font-size: var(--boreal-typography-font-size-sm);
+  font-weight: var(--boreal-typography-font-weight-semibold);
+  line-height: var(--boreal-typography-line-height-sm);
+}
+.bds-checkbox-button__info {
+  display: inline-flex;
+  align-items: center;
+}
+.bds-checkbox-button__icon {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+}
+.bds-checkbox-button__icon:empty {
+  display: none;
+}
+.bds-checkbox-button__info-icon {
+  display: inline-flex;
+  align-items: center;
+  justify-content: center;
+  font-size: var(--boreal-typography-font-size-sm);
+  line-height: 1;
+  color: var(--boreal-icon-default-ink);
+}