@tmorrow/cre8-wc 1.1.2 → 1.1.3

package/lib/components/select-tile/select-tile-radio-controller.js

@@ -0,0 +1,167 @@
+/**
+ * Helper function to wrap indexes around, to help us treat the array as a ring.
+ */
+function wrapIndex(arr, index) {
+    if (index < 0) {
+        return arr.length - 1;
+    }
+    if (index >= arr.length) {
+        return 0;
+    }
+    return index;
+}
+/**
+ * This Controller handles the special radio button logic.
+ *
+ * - Handle clicks and key presses, which involves
+ *   - Unchecking other select-tile's when this one is checked, if they are in the same form.
+ *   - Changing focus between `0` and `-1`, and moving focus correctly on key press
+ *   - checking/unchecking on spacebar
+ *
+ * See also https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/radio_role
+ * and https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/radiogroup_role
+ *
+ * Also see https://html.spec.whatwg.org/multipage/custom-elements.html#custom-elements-autonomous-drawbacks
+ *
+ * This started out as a copy of radio-field-item.ts.
+ *
+ * Part of the reason I extracted this was to see if I could share this logic with radio-field-item,
+ * but that would be separate refactor.
+ *
+ * It might also be good for the "checkbox" mode of select-tile.
+ *
+ * And it might also just be a cleaner separation of concerns.
+ */
+export class SelectTileRadioController {
+    constructor(host) {
+        /**
+         * Handle clicking on the radio button
+         * @see _checkAndFocus
+         */
+        this._clickHandler = (e) => {
+            e.preventDefault();
+            this._checkAndFocus(this.host);
+        };
+        /**
+         * Set the element to `checked`
+         * 1) Remove `checked` and set tabindex to -1 on all elements in our radio group
+         * 2) Set us to checked.
+         * 3) Set our tabindex to 0
+         */
+        this._checkAndFocus = (target) => {
+            const wasChecked = target.checked;
+            this.removeChecked(); /* 1 */
+            target.focus();
+            target.checked = true; /* 2 */
+            target.setAttribute('tabindex', '0'); /* 3 */
+            if (!wasChecked) {
+                target.dispatchEvent(new Event('input', { bubbles: true, composed: true }));
+                target.dispatchEvent(new Event('change', { bubbles: true }));
+            }
+        };
+        /**
+         * Handle keydown
+         * 1) If left or up arrow key is struck and radio field item exists before current item,
+         *    remove checked from all items and add it to the next item
+         * 2) If right or down arrow key is struck and radio field item exists after current item,
+         *    remove checked from all items and add checked to the next item.
+         *    Focus on this item and set tabindex for when focusing out of radio field and back onto checked item.
+         * 3) If the element is in focused, then for event emission the
+         *    current focues element should be clicked to emit event.
+         * 4) If the Enter key is pressed, then check the radio if no other radio items are checked
+         */
+        this._handleKeyDown = (e) => {
+            // The arrow keys
+            if (['ArrowLeft', 'ArrowUp', 'ArrowRight', 'ArrowDown'].includes(e.code)) {
+                this._handleArrowKeys(e);
+            }
+            // Enter and Space
+            if (['Enter', ' '].includes(e.key)) {
+                this._handleEnterSpace(e);
+            }
+        };
+        this._handleArrowKeys = (e) => {
+            const siblings = this.findAllElementsInSameRadioButtonGroup({ excludeDisabled: true });
+            // If we're the only radio-like element, nothing to do
+            if (siblings.length <= 1) {
+                return;
+            }
+            const ourIndex = siblings.findIndex((item) => item === this.host);
+            let moveToElement;
+            if (e.code === 'ArrowLeft' || e.code === 'ArrowUp') {
+                moveToElement = siblings[wrapIndex(siblings, ourIndex - 1)];
+            }
+            else if (e.code === 'ArrowRight' || e.code === 'ArrowDown') {
+                moveToElement = siblings[wrapIndex(siblings, ourIndex + 1)];
+            }
+            this._checkAndFocus(moveToElement);
+            e.preventDefault();
+        };
+        /**
+         * Handle Enter and Space
+         * @see _checkAndFocus
+         */
+        this._handleEnterSpace = (e) => {
+            this._checkAndFocus(this.host);
+            e.preventDefault();
+        };
+        this.host = host;
+        host.addController(this);
+    }
+    hostConnected() {
+        this.host._internals.role = 'radio';
+        // If we don't also do this, we can't use css selectors to find ourselves
+        this.host.setAttribute('role', 'radio');
+        this.host.setAttribute('tabindex', '0');
+        this.host.addEventListener('click', this._clickHandler);
+        this.host.addEventListener('keydown', this._handleKeyDown);
+    }
+    hostDisconnected() {
+        this.host._internals.role = undefined;
+        this.host.removeAttribute('role');
+        this.host.removeAttribute('tabindex');
+        this.host.removeEventListener('click', this._clickHandler);
+        this.host.removeEventListener('keydown', this._handleKeyDown);
+    }
+    hostUpdate() {
+        // TODO: do stuff if name, checked, etc change.
+    }
+    /**
+     * Find all elements that are in the same "radio button group", following the HTML 5 spec,
+     * except that we're looking at `[role="radio"]` instead of `input[type="radio"]`.
+     *
+     * - They have the attribute role="radio" set
+     * - They have the same form owner, or both have no form owner
+     * - They're in the same tree (same document, don't look at shadow dom)
+     * - They both have non-empty name attributes, and the names are the same
+     *
+     */
+    findAllElementsInSameRadioButtonGroup({ excludeDisabled } = {}) {
+        const name = this.host.name;
+        const form = this.host.form;
+        if (name && name.length > 0) {
+            const document = this.host.ownerDocument;
+            const matches = Array.from(document.querySelectorAll(`[role="radio"][name="${name}"]`)).filter((element) => element.form === form);
+            if (excludeDisabled === true) {
+                return matches
+                    .filter((element) => !(element.disabled || element.ariaDisabled === 'true'));
+            }
+            return matches;
+        }
+        return [];
+    }
+    /**
+      * Remove checked
+      * 1) Reset the form field to not checked
+      * 2) Remove checked property from all items and set tabindex to -1
+      */
+    removeChecked() {
+        const radioFieldItems = this.findAllElementsInSameRadioButtonGroup();
+        radioFieldItems.forEach((element) => {
+            element.checked = false; /* 1 */
+            element.setAttribute('tabindex', '-1'); /* 2 */
+        });
+    }
+}
+export default SelectTileRadioController;
+//# sourceMappingURL=select-tile-radio-controller.js.map

