@zag-js/focus-visible 0.1.0 → 0.1.1

package/dist/index.d.ts

@@ -1,4 +1,5 @@
+declare type Modality = "keyboard" | "pointer" | "virtual";
 declare type FocusVisibleCallback = (isFocusVisible: boolean) => void;
 export declare function trackFocusVisible(fn: FocusVisibleCallback): () => void;
+export declare function trackInteractionModality(fn: (v: Modality | null) => void): () => void;
 export {};
-//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,3 +1,4 @@
+"use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
@@ -19,20 +20,22 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
-  trackFocusVisible: () => trackFocusVisible
+  trackFocusVisible: () => trackFocusVisible,
+  trackInteractionModality: () => trackInteractionModality
 });
 module.exports = __toCommonJS(src_exports);
 var hasSetup = false;
 var modality = null;
 var hasEventBeforeFocus = false;
+var hasBlurredWindowRecently = false;
 var handlers = /* @__PURE__ */ new Set();
-var isMac = typeof window !== "undefined" && window.navigator != null ? /^Mac/.test(window.navigator.platform) : false;
-function isValidKey(event) {
-  return !(event.metaKey || !isMac && event.altKey || event.ctrlKey);
-}
 function trigger(modality2, event) {
   handlers.forEach((handler) => handler(modality2, event));
 }
