TabPanel: implement Ariakit internally (#52133)

Co-authored-by: Lena Morita <lena@jaguchi.com>
WordPress · Aug 2, 2023 · 072a09d · 072a09d
1 parent 979ef33
commit 072a09d
Show file tree

Hide file tree

Showing 7 changed files with 266 additions and 209 deletions.
diff --git a/packages/components/CHANGELOG.md b/packages/components/CHANGELOG.md
@@ -10,6 +10,7 @@
 
 -   `ColorPalette`, `BorderControl`: Don't hyphenate hex value in `aria-label` ([#52932](https://github.com/WordPress/gutenberg/pull/52932)).
 -   `MenuItemsChoice`, `MenuItem`: Support a `disabled` prop on a menu item ([#52737](https://github.com/WordPress/gutenberg/pull/52737)).
+-   `TabPanel`: Introduce a new version of `TabPanel` with updated internals and improved adherence to ARIA guidance on `tabpanel` focus behavior while maintaining the same functionality and API surface.([#52133](https://github.com/WordPress/gutenberg/pull/52133)).
 
 ### Bug Fix
 

diff --git a/packages/components/src/tab-panel/index.tsx b/packages/components/src/tab-panel/index.tsx
@@ -1,6 +1,7 @@
 /**
  * External dependencies
  */
+import * as Ariakit from '@ariakit/react';
 import classnames from 'classnames';
 import type { ForwardedRef } from 'react';
 
@@ -9,38 +10,30 @@ import type { ForwardedRef } from 'react';
  */
 import {
 	forwardRef,
-	useState,
 	useEffect,
 	useLayoutEffect,
 	useCallback,
 } from '@wordpress/element';
-import { useInstanceId } from '@wordpress/compose';
+import { useInstanceId, usePrevious } from '@wordpress/compose';
 
 /**
  * Internal dependencies
  */
-import { NavigableMenu } from '../navigable-container';
+
 import Button from '../button';
-import type { TabButtonProps, TabPanelProps } from './types';
+import type { TabPanelProps } from './types';
 import type { WordPressComponentProps } from '../ui/context';
 
-const TabButton = ( {
-	tabId,
-	children,
-	selected,
-	...rest
-}: TabButtonProps ) => (
-	<Button
-		role="tab"
-		tabIndex={ selected ? undefined : -1 }
-		aria-selected={ selected }
-		id={ tabId }
-		__experimentalIsFocusable
-		{ ...rest }
-	>
-		{ children }
-	</Button>
-);
+// Separate the actual tab name from the instance ID. This is
+// necessary because Ariakit internally uses the element ID when
+// a new tab is selected, but our implementation looks specifically
+// for the tab name to be passed to the `onSelect` callback.
+const extractTabName = ( id: string | undefined | null ) => {
+	if ( typeof id === 'undefined' || id === null ) {
+		return;
+	}
+	return id.match( /^tab-panel-[0-9]*-(.*)/ )?.[ 1 ];
+};
 
 /**
  * TabPanel is an ARIA-compliant tabpanel.
@@ -92,112 +85,156 @@ const UnforwardedTabPanel = (
 	ref: ForwardedRef< any >
 ) => {
 	const instanceId = useInstanceId( TabPanel, 'tab-panel' );
-	const [ selected, setSelected ] = useState< string >();
 
-	const handleTabSelection = useCallback(
-		( tabKey: string ) => {
-			setSelected( tabKey );
-			onSelect?.( tabKey );
+	const prependInstanceId = useCallback(
+		( tabName: string | undefined ) => {
+			if ( typeof tabName === 'undefined' ) {
+				return;
+			}
+			return `${ instanceId }-${ tabName }`;
+		},
+		[ instanceId ]
+	);
+
+	const tabStore = Ariakit.useTabStore( {
+		setSelectedId: ( newTabValue ) => {
+			if ( typeof newTabValue === 'undefined' || newTabValue === null ) {
+				return;
+			}
+
+			const newTab = tabs.find(
+				( t ) => prependInstanceId( t.name ) === newTabValue
+			);
+			if ( newTab?.disabled || newTab === selectedTab ) {
+				return;
+			}
+
+			const simplifiedTabName = extractTabName( newTabValue );
+			if ( typeof simplifiedTabName === 'undefined' ) {
+				return;
+			}
+
+			onSelect?.( simplifiedTabName );
+		},
+		orientation,
+		selectOnMove,
+		defaultSelectedId: prependInstanceId( initialTabName ),
+	} );
+
+	const selectedTabName = extractTabName( tabStore.useState( 'selectedId' ) );
+
+	const setTabStoreSelectedId = useCallback(
+		( tabName: string ) => {
+			tabStore.setState( 'selectedId', prependInstanceId( tabName ) );
 		},
-		[ onSelect ]
+		[ prependInstanceId, tabStore ]
 	);
 
-	// Simulate a click on the newly focused tab, which causes the component
-	// to show the `tab-panel` associated with the clicked tab.
-	const activateTabAutomatically = (
-		_childIndex: number,
-		child: HTMLElement
-	) => {
-		child.click();
-	};
-	const selectedTab = tabs.find( ( { name } ) => name === selected );
-	const selectedId = `${ instanceId }-${ selectedTab?.name ?? 'none' }`;
+	const selectedTab = tabs.find( ( { name } ) => name === selectedTabName );
+
+	const previousSelectedTabName = usePrevious( selectedTabName );
+
+	// Ensure `onSelect` is called when the initial tab is selected.
+	useEffect( () => {
+		if (
+			previousSelectedTabName !== selectedTabName &&
+			selectedTabName === initialTabName &&
+			!! selectedTabName
+		) {
+			onSelect?.( selectedTabName );
+		}
+	}, [ selectedTabName, initialTabName, onSelect, previousSelectedTabName ] );
 
 	// Handle selecting the initial tab.
 	useLayoutEffect( () => {
 		// If there's a selected tab, don't override it.
 		if ( selectedTab ) {
 			return;
 		}
-
 		const initialTab = tabs.find( ( tab ) => tab.name === initialTabName );
-
 		// Wait for the denoted initial tab to be declared before making a
 		// selection. This ensures that if a tab is declared lazily it can
 		// still receive initial selection.
 		if ( initialTabName && ! initialTab ) {
 			return;
 		}
-
 		if ( initialTab && ! initialTab.disabled ) {
 			// Select the initial tab if it's not disabled.
-			handleTabSelection( initialTab.name );
+			setTabStoreSelectedId( initialTab.name );
 		} else {
-			// Fallback to the first enabled tab when the initial is disabled.
+			// Fallback to the first enabled tab when the initial tab is
+			// disabled or it can't be found.
 			const firstEnabledTab = tabs.find( ( tab ) => ! tab.disabled );
-			if ( firstEnabledTab ) handleTabSelection( firstEnabledTab.name );
+			if ( firstEnabledTab ) {
+				setTabStoreSelectedId( firstEnabledTab.name );
+			}
 		}
-	}, [ tabs, selectedTab, initialTabName, handleTabSelection ] );
+	}, [
+		tabs,
+		selectedTab,
+		initialTabName,
+		instanceId,
+		setTabStoreSelectedId,
+	] );
 
 	// Handle the currently selected tab becoming disabled.
 	useEffect( () => {
 		// This effect only runs when the selected tab is defined and becomes disabled.
 		if ( ! selectedTab?.disabled ) {
 			return;
 		}
-
 		const firstEnabledTab = tabs.find( ( tab ) => ! tab.disabled );
-
 		// If the currently selected tab becomes disabled, select the first enabled tab.
 		// (if there is one).
 		if ( firstEnabledTab ) {
-			handleTabSelection( firstEnabledTab.name );
+			setTabStoreSelectedId( firstEnabledTab.name );
 		}
-	}, [ tabs, selectedTab?.disabled, handleTabSelection ] );
-
+	}, [ tabs, selectedTab?.disabled, setTabStoreSelectedId, instanceId ] );
 	return (
 		<div className={ className } ref={ ref }>
-			<NavigableMenu
-				role="tablist"
-				orientation={ orientation }
-				onNavigate={
-					selectOnMove ? activateTabAutomatically : undefined
-				}
+			<Ariakit.TabList
+				store={ tabStore }
 				className="components-tab-panel__tabs"
 			>
-				{ tabs.map( ( tab ) => (
-					<TabButton
-						className={ classnames(
-							'components-tab-panel__tabs-item',
-							tab.className,
-							{
-								[ activeClass ]: tab.name === selected,
+				{ tabs.map( ( tab ) => {
+					return (
+						<Ariakit.Tab
+							key={ tab.name }
+							id={ prependInstanceId( tab.name ) }
+							className={ classnames(
+								'components-tab-panel__tabs-item',
+								tab.className,
+								{
+									[ activeClass ]:
+										tab.name === selectedTabName,
+								}
+							) }
+							disabled={ tab.disabled }
+							aria-controls={ `${ prependInstanceId(
+								tab.name
+							) }-view` }
+							render={
+								<Button
+									icon={ tab.icon }
+									label={ tab.icon && tab.title }
+									showTooltip={ !! tab.icon }
+								/>
 							}
-						) }
-						tabId={ `${ instanceId }-${ tab.name }` }
-						aria-controls={ `${ instanceId }-${ tab.name }-view` }
-						selected={ tab.name === selected }
-						key={ tab.name }
-						onClick={ () => handleTabSelection( tab.name ) }
-						disabled={ tab.disabled }
-						label={ tab.icon && tab.title }
-						icon={ tab.icon }
-						showTooltip={ !! tab.icon }
-					>
-						{ ! tab.icon && tab.title }
-					</TabButton>
-				) ) }
-			</NavigableMenu>
+						>
+							{ ! tab.icon && tab.title }
+						</Ariakit.Tab>
+					);
+				} ) }
+			</Ariakit.TabList>
 			{ selectedTab && (
-				<div
-					key={ selectedId }
-					aria-labelledby={ selectedId }
-					role="tabpanel"
-					id={ `${ selectedId }-view` }
-					className="components-tab-panel__tab-content"
+				<Ariakit.TabPanel
+					id={ `${ prependInstanceId( selectedTab.name ) }-view` }
+					store={ tabStore }
+					tabId={ prependInstanceId( selectedTab.name ) }
+					className={ 'components-tab-panel__tab-content' }
 				>
 					{ children( selectedTab ) }
-				</div>
+				</Ariakit.TabPanel>
 			) }
 		</div>
 	);

diff --git a/packages/components/src/tab-panel/stories/index.tsx b/packages/components/src/tab-panel/stories/index.tsx
@@ -96,3 +96,9 @@ WithTabIconsAndTooltips.args = {
 		},
 	],
 };
+
+export const ManualActivation = Template.bind( {} );
+ManualActivation.args = {
+	...Default.args,
+	selectOnMove: false,
+};