Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOM: fix return types of focus.tabbable methods #60274

Merged
merged 1 commit into from Mar 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Expand Up @@ -79,7 +79,7 @@ class NavigableContainer extends Component< NavigableContainerProps > {

const { onlyBrowserTabstops } = this.props;
const finder = onlyBrowserTabstops ? focus.tabbable : focus.focusable;
const focusables = finder.find( this.container ) as HTMLElement[];
const focusables = finder.find( this.container );

const index = this.getFocusableIndex( focusables, target );
if ( index > -1 && target ) {
Expand Down
Expand Up @@ -115,9 +115,7 @@ function UnconnectedNavigatorScreen(
// If the previous query didn't run or find any element to focus, fallback
// to the first tabbable element in the screen (or the screen itself).
if ( ! elementToFocus ) {
const firstTabbable = (
focus.tabbable.find( wrapperRef.current ) as HTMLElement[]
)[ 0 ];
const [ firstTabbable ] = focus.tabbable.find( wrapperRef.current );
elementToFocus = firstTabbable ?? wrapperRef.current;
}

Expand Down
Expand Up @@ -54,7 +54,7 @@ function useConstrainedTabbing() {
/** @type {HTMLElement} */ ( target ).contains( nextElement )
) {
event.preventDefault();
/** @type {HTMLElement} */ ( nextElement )?.focus();
nextElement?.focus();
return;
}

Expand Down
2 changes: 1 addition & 1 deletion packages/compose/src/hooks/use-focus-on-mount/index.js
Expand Up @@ -72,7 +72,7 @@ export default function useFocusOnMount( focusOnMount = 'firstElement' ) {
const firstTabbable = focus.tabbable.find( node )[ 0 ];

if ( firstTabbable ) {
setFocus( /** @type {HTMLElement} */ ( firstTabbable ) );
setFocus( firstTabbable );
}
}, 0 );

Expand Down
2 changes: 2 additions & 0 deletions packages/dom/CHANGELOG.md
Expand Up @@ -2,6 +2,8 @@

## Unreleased

- fix return types of `focus.tabbable` methods to be `HTMLElement` instead of `Element`.

## 3.54.0 (2024-03-21)

## 3.53.0 (2024-03-06)
Expand Down
2 changes: 1 addition & 1 deletion packages/dom/src/dom/is-edge.js
Expand Up @@ -37,7 +37,7 @@ export default function isEdge( container, isReverse, onlyVertical = false ) {
return container.value.length === container.selectionStart;
}

if ( ! ( /** @type {HTMLElement} */ ( container ).isContentEditable ) ) {
if ( ! container.isContentEditable ) {
return true;
}

Expand Down
2 changes: 0 additions & 2 deletions packages/dom/src/focusable.js
Expand Up @@ -98,9 +98,7 @@ function isValidFocusableArea( element ) {
* @return {HTMLElement[]} Focusable elements.
*/
export function find( context, { sequential = false } = {} ) {
/* eslint-disable jsdoc/no-undefined-types */
/** @type {NodeListOf<HTMLElement>} */
/* eslint-enable jsdoc/no-undefined-types */
const elements = context.querySelectorAll( buildSelector( sequential ) );

return Array.from( elements ).filter( ( element ) => {
Expand Down
44 changes: 20 additions & 24 deletions packages/dom/src/tabbable.js
Expand Up @@ -31,7 +31,7 @@ export function isTabbableIndex( element ) {
return getTabIndex( element ) !== -1;
}

/** @typedef {Element & { type?: string, checked?: boolean, name?: string }} MaybeHTMLInputElement */
/** @typedef {HTMLElement & { type?: string, checked?: boolean, name?: string }} MaybeHTMLInputElement */

/**
* Returns a stateful reducer function which constructs a filtered array of
Expand Down Expand Up @@ -84,10 +84,10 @@ function createStatefulCollapseRadioGroup() {
* sort where equal tabIndex should be left in order of their occurrence in the
* document.
*
* @param {Element} element Element.
* @param {number} index Array index of element.
* @param {HTMLElement} element Element.
* @param {number} index Array index of element.
*
* @return {{ element: Element, index: number }} Mapped object with element, index.
* @return {{ element: HTMLElement, index: number }} Mapped object with element, index.
*/
function mapElementToObjectTabbable( element, index ) {
return { element, index };
Expand All @@ -97,9 +97,9 @@ function mapElementToObjectTabbable( element, index ) {
* An array map callback, returning an element of the given mapped object's
* element value.
*
* @param {{ element: Element }} object Mapped object with element.
* @param {{ element: HTMLElement }} object Mapped object with element.
*
* @return {Element} Mapped object element.
* @return {HTMLElement} Mapped object element.
*/
function mapObjectTabbableToElement( object ) {
return object.element;
Expand All @@ -110,8 +110,8 @@ function mapObjectTabbableToElement( object ) {
*
* @see mapElementToObjectTabbable
*
* @param {{ element: Element, index: number }} a First object to compare.
* @param {{ element: Element, index: number }} b Second object to compare.
* @param {{ element: HTMLElement, index: number }} a First object to compare.
* @param {{ element: HTMLElement, index: number }} b Second object to compare.
*
* @return {number} Comparator result.
*/
Expand All @@ -129,9 +129,9 @@ function compareObjectTabbables( a, b ) {
/**
* Givin focusable elements, filters out tabbable element.
*
* @param {Element[]} focusables Focusable elements to filter.
* @param {HTMLElement[]} focusables Focusable elements to filter.
*
* @return {Element[]} Tabbable elements.
* @return {HTMLElement[]} Tabbable elements.
*/
function filterTabbable( focusables ) {
return focusables
Expand All @@ -144,7 +144,7 @@ function filterTabbable( focusables ) {

/**
* @param {Element} context
* @return {Element[]} Tabbable elements within the context.
* @return {HTMLElement[]} Tabbable elements within the context.
*/
export function find( context ) {
return filterTabbable( findFocusable( context ) );
Expand All @@ -156,18 +156,17 @@ export function find( context ) {
* @param {Element} element The focusable element before which to look. Defaults
* to the active element.
*
* @return {Element|undefined} Preceding tabbable element.
* @return {HTMLElement|undefined} Preceding tabbable element.
*/
export function findPrevious( element ) {
return filterTabbable( findFocusable( element.ownerDocument.body ) )
.reverse()
.find( ( focusable ) => {
return (
.find(
( focusable ) =>
// eslint-disable-next-line no-bitwise
element.compareDocumentPosition( focusable ) &
element.DOCUMENT_POSITION_PRECEDING
);
} );
);
}

/**
Expand All @@ -176,16 +175,13 @@ export function findPrevious( element ) {
* @param {Element} element The focusable element after which to look. Defaults
* to the active element.
*
* @return {Element|undefined} Next tabbable element.
* @return {HTMLElement|undefined} Next tabbable element.
*/
export function findNext( element ) {
return filterTabbable( findFocusable( element.ownerDocument.body ) ).find(
( focusable ) => {
return (
// eslint-disable-next-line no-bitwise
element.compareDocumentPosition( focusable ) &
element.DOCUMENT_POSITION_FOLLOWING
);
}
( focusable ) =>
// eslint-disable-next-line no-bitwise
element.compareDocumentPosition( focusable ) &
element.DOCUMENT_POSITION_FOLLOWING
);
}