+var isMac = typeof window !== "undefined" && window.navigator != null ? /^Mac/.test(window.navigator.platform) : false;
+function isValidKey(e) {
+  return !(e.metaKey || !isMac && e.altKey || e.ctrlKey || e.key === "Control" || e.key === "Shift" || e.key === "Meta");
+}
 function onKeyboardEvent(event) {
   hasEventBeforeFocus = true;
   if (isValidKey(event)) {
@@ -44,24 +47,40 @@ function onPointerEvent(event) {
   modality = "pointer";
   if (event.type === "mousedown" || event.type === "pointerdown") {
     hasEventBeforeFocus = true;
+    const target = event.composedPath ? event.composedPath()[0] : event.target;
+    if (target.matches(":focus-visible"))
+      return;
     trigger("pointer", event);
   }
 }
+function isVirtualClick(event) {
+  if (event.mozInputSource === 0 && event.isTrusted)
+    return true;
+  return event.detail === 0 && !event.pointerType;
+}
+function onClickEvent(e) {
+  if (isVirtualClick(e)) {
+    hasEventBeforeFocus = true;
+    modality = "virtual";
+  }
+}
 function onWindowFocus(event) {
   if (event.target === window || event.target === document) {
     return;
   }
-  if (!hasEventBeforeFocus) {
-    modality = "keyboard";
-    trigger("keyboard", event);
+  if (!hasEventBeforeFocus && !hasBlurredWindowRecently) {
+    modality = "virtual";
+    trigger("virtual", event);
   }
   hasEventBeforeFocus = false;
+  hasBlurredWindowRecently = false;
 }
 function onWindowBlur() {
   hasEventBeforeFocus = false;
+  hasBlurredWindowRecently = true;
 }
 function isFocusVisible() {
-  return modality !== "pointer";
+  return modality != null && modality !== "pointer";
 }
 function setupGlobalFocusEvents() {
   if (typeof window === "undefined" || hasSetup) {
@@ -74,6 +93,7 @@ function setupGlobalFocusEvents() {
   };
   document.addEventListener("keydown", onKeyboardEvent, true);
   document.addEventListener("keyup", onKeyboardEvent, true);
+  document.addEventListener("click", onClickEvent, true);
   window.addEventListener("focus", onWindowFocus, true);
   window.addEventListener("blur", onWindowBlur, false);
   if (typeof PointerEvent !== "undefined") {
@@ -96,4 +116,12 @@ function trackFocusVisible(fn) {
     handlers.delete(handler);
   };
 }
-//# sourceMappingURL=index.js.map
+function trackInteractionModality(fn) {
+  setupGlobalFocusEvents();
+  fn(modality);
+  const handler = () => fn(modality);
+  handlers.add(handler);
+  return () => {
+    handlers.delete(handler);
+  };
+}

package/dist/index.mjs

@@ -1,15 +1,18 @@
+"use strict";
+
 // src/index.ts
 var hasSetup = false;
 var modality = null;
 var hasEventBeforeFocus = false;
+var hasBlurredWindowRecently = false;
 var handlers = /* @__PURE__ */ new Set();
-var isMac = typeof window !== "undefined" && window.navigator != null ? /^Mac/.test(window.navigator.platform) : false;
-function isValidKey(event) {
-  return !(event.metaKey || !isMac && event.altKey || event.ctrlKey);
-}
 function trigger(modality2, event) {
   handlers.forEach((handler) => handler(modality2, event));
 }
+var isMac = typeof window !== "undefined" && window.navigator != null ? /^Mac/.test(window.navigator.platform) : false;
+function isValidKey(e) {
+  return !(e.metaKey || !isMac && e.altKey || e.ctrlKey || e.key === "Control" || e.key === "Shift" || e.key === "Meta");
+}
 function onKeyboardEvent(event) {
   hasEventBeforeFocus = true;
   if (isValidKey(event)) {
@@ -21,24 +24,40 @@ function onPointerEvent(event) {
   modality = "pointer";
   if (event.type === "mousedown" || event.type === "pointerdown") {
     hasEventBeforeFocus = true;
+    const target = event.composedPath ? event.composedPath()[0] : event.target;
+    if (target.matches(":focus-visible"))
+      return;
     trigger("pointer", event);
   }
 }
+function isVirtualClick(event) {
+  if (event.mozInputSource === 0 && event.isTrusted)
+    return true;
+  return event.detail === 0 && !event.pointerType;
+}
+function onClickEvent(e) {
+  if (isVirtualClick(e)) {
+    hasEventBeforeFocus = true;
+    modality = "virtual";
+  }
+}
 function onWindowFocus(event) {
   if (event.target === window || event.target === document) {
     return;
   }
-  if (!hasEventBeforeFocus) {
-    modality = "keyboard";
-    trigger("keyboard", event);
+  if (!hasEventBeforeFocus && !hasBlurredWindowRecently) {
+    modality = "virtual";
+    trigger("virtual", event);
   }
   hasEventBeforeFocus = false;
+  hasBlurredWindowRecently = false;
 }
 function onWindowBlur() {
   hasEventBeforeFocus = false;
+  hasBlurredWindowRecently = true;
 }
 function isFocusVisible() {
-  return modality !== "pointer";
+  return modality != null && modality !== "pointer";
 }
 function setupGlobalFocusEvents() {
   if (typeof window === "undefined" || hasSetup) {
@@ -51,6 +70,7 @@ function setupGlobalFocusEvents() {
   };
   document.addEventListener("keydown", onKeyboardEvent, true);
   document.addEventListener("keyup", onKeyboardEvent, true);
+  document.addEventListener("click", onClickEvent, true);
   window.addEventListener("focus", onWindowFocus, true);
   window.addEventListener("blur", onWindowBlur, false);
   if (typeof PointerEvent !== "undefined") {
@@ -73,7 +93,16 @@ function trackFocusVisible(fn) {
     handlers.delete(handler);
   };
 }
+function trackInteractionModality(fn) {
+  setupGlobalFocusEvents();
+  fn(modality);
+  const handler = () => fn(modality);
+  handlers.add(handler);
+  return () => {
+    handlers.delete(handler);
+  };
+}
 export {
-  trackFocusVisible
+  trackFocusVisible,
+  trackInteractionModality
 };
-//# sourceMappingURL=index.mjs.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zag-js/focus-visible",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Focus visible polyfill utility based on WICG",
   "keywords": [
     "js",

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,aAAK,oBAAoB,GAAG,CAAC,cAAc,EAAE,OAAO,KAAK,IAAI,CAAA;AAkG7D,wBAAgB,iBAAiB,CAAC,EAAE,EAAE,oBAAoB,cAUzD"}

package/dist/index.js.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../src/index.ts"],
-  "sourcesContent": ["type Modality = \"keyboard\" | \"pointer\"\ntype HandlerEvent = PointerEvent | MouseEvent | KeyboardEvent | FocusEvent\ntype Handler = (modality: Modality, e: HandlerEvent) => void\ntype FocusVisibleCallback = (isFocusVisible: boolean) => void\n\nlet hasSetup = false\nlet modality: Modality | null = null\nlet hasEventBeforeFocus = false\n\nconst handlers = new Set<Handler>()\n\nconst isMac = typeof window !== \"undefined\" && window.navigator != null ? /^Mac/.test(window.navigator.platform) : false\n\nfunction isValidKey(event: KeyboardEvent) {\n  return !(event.metaKey || (!isMac && event.altKey) || event.ctrlKey)\n}\n\nfunction trigger(modality: Modality, event: HandlerEvent) {\n  handlers.forEach((handler) => handler(modality, event))\n}\n\nfunction onKeyboardEvent(event: KeyboardEvent) {\n  hasEventBeforeFocus = true\n  if (isValidKey(event)) {\n    modality = \"keyboard\"\n    trigger(\"keyboard\", event)\n  }\n}\n\nfunction onPointerEvent(event: PointerEvent | MouseEvent) {\n  modality = \"pointer\"\n  if (event.type === \"mousedown\" || event.type === \"pointerdown\") {\n    hasEventBeforeFocus = true\n    trigger(\"pointer\", event)\n  }\n}\n\nfunction onWindowFocus(event: FocusEvent) {\n  // Firefox fires two extra focus events when the user first clicks into an iframe:\n  // first on the window, then on the document. We ignore these events so they don't\n  // cause keyboard focus rings to appear.\n  if (event.target === window || event.target === document) {\n    return\n  }\n\n  // If a focus event occurs without a preceding keyboard or pointer event, switch to keyboard modality.\n  // This occurs, for example, when navigating a form with the next/previous buttons on iOS.\n  if (!hasEventBeforeFocus) {\n    modality = \"keyboard\"\n    trigger(\"keyboard\", event)\n  }\n\n  hasEventBeforeFocus = false\n}\n\nfunction onWindowBlur() {\n  // When the window is blurred, reset state. This is necessary when tabbing out of the window,\n  // for example, since a subsequent focus event won't be fired.\n  hasEventBeforeFocus = false\n}\n\nfunction isFocusVisible() {\n  return modality !== \"pointer\"\n}\n\nfunction setupGlobalFocusEvents() {\n  if (typeof window === \"undefined\" || hasSetup) {\n    return\n  }\n\n  // Programmatic focus() calls shouldn't affect the current input modality.\n  // However, we need to detect other cases when a focus event occurs without\n  // a preceding user event (e.g. screen reader focus). Overriding the focus\n  // method on HTMLElement.prototype is a bit hacky, but works.\n  const { focus } = HTMLElement.prototype\n  HTMLElement.prototype.focus = function focusElement(...args) {\n    hasEventBeforeFocus = true\n    focus.apply(this, args)\n  }\n\n  document.addEventListener(\"keydown\", onKeyboardEvent, true)\n  document.addEventListener(\"keyup\", onKeyboardEvent, true)\n\n  // Register focus events on the window so they are sure to happen\n  // before React's event listeners (registered on the document).\n  window.addEventListener(\"focus\", onWindowFocus, true)\n  window.addEventListener(\"blur\", onWindowBlur, false)\n\n  if (typeof PointerEvent !== \"undefined\") {\n    document.addEventListener(\"pointerdown\", onPointerEvent, true)\n    document.addEventListener(\"pointermove\", onPointerEvent, true)\n    document.addEventListener(\"pointerup\", onPointerEvent, true)\n  } else {\n    document.addEventListener(\"mousedown\", onPointerEvent, true)\n    document.addEventListener(\"mousemove\", onPointerEvent, true)\n    document.addEventListener(\"mouseup\", onPointerEvent, true)\n  }\n\n  hasSetup = true\n}\n\nexport function trackFocusVisible(fn: FocusVisibleCallback) {\n  setupGlobalFocusEvents()\n\n  fn(isFocusVisible())\n  const handler = () => fn(isFocusVisible())\n\n  handlers.add(handler)\n  return () => {\n    handlers.delete(handler)\n  }\n}\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAKA,IAAI,WAAW;AACf,IAAI,WAA4B;AAChC,IAAI,sBAAsB;AAE1B,IAAM,WAAW,oBAAI,IAAa;AAElC,IAAM,QAAQ,OAAO,WAAW,eAAe,OAAO,aAAa,OAAO,OAAO,KAAK,OAAO,UAAU,QAAQ,IAAI;AAEnH,oBAAoB,OAAsB;AACxC,SAAO,CAAE,OAAM,WAAY,CAAC,SAAS,MAAM,UAAW,MAAM;AAC9D;AAEA,iBAAiB,WAAoB,OAAqB;AACxD,WAAS,QAAQ,CAAC,YAAY,QAAQ,WAAU,KAAK,CAAC;AACxD;AAEA,yBAAyB,OAAsB;AAC7C,wBAAsB;AACtB,MAAI,WAAW,KAAK,GAAG;AACrB,eAAW;AACX,YAAQ,YAAY,KAAK;AAAA,EAC3B;AACF;AAEA,wBAAwB,OAAkC;AACxD,aAAW;AACX,MAAI,MAAM,SAAS,eAAe,MAAM,SAAS,eAAe;AAC9D,0BAAsB;AACtB,YAAQ,WAAW,KAAK;AAAA,EAC1B;AACF;AAEA,uBAAuB,OAAmB;AAIxC,MAAI,MAAM,WAAW,UAAU,MAAM,WAAW,UAAU;AACxD;AAAA,EACF;AAIA,MAAI,CAAC,qBAAqB;AACxB,eAAW;AACX,YAAQ,YAAY,KAAK;AAAA,EAC3B;AAEA,wBAAsB;AACxB;AAEA,wBAAwB;AAGtB,wBAAsB;AACxB;AAEA,0BAA0B;AACxB,SAAO,aAAa;AACtB;AAEA,kCAAkC;AAChC,MAAI,OAAO,WAAW,eAAe,UAAU;AAC7C;AAAA,EACF;AAMA,QAAM,EAAE,UAAU,YAAY;AAC9B,cAAY,UAAU,QAAQ,yBAAyB,MAAM;AAC3D,0BAAsB;AACtB,UAAM,MAAM,MAAM,IAAI;AAAA,EACxB;AAEA,WAAS,iBAAiB,WAAW,iBAAiB,IAAI;AAC1D,WAAS,iBAAiB,SAAS,iBAAiB,IAAI;AAIxD,SAAO,iBAAiB,SAAS,eAAe,IAAI;AACpD,SAAO,iBAAiB,QAAQ,cAAc,KAAK;AAEnD,MAAI,OAAO,iBAAiB,aAAa;AACvC,aAAS,iBAAiB,eAAe,gBAAgB,IAAI;AAC7D,aAAS,iBAAiB,eAAe,gBAAgB,IAAI;AAC7D,aAAS,iBAAiB,aAAa,gBAAgB,IAAI;AAAA,EAC7D,OAAO;AACL,aAAS,iBAAiB,aAAa,gBAAgB,IAAI;AAC3D,aAAS,iBAAiB,aAAa,gBAAgB,IAAI;AAC3D,aAAS,iBAAiB,WAAW,gBAAgB,IAAI;AAAA,EAC3D;AAEA,aAAW;AACb;AAEO,2BAA2B,IAA0B;AAC1D,yBAAuB;AAEvB,KAAG,eAAe,CAAC;AACnB,QAAM,UAAU,MAAM,GAAG,eAAe,CAAC;AAEzC,WAAS,IAAI,OAAO;AACpB,SAAO,MAAM;AACX,aAAS,OAAO,OAAO;AAAA,EACzB;AACF;",
-  "names": []
-}

package/dist/index.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../src/index.ts"],
-  "sourcesContent": ["type Modality = \"keyboard\" | \"pointer\"\ntype HandlerEvent = PointerEvent | MouseEvent | KeyboardEvent | FocusEvent\ntype Handler = (modality: Modality, e: HandlerEvent) => void\ntype FocusVisibleCallback = (isFocusVisible: boolean) => void\n\nlet hasSetup = false\nlet modality: Modality | null = null\nlet hasEventBeforeFocus = false\n\nconst handlers = new Set<Handler>()\n\nconst isMac = typeof window !== \"undefined\" && window.navigator != null ? /^Mac/.test(window.navigator.platform) : false\n\nfunction isValidKey(event: KeyboardEvent) {\n  return !(event.metaKey || (!isMac && event.altKey) || event.ctrlKey)\n}\n\nfunction trigger(modality: Modality, event: HandlerEvent) {\n  handlers.forEach((handler) => handler(modality, event))\n}\n\nfunction onKeyboardEvent(event: KeyboardEvent) {\n  hasEventBeforeFocus = true\n  if (isValidKey(event)) {\n    modality = \"keyboard\"\n    trigger(\"keyboard\", event)\n  }\n}\n\nfunction onPointerEvent(event: PointerEvent | MouseEvent) {\n  modality = \"pointer\"\n  if (event.type === \"mousedown\" || event.type === \"pointerdown\") {\n    hasEventBeforeFocus = true\n    trigger(\"pointer\", event)\n  }\n}\n\nfunction onWindowFocus(event: FocusEvent) {\n  // Firefox fires two extra focus events when the user first clicks into an iframe:\n  // first on the window, then on the document. We ignore these events so they don't\n  // cause keyboard focus rings to appear.\n  if (event.target === window || event.target === document) {\n    return\n  }\n\n  // If a focus event occurs without a preceding keyboard or pointer event, switch to keyboard modality.\n  // This occurs, for example, when navigating a form with the next/previous buttons on iOS.\n  if (!hasEventBeforeFocus) {\n    modality = \"keyboard\"\n    trigger(\"keyboard\", event)\n  }\n\n  hasEventBeforeFocus = false\n}\n\nfunction onWindowBlur() {\n  // When the window is blurred, reset state. This is necessary when tabbing out of the window,\n  // for example, since a subsequent focus event won't be fired.\n  hasEventBeforeFocus = false\n}\n\nfunction isFocusVisible() {\n  return modality !== \"pointer\"\n}\n\nfunction setupGlobalFocusEvents() {\n  if (typeof window === \"undefined\" || hasSetup) {\n    return\n  }\n\n  // Programmatic focus() calls shouldn't affect the current input modality.\n  // However, we need to detect other cases when a focus event occurs without\n  // a preceding user event (e.g. screen reader focus). Overriding the focus\n  // method on HTMLElement.prototype is a bit hacky, but works.\n  const { focus } = HTMLElement.prototype\n  HTMLElement.prototype.focus = function focusElement(...args) {\n    hasEventBeforeFocus = true\n    focus.apply(this, args)\n  }\n\n  document.addEventListener(\"keydown\", onKeyboardEvent, true)\n  document.addEventListener(\"keyup\", onKeyboardEvent, true)\n\n  // Register focus events on the window so they are sure to happen\n  // before React's event listeners (registered on the document).\n  window.addEventListener(\"focus\", onWindowFocus, true)\n  window.addEventListener(\"blur\", onWindowBlur, false)\n\n  if (typeof PointerEvent !== \"undefined\") {\n    document.addEventListener(\"pointerdown\", onPointerEvent, true)\n    document.addEventListener(\"pointermove\", onPointerEvent, true)\n    document.addEventListener(\"pointerup\", onPointerEvent, true)\n  } else {\n    document.addEventListener(\"mousedown\", onPointerEvent, true)\n    document.addEventListener(\"mousemove\", onPointerEvent, true)\n    document.addEventListener(\"mouseup\", onPointerEvent, true)\n  }\n\n  hasSetup = true\n}\n\nexport function trackFocusVisible(fn: FocusVisibleCallback) {\n  setupGlobalFocusEvents()\n\n  fn(isFocusVisible())\n  const handler = () => fn(isFocusVisible())\n\n  handlers.add(handler)\n  return () => {\n    handlers.delete(handler)\n  }\n}\n"],
-  "mappings": ";AAKA,IAAI,WAAW;AACf,IAAI,WAA4B;AAChC,IAAI,sBAAsB;AAE1B,IAAM,WAAW,oBAAI,IAAa;AAElC,IAAM,QAAQ,OAAO,WAAW,eAAe,OAAO,aAAa,OAAO,OAAO,KAAK,OAAO,UAAU,QAAQ,IAAI;AAEnH,oBAAoB,OAAsB;AACxC,SAAO,CAAE,OAAM,WAAY,CAAC,SAAS,MAAM,UAAW,MAAM;AAC9D;AAEA,iBAAiB,WAAoB,OAAqB;AACxD,WAAS,QAAQ,CAAC,YAAY,QAAQ,WAAU,KAAK,CAAC;AACxD;AAEA,yBAAyB,OAAsB;AAC7C,wBAAsB;AACtB,MAAI,WAAW,KAAK,GAAG;AACrB,eAAW;AACX,YAAQ,YAAY,KAAK;AAAA,EAC3B;AACF;AAEA,wBAAwB,OAAkC;AACxD,aAAW;AACX,MAAI,MAAM,SAAS,eAAe,MAAM,SAAS,eAAe;AAC9D,0BAAsB;AACtB,YAAQ,WAAW,KAAK;AAAA,EAC1B;AACF;AAEA,uBAAuB,OAAmB;AAIxC,MAAI,MAAM,WAAW,UAAU,MAAM,WAAW,UAAU;AACxD;AAAA,EACF;AAIA,MAAI,CAAC,qBAAqB;AACxB,eAAW;AACX,YAAQ,YAAY,KAAK;AAAA,EAC3B;AAEA,wBAAsB;AACxB;AAEA,wBAAwB;AAGtB,wBAAsB;AACxB;AAEA,0BAA0B;AACxB,SAAO,aAAa;AACtB;AAEA,kCAAkC;AAChC,MAAI,OAAO,WAAW,eAAe,UAAU;AAC7C;AAAA,EACF;AAMA,QAAM,EAAE,UAAU,YAAY;AAC9B,cAAY,UAAU,QAAQ,yBAAyB,MAAM;AAC3D,0BAAsB;AACtB,UAAM,MAAM,MAAM,IAAI;AAAA,EACxB;AAEA,WAAS,iBAAiB,WAAW,iBAAiB,IAAI;AAC1D,WAAS,iBAAiB,SAAS,iBAAiB,IAAI;AAIxD,SAAO,iBAAiB,SAAS,eAAe,IAAI;AACpD,SAAO,iBAAiB,QAAQ,cAAc,KAAK;AAEnD,MAAI,OAAO,iBAAiB,aAAa;AACvC,aAAS,iBAAiB,eAAe,gBAAgB,IAAI;AAC7D,aAAS,iBAAiB,eAAe,gBAAgB,IAAI;AAC7D,aAAS,iBAAiB,aAAa,gBAAgB,IAAI;AAAA,EAC7D,OAAO;AACL,aAAS,iBAAiB,aAAa,gBAAgB,IAAI;AAC3D,aAAS,iBAAiB,aAAa,gBAAgB,IAAI;AAC3D,aAAS,iBAAiB,WAAW,gBAAgB,IAAI;AAAA,EAC3D;AAEA,aAAW;AACb;AAEO,2BAA2B,IAA0B;AAC1D,yBAAuB;AAEvB,KAAG,eAAe,CAAC;AACnB,QAAM,UAAU,MAAM,GAAG,eAAe,CAAC;AAEzC,WAAS,IAAI,OAAO;AACpB,SAAO,MAAM;AACX,aAAS,OAAO,OAAO;AAAA,EACzB;AACF;",
-  "names": []
-}