npm - power-focusable - Versions diffs - 1.0.0 - Mend

power-focusable 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+MIT License
+Copyright (c) 2025 Yusuke Kamiyamane
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md ADDED Viewed

@@ -0,0 +1,98 @@
+# Power Focusable
+High-precision focus management utility with shadow DOM support. Handles complex focus rules.
+## Install
+```bash
+npm i power-focusable
+```
+```ts
+// npm
+import {
+  getFocusables,
+  getNextFocusable,
+  getPreviousFocusable,
+  hasFocusable,
+  isFocusable,
+} from 'power-focusable';
+// CDNs
+import { ... } 'https://esm.sh/power-focusable'
+// or
+import { ... } 'https://cdn.jsdelivr.net/npm/power-focusable/dist/index.js';
+// or
+import { ... } 'https://unpkg.com/power-focusable/dist/index.js';
+```
+## 📦 APIs
+### `getFocusables`
+Returns all focusable elements within the container.
+```ts
+getFocusables(container);
+// => HTMLElement[]
+//
+// container (optional): HTMLElement (default: document.body)
+```
+### `getNextFocusable`
+Returns the next focusable element within the container, starting from `document.activeElement`.
+```ts
+getNextFocusable(container);
+// => HTMLElement | null
+//
+// container (optional): HTMLElement (default: document.body)
+// Starting from a specific element
+getNextFocusable(container, { active: document.querySelector('.button') });
+// Wrap to the first element if necessary
+getNextFocusable(container, { wrap: true });
+```
+### `getPreviousFocusable`
+Returns the previous focusable element within the container, starting from `document.activeElement`.
+```ts
+getPreviousFocusable(container);
+// => HTMLElement | null
+//
+// container (optional): HTMLElement (default: document.body)
+// Starting from a specific element
+getPreviousFocusable(container, { active: document.querySelector('.button') });
+// Wrap to the last element if necessary
+getPreviousFocusable(container, { wrap: true });
+```
+### `hasFocusable`
+Returns whether the container contains at least one focusable element.
+```ts
+hasFocusable(container);
+// => boolean
+//
+// container (optional): HTMLElement (default: document.body)
+```
+### `isFocusable`
+Returns whether the given element is focusable.
+```ts
+isFocusable(element);
+// => boolean
+//
+// element: HTMLElement
+```

package/dist/index.cjs ADDED Viewed