package/lib/components/select-tile/select-tile-radio-controller.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"select-tile-radio-controller.js","sourceRoot":"","sources":["../../../components/select-tile/select-tile-radio-controller.ts"],"names":[],"mappings":"AAMA;;GAEG;AACH,SAAS,SAAS,CAAC,GAAc,EAAE,KAAa;IAC5C,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QACZ,OAAO,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC;IAC1B,CAAC;IAAC,IAAI,KAAK,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;QACxB,OAAO,CAAC,CAAC;IACb,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,yBAAyB;IAGlC,YAAY,IAAiB;QAwE/B;;;WAGG;QACO,kBAAa,GAAG,CAAC,CAA6B,EAAE,EAAE;YACtD,CAAC,CAAC,cAAc,EAAE,CAAC;YACnB,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnC,CAAC,CAAC;QAEJ;;;;;WAKG;QACO,mBAAc,GAAG,CAAC,MAA2C,EAAE,EAAE;YACrE,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC;YAClC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC,OAAO;YAC7B,MAAM,CAAC,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC,OAAO;YAC9B,MAAM,CAAC,YAAY,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,CAAC,OAAO;YAC7C,IAAI,CAAC,UAAU,EAAE,CAAC;gBACd,MAAM,CAAC,aAAa,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;gBAC5E,MAAM,CAAC,aAAa,CAAC,IAAI,KAAK,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YACjE,CAAC;QACL,CAAC,CAAC;QAEJ;;;;;;;;;;WAUG;QACO,mBAAc,GAAG,CAAC,CAAgB,EAAE,EAAE;YAC9C,iBAAiB;YACb,IAAI,CAAC,WAAW,EAAE,SAAS,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;gBACvE,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC;YAC7B,CAAC;YACL,kBAAkB;YACd,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;gBACjC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;YAC9B,CAAC;QACL,CAAC,CAAC;QAEM,qBAAgB,GAAG,CAAC,CAAgB,EAAE,EAAE;YAC5C,MAAM,QAAQ,GAAG,IAAI,CAAC,qCAAqC,CAAC,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC,CAAC;YAE3F,sDAAsD;YAClD,IAAI,QAAQ,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;gBACvB,OAAO;YACX,CAAC;YAED,MAAM,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC;YAClE,IAAI,aAAkD,CAAC;YACvD,IAAI,CAAC,CAAC,IAAI,KAAK,WAAW,IAAI,CAAC,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBACjD,aAAa,GAAG,QAAQ,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ,GAAG,CAAC,CAAC,CAAgB,CAAC;YAC/E,CAAC;iBAAM,IAAI,CAAC,CAAC,IAAI,KAAK,YAAY,IAAI,CAAC,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;gBAC3D,aAAa,GAAG,QAAQ,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ,GAAG,CAAC,CAAC,CAAgB,CAAC;YAC/E,CAAC;YAED,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;YAEnC,CAAC,CAAC,cAAc,EAAE,CAAC;QACvB,CAAC,CAAC;QAEJ;;;WAGG;QACO,sBAAiB,GAAG,CAAC,CAAgB,EAAE,EAAE;YAC7C,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/B,CAAC,CAAC,cAAc,EAAE,CAAC;QACvB,CAAC,CAAC;QApJE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAED,aAAa;QACT,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,OAAO,CAAC;QACpC,yEAAyE;QACzE,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACxC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;QAExC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QACxD,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IAC/D,CAAC;IAED,gBAAgB;QACZ,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,SAAS,CAAC;QACtC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAClC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QAEtC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QAC3D,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,SAAS,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IAClE,CAAC;IAED,UAAU;QACN,+CAA+C;IACnD,CAAC;IAED;;;;;;;;;OASG;IACH,qCAAqC,CAAC,EAAE,eAAe,KAAmC,EAAE;QACxF,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;QAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;QAC5B,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC;YACzC,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CACtB,QAAQ,CAAC,gBAAgB,CAAC,wBAAwB,IAAI,IAAI,CAAC,CAC9D,CAAC,MAAM,CAAC,CAAC,OAAgD,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;YAEtF,IAAI,eAAe,KAAK,IAAI,EAAE,CAAC;gBAC3B,OAAO,OAAO;qBACT,MAAM,CAAC,CAAC,OAA4C,EAAE,EAAE,CAAC,CAAC,CACvD,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,YAAY,KAAK,MAAM,CACtD,CAAC,CAAC;YACX,CAAC;YAED,OAAO,OAAO,CAAC;QACnB,CAAC;QACD,OAAO,EAAE,CAAC;IACd,CAAC;IAEJ;;;;QAII;IACD,aAAa;QACT,MAAM,eAAe,GAAG,IAAI,CAAC,qCAAqC,EAAE,CAAC;QACrE,eAAe,CAAC,OAAO,CAAC,CAAC,OAA2B,EAAE,EAAE;YACpD,OAAO,CAAC,OAAO,GAAG,KAAK,CAAC,CAAC,OAAO;YAChC,OAAO,CAAC,YAAY,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC,OAAO;QACnD,CAAC,CAAC,CAAC;IACP,CAAC;CAgFJ;AAED,eAAe,yBAAyB,CAAC","sourcesContent":["import { ReactiveController } from 'lit';\nimport { Cre8FormElement } from '../cre8-form-element';\nimport { Cre8RadioFieldItem } from '../radio-field-item/radio-field-item';\n\ntype FormElement = Cre8FormElement & { form: HTMLFormElement, name?: string, checked?: boolean };\n\n/**\n * Helper function to wrap indexes around, to help us treat the array as a ring.\n */\nfunction wrapIndex(arr: unknown[], index: number) {\n    if (index < 0) {\n        return arr.length - 1;\n    } if (index >= arr.length) {\n        return 0;\n    }\n    return index;\n}\n\n/**\n * This Controller handles the special radio button logic.\n *\n * - Handle clicks and key presses, which involves\n *   - Unchecking other select-tile's when this one is checked, if they are in the same form.\n *   - Changing focus between `0` and `-1`, and moving focus correctly on key press\n *   - checking/unchecking on spacebar\n *\n * See also https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/radio_role\n * and https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/radiogroup_role\n *\n * Also see https://html.spec.whatwg.org/multipage/custom-elements.html#custom-elements-autonomous-drawbacks\n *\n * This started out as a copy of radio-field-item.ts.\n *\n * Part of the reason I extracted this was to see if I could share this logic with radio-field-item,\n * but that would be separate refactor.\n *\n * It might also be good for the \"checkbox\" mode of select-tile.\n *\n * And it might also just be a cleaner separation of concerns.\n */\nexport class SelectTileRadioController implements ReactiveController {\n    private host: FormElement;\n\n    constructor(host: FormElement) {\n        this.host = host;\n        host.addController(this);\n    }\n\n    hostConnected(): void {\n        this.host._internals.role = 'radio';\n        // If we don't also do this, we can't use css selectors to find ourselves\n        this.host.setAttribute('role', 'radio');\n        this.host.setAttribute('tabindex', '0');\n\n        this.host.addEventListener('click', this._clickHandler);\n        this.host.addEventListener('keydown', this._handleKeyDown);\n    }\n\n    hostDisconnected(): void {\n        this.host._internals.role = undefined;\n        this.host.removeAttribute('role');\n        this.host.removeAttribute('tabindex');\n\n        this.host.removeEventListener('click', this._clickHandler);\n        this.host.removeEventListener('keydown', this._handleKeyDown);\n    }\n\n    hostUpdate(): void {\n        // TODO: do stuff if name, checked, etc change.\n    }\n\n    /**\n     * Find all elements that are in the same \"radio button group\", following the HTML 5 spec,\n     * except that we're looking at `[role=\"radio\"]` instead of `input[type=\"radio\"]`.\n     *\n     * - They have the attribute role=\"radio\" set\n     * - They have the same form owner, or both have no form owner\n     * - They're in the same tree (same document, don't look at shadow dom)\n     * - They both have non-empty name attributes, and the names are the same\n     *\n     */\n    findAllElementsInSameRadioButtonGroup({ excludeDisabled }: { excludeDisabled?: boolean} = {}) {\n        const name = this.host.name;\n        const form = this.host.form;\n        if (name && name.length > 0) {\n            const document = this.host.ownerDocument;\n            const matches = Array.from(\n                document.querySelectorAll(`[role=\"radio\"][name=\"${name}\"]`)\n            ).filter((element: HTMLElement & { form?: HTMLFormElement}) => element.form === form);\n\n            if (excludeDisabled === true) {\n                return matches\n                    .filter((element: HTMLElement & { disabled?: boolean}) => !(\n                        element.disabled || element.ariaDisabled === 'true'\n                    ));\n            }\n\n            return matches;\n        }\n        return [];\n    }\n\n /**\n   * Remove checked\n   * 1) Reset the form field to not checked\n   * 2) Remove checked property from all items and set tabindex to -1\n   */\n    removeChecked() {\n        const radioFieldItems = this.findAllElementsInSameRadioButtonGroup();\n        radioFieldItems.forEach((element: Cre8RadioFieldItem) => {\n            element.checked = false; /* 1 */\n            element.setAttribute('tabindex', '-1'); /* 2 */\n        });\n    }\n\n  /**\n   * Handle clicking on the radio button\n   * @see _checkAndFocus\n   */\n    private _clickHandler = (e: MouseEvent | KeyboardEvent) => {\n        e.preventDefault();\n        this._checkAndFocus(this.host);\n    };\n\n  /**\n   * Set the element to `checked`\n   * 1) Remove `checked` and set tabindex to -1 on all elements in our radio group\n   * 2) Set us to checked.\n   * 3) Set our tabindex to 0\n   */\n    private _checkAndFocus = (target: HTMLElement & { checked?: boolean }) => {\n        const wasChecked = target.checked;\n        this.removeChecked(); /* 1 */\n        target.focus();\n        target.checked = true; /* 2 */\n        target.setAttribute('tabindex', '0'); /* 3 */\n        if (!wasChecked) {\n            target.dispatchEvent(new Event('input', { bubbles: true, composed: true }));\n            target.dispatchEvent(new Event('change', { bubbles: true }));\n        }\n    };\n\n  /**\n   * Handle keydown\n   * 1) If left or up arrow key is struck and radio field item exists before current item,\n   *    remove checked from all items and add it to the next item\n   * 2) If right or down arrow key is struck and radio field item exists after current item,\n   *    remove checked from all items and add checked to the next item.\n   *    Focus on this item and set tabindex for when focusing out of radio field and back onto checked item.\n   * 3) If the element is in focused, then for event emission the\n   *    current focues element should be clicked to emit event.\n   * 4) If the Enter key is pressed, then check the radio if no other radio items are checked\n   */\n    private _handleKeyDown = (e: KeyboardEvent) => {\n    // The arrow keys\n        if (['ArrowLeft', 'ArrowUp', 'ArrowRight', 'ArrowDown'].includes(e.code)) {\n            this._handleArrowKeys(e);\n        }\n    // Enter and Space\n        if (['Enter', ' '].includes(e.key)) {\n            this._handleEnterSpace(e);\n        }\n    };\n\n    private _handleArrowKeys = (e: KeyboardEvent) => {\n        const siblings = this.findAllElementsInSameRadioButtonGroup({ excludeDisabled: true });\n\n    // If we're the only radio-like element, nothing to do\n        if (siblings.length <= 1) {\n            return;\n        }\n\n        const ourIndex = siblings.findIndex((item) => item === this.host);\n        let moveToElement: HTMLElement & { checked?: boolean };\n        if (e.code === 'ArrowLeft' || e.code === 'ArrowUp') {\n            moveToElement = siblings[wrapIndex(siblings, ourIndex - 1)] as HTMLElement;\n        } else if (e.code === 'ArrowRight' || e.code === 'ArrowDown') {\n            moveToElement = siblings[wrapIndex(siblings, ourIndex + 1)] as HTMLElement;\n        }\n\n        this._checkAndFocus(moveToElement);\n\n        e.preventDefault();\n    };\n\n  /**\n   * Handle Enter and Space\n   * @see _checkAndFocus\n   */\n    private _handleEnterSpace = (e: KeyboardEvent) => {\n        this._checkAndFocus(this.host);\n        e.preventDefault();\n    };\n}\n\nexport default SelectTileRadioController;\n"]}