react-aria
Version:
Spectrum UI components in React
420 lines (396 loc) • 24.5 kB
JavaScript
var $79558b1ff24cb93a$exports = require("../utils/constants.cjs");
var $4f541c01c875ab4e$exports = require("../focus/virtualFocus.cjs");
var $4a053a4bf25e52fb$exports = require("../interactions/focusSafely.cjs");
var $4b9e9ed3f006ad27$exports = require("../utils/focusWithoutScrolling.cjs");
var $da02ee888921bc9e$exports = require("../utils/shadowdom/DOMFunctions.cjs");
var $9fb4ac1cc58342cc$exports = require("../focus/FocusScope.cjs");
var $d0df89f3abe2c2ca$exports = require("../interactions/useFocusVisible.cjs");
var $b07dd3d1fedd87d6$exports = require("./utils.cjs");
var $d74c59468d7890a7$exports = require("../utils/keyboard.cjs");
var $48f566b6becd50da$exports = require("../utils/isFocusable.cjs");
var $89b39774f3b79dbb$exports = require("../utils/mergeProps.cjs");
var $9a1324d6ffd8bbb0$exports = require("../utils/scrollIntoView.cjs");
var $6e76e65001bbcda2$exports = require("../utils/useEvent.cjs");
var $2522e612fa919664$exports = require("../i18n/I18nProvider.cjs");
var $75bd88aab025820b$exports = require("../utils/openLink.cjs");
var $a6299e8d95fc8908$exports = require("./useTypeSelect.cjs");
var $826bcd7bc2ba42c6$exports = require("../utils/useUpdateLayoutEffect.cjs");
var $aQuvg$reactdom = require("react-dom");
var $aQuvg$react = require("react");
function $parcel$export(e, n, v, s) {
Object.defineProperty(e, n, {get: v, set: s, enumerable: true, configurable: true});
}
$parcel$export(module.exports, "useSelectableCollection", function () { return $df9ba3e9a7210056$export$d6daf82dcd84e87c; });
/*
* Copyright 2020 Adobe. All rights reserved.
* This file is licensed to you under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. You may obtain a copy
* of the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under
* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
* OF ANY KIND, either express or implied. See the License for the specific language
* governing permissions and limitations under the License.
*/
function $df9ba3e9a7210056$export$d6daf82dcd84e87c(options) {
let { selectionManager: manager, keyboardDelegate: delegate, ref: ref, autoFocus: autoFocus = false, shouldFocusWrap: shouldFocusWrap = false, disallowEmptySelection: disallowEmptySelection = false, disallowSelectAll: disallowSelectAll = false, escapeKeyBehavior: escapeKeyBehavior = 'clearSelection', selectOnFocus: selectOnFocus = manager.selectionBehavior === 'replace', disallowTypeAhead: disallowTypeAhead = false, shouldUseVirtualFocus: shouldUseVirtualFocus, allowsTabNavigation: allowsTabNavigation = false, scrollRef: // If no scrollRef is provided, assume the collection ref is the scrollable region
scrollRef = ref, linkBehavior: linkBehavior = 'action', UNSTABLE_focusOnEntry: UNSTABLE_focusOnEntry } = options;
let { direction: direction } = (0, $2522e612fa919664$exports.useLocale)();
let router = (0, $75bd88aab025820b$exports.useRouter)();
let onKeyDown = (e)=>{
// Prevent option + tab from doing anything since it doesn't move focus to the cells, only buttons/checkboxes
if (e.altKey && e.key === 'Tab') e.preventDefault();
// Keyboard events bubble through portals. Don't handle keyboard events
// for elements outside the collection (e.g. menus).
if (!ref.current || !(0, $da02ee888921bc9e$exports.nodeContains)(ref.current, (0, $da02ee888921bc9e$exports.getEventTarget)(e))) return;
const navigateToKey = (key, childFocus)=>{
if (key != null) {
if (manager.isLink(key) && linkBehavior === 'selection' && selectOnFocus && !(0, $b07dd3d1fedd87d6$exports.isNonContiguousSelectionModifier)(e)) {
// Set focused key and re-render synchronously to bring item into view if needed.
(0, $aQuvg$reactdom.flushSync)(()=>{
manager.setFocusedKey(key, childFocus);
});
let item = (0, $b07dd3d1fedd87d6$exports.getItemElement)(ref, key);
let itemProps = manager.getItemProps(key);
if (item) router.open(item, e, itemProps.href, itemProps.routerOptions);
return;
}
manager.setFocusedKey(key, childFocus);
if (manager.isLink(key) && linkBehavior === 'override') return;
if (e.shiftKey && manager.selectionMode === 'multiple') manager.extendSelection(key);
else if (selectOnFocus && !(0, $b07dd3d1fedd87d6$exports.isNonContiguousSelectionModifier)(e)) manager.replaceSelection(key);
}
};
switch(e.key){
case 'ArrowDown':
if (delegate.getKeyBelow) {
let nextKey = manager.focusedKey != null ? delegate.getKeyBelow?.(manager.focusedKey) : delegate.getFirstKey?.();
if (nextKey == null && shouldFocusWrap) nextKey = delegate.getFirstKey?.(manager.focusedKey);
if (nextKey != null) {
e.preventDefault();
navigateToKey(nextKey);
}
}
break;
case 'ArrowUp':
if (delegate.getKeyAbove) {
let nextKey = manager.focusedKey != null ? delegate.getKeyAbove?.(manager.focusedKey) : delegate.getLastKey?.();
if (nextKey == null && shouldFocusWrap) nextKey = delegate.getLastKey?.(manager.focusedKey);
if (nextKey != null) {
e.preventDefault();
navigateToKey(nextKey);
}
}
break;
case 'ArrowLeft':
if (delegate.getKeyLeftOf) {
let nextKey = manager.focusedKey != null ? delegate.getKeyLeftOf?.(manager.focusedKey) : delegate.getFirstKey?.();
if (nextKey == null && shouldFocusWrap) nextKey = direction === 'rtl' ? delegate.getFirstKey?.(manager.focusedKey) : delegate.getLastKey?.(manager.focusedKey);
if (nextKey != null) {
e.preventDefault();
navigateToKey(nextKey, direction === 'rtl' ? 'first' : 'last');
}
}
break;
case 'ArrowRight':
if (delegate.getKeyRightOf) {
let nextKey = manager.focusedKey != null ? delegate.getKeyRightOf?.(manager.focusedKey) : delegate.getFirstKey?.();
if (nextKey == null && shouldFocusWrap) nextKey = direction === 'rtl' ? delegate.getLastKey?.(manager.focusedKey) : delegate.getFirstKey?.(manager.focusedKey);
if (nextKey != null) {
e.preventDefault();
navigateToKey(nextKey, direction === 'rtl' ? 'last' : 'first');
}
}
break;
case 'Home':
if (delegate.getFirstKey) {
if (manager.focusedKey === null && e.shiftKey) return;
e.preventDefault();
let firstKey = delegate.getFirstKey(manager.focusedKey, (0, $d74c59468d7890a7$exports.isCtrlKeyPressed)(e));
manager.setFocusedKey(firstKey);
if (firstKey != null) {
if ((0, $d74c59468d7890a7$exports.isCtrlKeyPressed)(e) && e.shiftKey && manager.selectionMode === 'multiple') manager.extendSelection(firstKey);
else if (selectOnFocus) manager.replaceSelection(firstKey);
}
}
break;
case 'End':
if (delegate.getLastKey) {
if (manager.focusedKey === null && e.shiftKey) return;
e.preventDefault();
let lastKey = delegate.getLastKey(manager.focusedKey, (0, $d74c59468d7890a7$exports.isCtrlKeyPressed)(e));
manager.setFocusedKey(lastKey);
if (lastKey != null) {
if ((0, $d74c59468d7890a7$exports.isCtrlKeyPressed)(e) && e.shiftKey && manager.selectionMode === 'multiple') manager.extendSelection(lastKey);
else if (selectOnFocus) manager.replaceSelection(lastKey);
}
}
break;
case 'PageDown':
if (delegate.getKeyPageBelow && manager.focusedKey != null) {
let nextKey = delegate.getKeyPageBelow(manager.focusedKey);
if (nextKey != null) {
e.preventDefault();
navigateToKey(nextKey);
}
}
break;
case 'PageUp':
if (delegate.getKeyPageAbove && manager.focusedKey != null) {
let nextKey = delegate.getKeyPageAbove(manager.focusedKey);
if (nextKey != null) {
e.preventDefault();
navigateToKey(nextKey);
}
}
break;
case 'a':
if ((0, $d74c59468d7890a7$exports.isCtrlKeyPressed)(e) && manager.selectionMode === 'multiple' && disallowSelectAll !== true) {
e.preventDefault();
manager.selectAll();
}
break;
case 'Escape':
if (escapeKeyBehavior === 'clearSelection' && !disallowEmptySelection && manager.selectedKeys.size !== 0) {
e.stopPropagation();
e.preventDefault();
manager.clearSelection();
}
break;
case 'Tab':
if (!allowsTabNavigation) {
// There may be elements that are "tabbable" inside a collection (e.g. in a grid cell).
// However, collections should be treated as a single tab stop, with arrow key navigation internally.
// We don't control the rendering of these, so we can't override the tabIndex to prevent tabbing.
// Instead, we handle the Tab key, and move focus manually to the first/last tabbable element
// in the collection, so that the browser default behavior will apply starting from that element
// rather than the currently focused one.
if (e.shiftKey) ref.current.focus();
else {
let walker = (0, $9fb4ac1cc58342cc$exports.getFocusableTreeWalker)(ref.current, {
tabbable: true
});
let next = undefined;
let last;
do {
last = walker.lastChild();
// oxlint-disable-next-line max-depth
if (last) next = last;
}while (last);
// If the active element is NOT tabbable but is contained by an element that IS tabbable (aka the cell), the browser will actually move focus to
// the containing element. We need to special case this so that tab will move focus out of the grid instead of looping between
// focusing the containing cell and back to the non-tabbable child element
let activeElement = (0, $da02ee888921bc9e$exports.getActiveElement)();
if (next && (!(0, $da02ee888921bc9e$exports.isFocusWithin)(next) || activeElement && !(0, $48f566b6becd50da$exports.isTabbable)(activeElement))) (0, $4b9e9ed3f006ad27$exports.focusWithoutScrolling)(next);
}
break;
}
}
};
// Store the scroll position so we can restore it later.
/// TODO: should this happen all the time??
let scrollPos = (0, $aQuvg$react.useRef)({
top: 0,
left: 0
});
(0, $6e76e65001bbcda2$exports.useEvent)(scrollRef, 'scroll', ()=>{
scrollPos.current = {
top: scrollRef.current?.scrollTop ?? 0,
left: scrollRef.current?.scrollLeft ?? 0
};
});
let onFocus = (e)=>{
if (manager.isFocused) {
// If a focus event bubbled through a portal, reset focus state.
if (!(0, $da02ee888921bc9e$exports.nodeContains)(e.currentTarget, (0, $da02ee888921bc9e$exports.getEventTarget)(e))) manager.setFocused(false);
return;
}
// Focus events can bubble through portals. Ignore these events.
if (!(0, $da02ee888921bc9e$exports.nodeContains)(e.currentTarget, (0, $da02ee888921bc9e$exports.getEventTarget)(e))) return;
let modality = (0, $d0df89f3abe2c2ca$exports.getInteractionModality)();
manager.setFocused(true);
let navigateToKey = (key)=>{
if (key != null) {
manager.setFocusedKey(key);
if (selectOnFocus && !manager.isSelected(key)) manager.replaceSelection(key);
}
};
// we need the "virtual" modality case checks here because shift tabbing from the prompt field's attachment card back into the
// thread is a virtual focus event (the tab handler in onKeyDown focuses the ref of the AttachementList aka TagGroup via a focus() call, hence the virtual modality)
if (UNSTABLE_focusOnEntry && (modality === 'keyboard' || modality === 'virtual')) // always go to the first item in the Thread when tabbing forwards/backwards into the collection
// since it is probably more important to the user to see the new prompt reply rather than go to the last focused key
navigateToKey(UNSTABLE_focusOnEntry === 'first' ? delegate.getFirstKey?.() : delegate.getLastKey?.());
else if (manager.focusedKey == null) {
// If the user hasn't yet interacted with the collection, there will be no focusedKey set.
// Attempt to detect whether the user is tabbing forward or backward into the collection
// and either focus the first or last item accordingly.
let relatedTarget = e.relatedTarget;
if (relatedTarget && e.currentTarget.compareDocumentPosition(relatedTarget) & Node.DOCUMENT_POSITION_FOLLOWING) navigateToKey(manager.lastSelectedKey ?? delegate.getLastKey?.());
else navigateToKey(manager.firstSelectedKey ?? delegate.getFirstKey?.());
} else if (scrollRef.current) {
// Restore the scroll position to what it was before.
scrollRef.current.scrollTop = scrollPos.current.top;
scrollRef.current.scrollLeft = scrollPos.current.left;
}
if (manager.focusedKey != null && scrollRef.current) {
// Refocus and scroll the focused item into view if it exists within the scrollable region.
let element = (0, $b07dd3d1fedd87d6$exports.getItemElement)(ref, manager.focusedKey);
if (element instanceof HTMLElement) {
// This prevents a flash of focus on the first/last element in the collection, or the collection itself.
if (!(0, $da02ee888921bc9e$exports.isFocusWithin)(element) && !shouldUseVirtualFocus) (0, $4b9e9ed3f006ad27$exports.focusWithoutScrolling)(element);
if (modality === 'keyboard' || UNSTABLE_focusOnEntry && modality === 'virtual') (0, $9a1324d6ffd8bbb0$exports.scrollIntoViewport)(element, {
containingElement: ref.current
});
}
}
};
let onBlur = (e)=>{
// Don't set blurred and then focused again if moving focus within the collection.
if (!(0, $da02ee888921bc9e$exports.nodeContains)(e.currentTarget, e.relatedTarget)) manager.setFocused(false);
};
// Ref to track whether the first item in the collection should be automatically focused. Specifically used for autocomplete when user types
// to focus the first key AFTER the collection updates.
// TODO: potentially expand the usage of this
let shouldVirtualFocusFirst = (0, $aQuvg$react.useRef)(false);
// Add event listeners for custom virtual events. These handle updating the focused key in response to various keyboard events
// at the autocomplete level
// TODO: fix type later
(0, $6e76e65001bbcda2$exports.useEvent)(ref, (0, $79558b1ff24cb93a$exports.FOCUS_EVENT), !shouldUseVirtualFocus ? undefined : (e)=>{
let { detail: detail } = e;
e.stopPropagation();
manager.setFocused(true);
// If the user is typing forwards, autofocus the first option in the list.
if (detail?.focusStrategy === 'first') shouldVirtualFocusFirst.current = true;
});
// update active descendant
let firstKey = delegate.getFirstKey?.() ?? null;
(0, $826bcd7bc2ba42c6$exports.useUpdateLayoutEffect)(()=>{
if (shouldVirtualFocusFirst.current) {
// If no focusable items exist in the list, make sure to clear any activedescendant that may still exist and move focus back to
// the original active element (e.g. the autocomplete input)
if (firstKey == null) {
let previousActiveElement = (0, $da02ee888921bc9e$exports.getActiveElement)();
(0, $4f541c01c875ab4e$exports.moveVirtualFocus)(ref.current);
(0, $4f541c01c875ab4e$exports.dispatchVirtualFocus)(previousActiveElement, null);
// If there wasn't a focusable key but the collection had items, then that means we aren't in an intermediate load state and all keys are disabled.
// Reset shouldVirtualFocusFirst so that we don't erronously autofocus an item when the collection is filtered again.
if (manager.collection.size > 0) shouldVirtualFocusFirst.current = false;
} else {
manager.setFocusedKey(firstKey);
// Only set shouldVirtualFocusFirst to false if we've successfully set the first key as the focused key
// If there wasn't a key to focus, we might be in a temporary loading state so we'll want to still focus the first key
// after the collection updates after load
shouldVirtualFocusFirst.current = false;
}
}
}, [
firstKey,
manager.collection.size
]);
// reset focus first flag
(0, $826bcd7bc2ba42c6$exports.useUpdateLayoutEffect)(()=>{
// If user causes the focused key to change in any other way, clear shouldVirtualFocusFirst so we don't
// accidentally move focus from under them. Skip this if the collection was empty because we might be in a load
// state and will still want to focus the first item after load
if (manager.collection.size > 0) shouldVirtualFocusFirst.current = false;
}, [
manager.focusedKey
]);
(0, $6e76e65001bbcda2$exports.useEvent)(ref, (0, $79558b1ff24cb93a$exports.CLEAR_FOCUS_EVENT), !shouldUseVirtualFocus ? undefined : (e)=>{
e.stopPropagation();
manager.setFocused(false);
if (e.detail?.clearFocusKey) manager.setFocusedKey(null);
});
const autoFocusRef = (0, $aQuvg$react.useRef)(autoFocus);
const didAutoFocusRef = (0, $aQuvg$react.useRef)(false);
(0, $aQuvg$react.useEffect)(()=>{
if (autoFocusRef.current) {
let focusedKey = null;
// Check focus strategy to determine which item to focus
if (autoFocus === 'first') focusedKey = delegate.getFirstKey?.() ?? null;
if (autoFocus === 'last') focusedKey = delegate.getLastKey?.() ?? null;
// If there are any selected keys, make the first one the new focus target
let selectedKeys = manager.selectedKeys;
if (selectedKeys.size) {
for (let key of selectedKeys)if (manager.canSelectItem(key)) {
focusedKey = key;
break;
}
}
manager.setFocused(true);
manager.setFocusedKey(focusedKey);
// If no default focus key is selected, focus the collection itself.
if (focusedKey == null && !shouldUseVirtualFocus && ref.current) (0, $4a053a4bf25e52fb$exports.focusSafely)(ref.current);
// Wait until the collection has items to autofocus.
if (manager.collection.size > 0) {
autoFocusRef.current = false;
didAutoFocusRef.current = true;
}
}
});
// Scroll the focused element into view when the focusedKey changes.
let lastFocusedKey = (0, $aQuvg$react.useRef)(manager.focusedKey);
let raf = (0, $aQuvg$react.useRef)(null);
(0, $aQuvg$react.useEffect)(()=>{
if (manager.isFocused && manager.focusedKey != null && (manager.focusedKey !== lastFocusedKey.current || didAutoFocusRef.current) && scrollRef.current && ref.current) {
let modality = (0, $d0df89f3abe2c2ca$exports.getInteractionModality)();
let element = (0, $b07dd3d1fedd87d6$exports.getItemElement)(ref, manager.focusedKey);
if (!(element instanceof HTMLElement)) // If item element wasn't found, return early (don't update autoFocusRef and lastFocusedKey).
// The collection may initially be empty (e.g. virtualizer), so wait until the element exists.
return;
if (modality === 'keyboard' || didAutoFocusRef.current) {
if (raf.current) cancelAnimationFrame(raf.current);
raf.current = requestAnimationFrame(()=>{
if (scrollRef.current) {
(0, $9a1324d6ffd8bbb0$exports.scrollIntoView)(scrollRef.current, element);
// Avoid scroll in iOS VO, since it may cause overlay to close (i.e. RAC submenu)
if (modality !== 'virtual') (0, $9a1324d6ffd8bbb0$exports.scrollIntoViewport)(element, {
containingElement: ref.current
});
}
});
}
}
// If the focused key becomes null (e.g. the last item is deleted), focus the whole collection.
if (!shouldUseVirtualFocus && manager.isFocused && manager.focusedKey == null && lastFocusedKey.current != null && ref.current) (0, $4a053a4bf25e52fb$exports.focusSafely)(ref.current);
lastFocusedKey.current = manager.focusedKey;
didAutoFocusRef.current = false;
});
(0, $aQuvg$react.useEffect)(()=>{
return ()=>{
if (raf.current) cancelAnimationFrame(raf.current);
};
}, []);
// Intercept FocusScope restoration since virtualized collections can reuse DOM nodes.
(0, $6e76e65001bbcda2$exports.useEvent)(ref, 'react-aria-focus-scope-restore', (e)=>{
e.preventDefault();
manager.setFocused(true);
});
let handlers = {
onKeyDown: onKeyDown,
onFocus: onFocus,
onBlur: onBlur,
onMouseDown (e) {
// Ignore events that bubbled through portals.
if (scrollRef.current === (0, $da02ee888921bc9e$exports.getEventTarget)(e)) // Prevent focus going to the collection when clicking on the scrollbar.
e.preventDefault();
}
};
let { typeSelectProps: typeSelectProps } = (0, $a6299e8d95fc8908$exports.useTypeSelect)({
keyboardDelegate: delegate,
selectionManager: manager
});
if (!disallowTypeAhead) handlers = (0, $89b39774f3b79dbb$exports.mergeProps)(typeSelectProps, handlers);
// If nothing is focused within the collection, make the collection itself tabbable.
// This will be marshalled to either the first or last item depending on where focus came from.
let tabIndex = undefined;
if (!shouldUseVirtualFocus) tabIndex = manager.focusedKey == null ? 0 : -1;
let collectionId = (0, $b07dd3d1fedd87d6$exports.useCollectionId)(manager.collection);
return {
collectionProps: (0, $89b39774f3b79dbb$exports.mergeProps)(handlers, {
tabIndex: tabIndex,
'data-collection': collectionId
})
};
}
//# sourceMappingURL=useSelectableCollection.cjs.map