@@ -0,0 +1,211 @@
+'use strict';
+// src/index.ts
+var FOCUSABLE_SELECTOR = `:is(a[href], area[href], button, embed, iframe, input:not([type="hidden" i]), object, select, details > summary:first-of-type, textarea, [contenteditable]:not([contenteditable="false" i]), [controls], [tabindex]):not(:disabled, [hidden], [inert], [tabindex="-1"])`;
+var cache = /* @__PURE__ */ new WeakMap();
+function getFocusables(container = document.body) {
+  if (!(container instanceof HTMLElement)) {
+    console.warn("Invalid container element. Fallback: <body> element.");
+    container = document.body;
+  }
+  function hasShadow(root) {
+    let isFound = false;
+    function walk2(node) {
+      if (isFound) {
+        return;
+      }
+      if (node instanceof HTMLElement && node.shadowRoot && node.shadowRoot.mode === "open") {
+        isFound = true;
+        return;
+      }
+      node.childNodes.forEach(walk2);
+    }
+    walk2(root);
+    return isFound;
+  }
+  if (!container.querySelector(FOCUSABLE_SELECTOR) && !hasShadow(container)) {
+    return [];
+  }
+  const elements = [];
+  function walk(node) {
+    if (node instanceof HTMLElement) {
+      if (isFocusable(node)) {
+        elements.push(node);
+      }
+      const shadow = node.shadowRoot;
+      if (shadow && shadow.mode === "open") {
+        walk(shadow);
+      }
+    } else if (node instanceof HTMLSlotElement) {
+      const elements2 = node.assignedElements({ flatten: true });
+      if (elements2.length > 0) {
+        elements2.forEach((element) => {
+          walk(element);
+        });
+        return;
+      }
+    }
+    node.childNodes.forEach((child) => {
+      walk(child);
+    });
+  }
+  walk(container);
+  function sort(elements2) {
+    const ordered = [];
+    const natural = [];
+    function getTabIndex(element) {
+      const cached = cache.get(element);
+      if (cached !== void 0) {
+        return cached;
+      }
+      const number = Number(element.getAttribute("tabindex"));
+      cache.set(element, number);
+      return number;
+    }
+    elements2.forEach((element) => {
+      (getTabIndex(element) > 0 ? ordered : natural).push(element);
+    });
+    ordered.sort((a, b) => getTabIndex(a) - getTabIndex(b));
+    return [...ordered, ...natural];
+  }
+  function normalizeRadioGroup(elements2) {
+    let map = null;
+    const result = [];
+    for (const element of elements2) {
+      if (element instanceof HTMLInputElement && element.type === "radio" && element.name) {
+        if (!map) {
+          map = /* @__PURE__ */ new Map();
+        }
+        const key = `${element.form?.id ?? "no-form"}::${element.name}`;
+        (map.get(key) ?? map.set(key, []).get(key)).push(element);
+      } else {
+        result.push(element);
+      }
+    }
+    if (!map) {
+      return result;
+    }
+    for (const group of map.values()) {
+      const enabled = group.filter((radio) => isFocusable(radio));
+      if (enabled.length === 0) {
+        continue;
+      }
+      result.push(
+        enabled.find((radio) => radio.checked) ?? enabled[0]
+      );
+    }
+    return result;
+  }
+  return normalizeRadioGroup(sort(elements));
+}
+function getNextFocusable(container = document.body, options = {}) {
+  if (!(container instanceof HTMLElement)) {
+    console.warn("Invalid container element. Fallback: <body> element.");
+    container = document.body;
+  }
+  return getRelativeFocusable(container, 1, options);
+}
+function getPreviousFocusable(container = document.body, options = {}) {
+  if (!(container instanceof HTMLElement)) {
+    console.warn("Invalid container element. Fallback: <body> element.");
+    container = document.body;
+  }
+  return getRelativeFocusable(container, -1, options);
+}
+function hasFocusable(container = document.body) {
+  if (!(container instanceof HTMLElement)) {
+    console.warn("Invalid container element. Fallback: <body> element.");
+    container = document.body;
+  }
+  return getFocusables(container).length > 0;
+}
+function isFocusable(element) {
+  if (!(element instanceof HTMLElement)) {
+    console.warn("Invalid element");
+    return false;
+  }
+  function isDisabledDeep(element2) {
+    function isFormControl(element3) {
+      return /^(BUTTON|INPUT|SELECT|TEXTAREA)$/.test(element3.tagName);
+    }
+    function isDisabled(element3) {
+      return "disabled" in element3 && element3.disabled;
+    }
+    for (let current = element2; current; current = current instanceof ShadowRoot ? current.mode === "open" ? current.host : null : current.parentNode) {
+      if (!(current instanceof Element)) {
+        continue;
+      }
+      if (current === element2 && isFormControl(current) && isDisabled(current)) {
+        return true;
+      }
+      if (current.matches("[inert]")) {
+        return true;
+      }
+      if (isFormControl(element2) && current.tagName === "FIELDSET" && isDisabled(current)) {
+        if (current.querySelector(":scope > legend:first-of-type")?.contains(element2)) {
+          continue;
+        }
+        return true;
+      }
+    }
+    return false;
+  }
+  return element.matches(FOCUSABLE_SELECTOR) && !isDisabledDeep(element) && element.checkVisibility({
+    contentVisibilityAuto: true,
+    opacityProperty: true,
+    visibilityProperty: true
+  });
+}
+function getRelativeFocusable(container, offset = 0, options) {
+  const focusables = getFocusables(container);
+  const { length } = focusables;
+  if (length === 0) {
+    return null;
+  }
+  const { active, wrap = false } = options;
+  function getActiveElement() {
+    let active2 = document.activeElement;
+    while (active2 instanceof HTMLElement && active2.shadowRoot?.activeElement) {
+      active2 = active2.shadowRoot.activeElement;
+    }
+    return active2 instanceof HTMLElement ? active2 : null;
+  }
+  const current = active ?? getActiveElement();
+  function containsDeep(container2, node) {
+    for (let current2 = node; current2; current2 = !(current2 instanceof ShadowRoot) ? current2.parentNode : current2.mode === "open" ? current2.host : null) {
+      if (current2 === container2) {
+        return true;
+      }
+    }
+    return false;
+  }
+  if (!current || !containsDeep(container, current)) {
+    return null;
+  }
+  const currentIndex = focusables.indexOf(current);
+  if (currentIndex === -1) {
+    return null;
+  }
+  const offsetIndex = currentIndex + offset;
+  if ((offsetIndex < 0 || offsetIndex >= length) && !wrap) {
+    return null;
+  }
+  return focusables[(offsetIndex + length) % length] ?? null;
+}
+/**
+ * Power Focusable
+ * High-precision focus management utility with shadow DOM support.
+ * Handles complex focus rules.
+ *
+ * @version 1.0.0
+ * @author Yusuke Kamiyamane
+ * @license MIT
+ * @copyright Copyright (c) Yusuke Kamiyamane
+ * @see {@link https://github.com/y14e/power-focusable}
+ */
+exports.getFocusables = getFocusables;
+exports.getNextFocusable = getNextFocusable;
+exports.getPreviousFocusable = getPreviousFocusable;
+exports.hasFocusable = hasFocusable;
+exports.isFocusable = isFocusable;

