168 lines
4.8 KiB
JavaScript
168 lines
4.8 KiB
JavaScript
"use strict";
|
|
|
|
var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard");
|
|
|
|
Object.defineProperty(exports, "__esModule", {
|
|
value: true
|
|
});
|
|
exports.teardown = teardown;
|
|
exports.default = useIsFocusVisible;
|
|
|
|
var React = _interopRequireWildcard(require("react"));
|
|
|
|
var ReactDOM = _interopRequireWildcard(require("react-dom"));
|
|
|
|
// based on https://github.com/WICG/focus-visible/blob/v4.1.5/src/focus-visible.js
|
|
var hadKeyboardEvent = true;
|
|
var hadFocusVisibleRecently = false;
|
|
var hadFocusVisibleRecentlyTimeout = null;
|
|
var inputTypesWhitelist = {
|
|
text: true,
|
|
search: true,
|
|
url: true,
|
|
tel: true,
|
|
email: true,
|
|
password: true,
|
|
number: true,
|
|
date: true,
|
|
month: true,
|
|
week: true,
|
|
time: true,
|
|
datetime: true,
|
|
'datetime-local': true
|
|
};
|
|
/**
|
|
* Computes whether the given element should automatically trigger the
|
|
* `focus-visible` class being added, i.e. whether it should always match
|
|
* `:focus-visible` when focused.
|
|
* @param {Element} node
|
|
* @return {boolean}
|
|
*/
|
|
|
|
function focusTriggersKeyboardModality(node) {
|
|
var type = node.type,
|
|
tagName = node.tagName;
|
|
|
|
if (tagName === 'INPUT' && inputTypesWhitelist[type] && !node.readOnly) {
|
|
return true;
|
|
}
|
|
|
|
if (tagName === 'TEXTAREA' && !node.readOnly) {
|
|
return true;
|
|
}
|
|
|
|
if (node.isContentEditable) {
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
/**
|
|
* Keep track of our keyboard modality state with `hadKeyboardEvent`.
|
|
* If the most recent user interaction was via the keyboard;
|
|
* and the key press did not include a meta, alt/option, or control key;
|
|
* then the modality is keyboard. Otherwise, the modality is not keyboard.
|
|
* @param {KeyboardEvent} event
|
|
*/
|
|
|
|
|
|
function handleKeyDown(event) {
|
|
if (event.metaKey || event.altKey || event.ctrlKey) {
|
|
return;
|
|
}
|
|
|
|
hadKeyboardEvent = true;
|
|
}
|
|
/**
|
|
* If at any point a user clicks with a pointing device, ensure that we change
|
|
* the modality away from keyboard.
|
|
* This avoids the situation where a user presses a key on an already focused
|
|
* element, and then clicks on a different element, focusing it with a
|
|
* pointing device, while we still think we're in keyboard modality.
|
|
*/
|
|
|
|
|
|
function handlePointerDown() {
|
|
hadKeyboardEvent = false;
|
|
}
|
|
|
|
function handleVisibilityChange() {
|
|
if (this.visibilityState === 'hidden') {
|
|
// If the tab becomes active again, the browser will handle calling focus
|
|
// on the element (Safari actually calls it twice).
|
|
// If this tab change caused a blur on an element with focus-visible,
|
|
// re-apply the class when the user switches back to the tab.
|
|
if (hadFocusVisibleRecently) {
|
|
hadKeyboardEvent = true;
|
|
}
|
|
}
|
|
}
|
|
|
|
function prepare(doc) {
|
|
doc.addEventListener('keydown', handleKeyDown, true);
|
|
doc.addEventListener('mousedown', handlePointerDown, true);
|
|
doc.addEventListener('pointerdown', handlePointerDown, true);
|
|
doc.addEventListener('touchstart', handlePointerDown, true);
|
|
doc.addEventListener('visibilitychange', handleVisibilityChange, true);
|
|
}
|
|
|
|
function teardown(doc) {
|
|
doc.removeEventListener('keydown', handleKeyDown, true);
|
|
doc.removeEventListener('mousedown', handlePointerDown, true);
|
|
doc.removeEventListener('pointerdown', handlePointerDown, true);
|
|
doc.removeEventListener('touchstart', handlePointerDown, true);
|
|
doc.removeEventListener('visibilitychange', handleVisibilityChange, true);
|
|
}
|
|
|
|
function isFocusVisible(event) {
|
|
var target = event.target;
|
|
|
|
try {
|
|
return target.matches(':focus-visible');
|
|
} catch (error) {} // browsers not implementing :focus-visible will throw a SyntaxError
|
|
// we use our own heuristic for those browsers
|
|
// rethrow might be better if it's not the expected error but do we really
|
|
// want to crash if focus-visible malfunctioned?
|
|
// no need for validFocusTarget check. the user does that by attaching it to
|
|
// focusable events only
|
|
|
|
|
|
return hadKeyboardEvent || focusTriggersKeyboardModality(target);
|
|
}
|
|
/**
|
|
* Should be called if a blur event is fired on a focus-visible element
|
|
*/
|
|
|
|
|
|
function handleBlurVisible() {
|
|
// To detect a tab/window switch, we look for a blur event followed
|
|
// rapidly by a visibility change.
|
|
// If we don't see a visibility change within 100ms, it's probably a
|
|
// regular focus change.
|
|
hadFocusVisibleRecently = true;
|
|
window.clearTimeout(hadFocusVisibleRecentlyTimeout);
|
|
hadFocusVisibleRecentlyTimeout = window.setTimeout(function () {
|
|
hadFocusVisibleRecently = false;
|
|
}, 100);
|
|
}
|
|
|
|
function useIsFocusVisible() {
|
|
var ref = React.useCallback(function (instance) {
|
|
var node = ReactDOM.findDOMNode(instance);
|
|
|
|
if (node != null) {
|
|
prepare(node.ownerDocument);
|
|
}
|
|
}, []);
|
|
|
|
if (process.env.NODE_ENV !== 'production') {
|
|
// eslint-disable-next-line react-hooks/rules-of-hooks
|
|
React.useDebugValue(isFocusVisible);
|
|
}
|
|
|
|
return {
|
|
isFocusVisible: isFocusVisible,
|
|
onBlurVisible: handleBlurVisible,
|
|
ref: ref
|
|
};
|
|
} |