package/dist/index.d.cts ADDED Viewed

@@ -0,0 +1,22 @@
+/**
+ * Power Focusable
+ * High-precision focus management utility with shadow DOM support.
+ * Handles complex focus rules.
+ *
+ * @version 1.0.0
+ * @author Yusuke Kamiyamane
+ * @license MIT
+ * @copyright Copyright (c) Yusuke Kamiyamane
+ * @see {@link https://github.com/y14e/power-focusable}
+ */
+interface PowerFocusableOptions {
+    readonly active?: HTMLElement | null;
+    readonly wrap?: boolean;
+}
+declare function getFocusables(container?: HTMLElement): HTMLElement[];
+declare function getNextFocusable(container?: HTMLElement, options?: PowerFocusableOptions): HTMLElement | null;
+declare function getPreviousFocusable(container?: HTMLElement, options?: PowerFocusableOptions): HTMLElement | null;
+declare function hasFocusable(container?: HTMLElement): boolean;
+declare function isFocusable(element: HTMLElement): boolean;
+export { type PowerFocusableOptions, getFocusables, getNextFocusable, getPreviousFocusable, hasFocusable, isFocusable };

package/dist/index.d.ts ADDED Viewed

@@ -0,0 +1,22 @@
+/**
+ * Power Focusable
+ * High-precision focus management utility with shadow DOM support.
+ * Handles complex focus rules.
+ *
+ * @version 1.0.0
+ * @author Yusuke Kamiyamane
+ * @license MIT
+ * @copyright Copyright (c) Yusuke Kamiyamane
+ * @see {@link https://github.com/y14e/power-focusable}
+ */
+interface PowerFocusableOptions {
+    readonly active?: HTMLElement | null;
+    readonly wrap?: boolean;
+}
+declare function getFocusables(container?: HTMLElement): HTMLElement[];
+declare function getNextFocusable(container?: HTMLElement, options?: PowerFocusableOptions): HTMLElement | null;
+declare function getPreviousFocusable(container?: HTMLElement, options?: PowerFocusableOptions): HTMLElement | null;
+declare function hasFocusable(container?: HTMLElement): boolean;
+declare function isFocusable(element: HTMLElement): boolean;
+export { type PowerFocusableOptions, getFocusables, getNextFocusable, getPreviousFocusable, hasFocusable, isFocusable };

package/dist/index.js ADDED Viewed

@@ -0,0 +1,205 @@
+// src/index.ts
+var FOCUSABLE_SELECTOR = `:is(a[href], area[href], button, embed, iframe, input:not([type="hidden" i]), object, select, details > summary:first-of-type, textarea, [contenteditable]:not([contenteditable="false" i]), [controls], [tabindex]):not(:disabled, [hidden], [inert], [tabindex="-1"])`;
+var cache = /* @__PURE__ */ new WeakMap();
+function getFocusables(container = document.body) {
+  if (!(container instanceof HTMLElement)) {
+    console.warn("Invalid container element. Fallback: <body> element.");
+    container = document.body;
+  }
+  function hasShadow(root) {
+    let isFound = false;
+    function walk2(node) {
+      if (isFound) {
+        return;
+      }
+      if (node instanceof HTMLElement && node.shadowRoot && node.shadowRoot.mode === "open") {
+        isFound = true;
+        return;
+      }
+      node.childNodes.forEach(walk2);
+    }
+    walk2(root);
+    return isFound;
+  }
+  if (!container.querySelector(FOCUSABLE_SELECTOR) && !hasShadow(container)) {
+    return [];
+  }
+  const elements = [];
+  function walk(node) {
+    if (node instanceof HTMLElement) {
+      if (isFocusable(node)) {
+        elements.push(node);
+      }
+      const shadow = node.shadowRoot;
+      if (shadow && shadow.mode === "open") {
+        walk(shadow);
+      }
+    } else if (node instanceof HTMLSlotElement) {
+      const elements2 = node.assignedElements({ flatten: true });
+      if (elements2.length > 0) {
+        elements2.forEach((element) => {
+          walk(element);
+        });
+        return;
+      }
+    }
+    node.childNodes.forEach((child) => {
+      walk(child);
+    });
+  }
+  walk(container);
+  function sort(elements2) {
+    const ordered = [];
+    const natural = [];
+    function getTabIndex(element) {
+      const cached = cache.get(element);
+      if (cached !== void 0) {
+        return cached;
+      }
+      const number = Number(element.getAttribute("tabindex"));
+      cache.set(element, number);
+      return number;
+    }
+    elements2.forEach((element) => {
+      (getTabIndex(element) > 0 ? ordered : natural).push(element);
+    });
+    ordered.sort((a, b) => getTabIndex(a) - getTabIndex(b));
+    return [...ordered, ...natural];
+  }
+  function normalizeRadioGroup(elements2) {
+    let map = null;
+    const result = [];
+    for (const element of elements2) {
+      if (element instanceof HTMLInputElement && element.type === "radio" && element.name) {
+        if (!map) {
+          map = /* @__PURE__ */ new Map();
+        }
+        const key = `${element.form?.id ?? "no-form"}::${element.name}`;
+        (map.get(key) ?? map.set(key, []).get(key)).push(element);
+      } else {
+        result.push(element);
+      }
+    }
+    if (!map) {
+      return result;
+    }
+    for (const group of map.values()) {
+      const enabled = group.filter((radio) => isFocusable(radio));
+      if (enabled.length === 0) {
+        continue;
+      }
+      result.push(
+        enabled.find((radio) => radio.checked) ?? enabled[0]
+      );
+    }
+    return result;
+  }
+  return normalizeRadioGroup(sort(elements));
+}
+function getNextFocusable(container = document.body, options = {}) {
+  if (!(container instanceof HTMLElement)) {
+    console.warn("Invalid container element. Fallback: <body> element.");
+    container = document.body;
+  }
+  return getRelativeFocusable(container, 1, options);
+}
+function getPreviousFocusable(container = document.body, options = {}) {
+  if (!(container instanceof HTMLElement)) {
+    console.warn("Invalid container element. Fallback: <body> element.");
+    container = document.body;
+  }
+  return getRelativeFocusable(container, -1, options);
+}
+function hasFocusable(container = document.body) {
+  if (!(container instanceof HTMLElement)) {
+    console.warn("Invalid container element. Fallback: <body> element.");
+    container = document.body;
+  }
+  return getFocusables(container).length > 0;
+}
+function isFocusable(element) {
+  if (!(element instanceof HTMLElement)) {
+    console.warn("Invalid element");
+    return false;
+  }
+  function isDisabledDeep(element2) {
+    function isFormControl(element3) {
+      return /^(BUTTON|INPUT|SELECT|TEXTAREA)$/.test(element3.tagName);
+    }
+    function isDisabled(element3) {
+      return "disabled" in element3 && element3.disabled;
+    }
+    for (let current = element2; current; current = current instanceof ShadowRoot ? current.mode === "open" ? current.host : null : current.parentNode) {
+      if (!(current instanceof Element)) {
+        continue;
+      }
+      if (current === element2 && isFormControl(current) && isDisabled(current)) {
+        return true;
+      }
+      if (current.matches("[inert]")) {
+        return true;
+      }
+      if (isFormControl(element2) && current.tagName === "FIELDSET" && isDisabled(current)) {
+        if (current.querySelector(":scope > legend:first-of-type")?.contains(element2)) {
+          continue;
+        }
+        return true;
+      }
+    }
+    return false;
+  }
+  return element.matches(FOCUSABLE_SELECTOR) && !isDisabledDeep(element) && element.checkVisibility({
+    contentVisibilityAuto: true,
+    opacityProperty: true,
+    visibilityProperty: true
+  });
+}
+function getRelativeFocusable(container, offset = 0, options) {
+  const focusables = getFocusables(container);
+  const { length } = focusables;
+  if (length === 0) {
+    return null;
+  }
+  const { active, wrap = false } = options;
+  function getActiveElement() {
+    let active2 = document.activeElement;
+    while (active2 instanceof HTMLElement && active2.shadowRoot?.activeElement) {
+      active2 = active2.shadowRoot.activeElement;
+    }
+    return active2 instanceof HTMLElement ? active2 : null;
+  }
+  const current = active ?? getActiveElement();
+  function containsDeep(container2, node) {
+    for (let current2 = node; current2; current2 = !(current2 instanceof ShadowRoot) ? current2.parentNode : current2.mode === "open" ? current2.host : null) {
+      if (current2 === container2) {
+        return true;
+      }
+    }
+    return false;
+  }
+  if (!current || !containsDeep(container, current)) {
+    return null;
+  }
+  const currentIndex = focusables.indexOf(current);
+  if (currentIndex === -1) {
+    return null;
+  }
+  const offsetIndex = currentIndex + offset;
+  if ((offsetIndex < 0 || offsetIndex >= length) && !wrap) {
+    return null;
+  }
+  return focusables[(offsetIndex + length) % length] ?? null;
+}
+/**
+ * Power Focusable
+ * High-precision focus management utility with shadow DOM support.
+ * Handles complex focus rules.
+ *
+ * @version 1.0.0
+ * @author Yusuke Kamiyamane
+ * @license MIT
+ * @copyright Copyright (c) Yusuke Kamiyamane
+ * @see {@link https://github.com/y14e/power-focusable}
+ */
+export { getFocusables, getNextFocusable, getPreviousFocusable, hasFocusable, isFocusable };

package/package.json ADDED Viewed

@@ -0,0 +1,54 @@
+{
+  "name": "power-focusable",
+  "version": "1.0.0",
+  "description": "High-precision focus management utility with shadow DOM support",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "prepublishOnly": "npm run build",
+    "lint": "tsc --noEmit"
+  },
+  "keywords": [
+    "focus",
+    "focusable",
+    "shadow-dom",
+    "shadowdom",
+    "a11y",
+    "accessibility",
+    "typescript",
+    "utility"
+  ],
+  "author": "Yusuke Kamiyamane",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/y14e/power-focusable.git"
+  },
+  "bugs": {
+    "url": "https://github.com/y14e/power-focusable/issues"
+  },
+  "homepage": "https://github.com/y14e/power-focusable#readme",
+  "devDependencies": {
+    "bun-types": "latest",
+    "tsup": "^8.0.0",
+    "typescript": "^5.6.0"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}