@wordpress/components
Version:
UI components for WordPress.
146 lines (145 loc) • 4.96 kB
JavaScript
import * as Ariakit from "@ariakit/react";
import clsx from "clsx";
import { forwardRef, useCallback, useEffect, useLayoutEffect } from "@wordpress/element";
import { useInstanceId, usePrevious } from "@wordpress/compose";
import { isRTL } from "@wordpress/i18n";
import Button from "../button/index.mjs";
import { jsx, jsxs } from "react/jsx-runtime";
// packages/components/src/tab-panel/index.tsx
const extractTabName = (id) => {
if (typeof id === "undefined" || id === null) return;
return id.match(/^tab-panel-[0-9]*-(.*)/)?.[1];
};
/**
* TabPanel is an ARIA-compliant tabpanel.
*
* TabPanels organize content across different screens, data sets, and interactions.
* It has two sections: a list of tabs, and the view to show when tabs are chosen.
*
* ```jsx
* import { TabPanel } from '@wordpress/components';
*
* const onSelect = ( tabName ) => {
* console.log( 'Selecting tab', tabName );
* };
*
* const MyTabPanel = () => (
* <TabPanel
* className="my-tab-panel"
* activeClass="active-tab"
* onSelect={ onSelect }
* tabs={ [
* {
* name: 'tab1',
* title: 'Tab 1',
* className: 'tab-one',
* },
* {
* name: 'tab2',
* title: 'Tab 2',
* className: 'tab-two',
* },
* ] }
* >
* { ( tab ) => <p>{ tab.title }</p> }
* </TabPanel>
* );
* ```
*/
const UnforwardedTabPanel = ({ className, children, tabs, selectOnMove = true, initialTabName, orientation = "horizontal", activeClass = "is-active", onSelect }, ref) => {
const instanceId = useInstanceId(TabPanel, "tab-panel");
const prependInstanceId = useCallback((tabName) => {
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),
rtl: isRTL()
});
const selectedTabName = extractTabName(Ariakit.useStoreState(tabStore, "selectedId"));
const setTabStoreSelectedId = useCallback((tabName) => {
tabStore.setState("selectedId", prependInstanceId(tabName));
}, [prependInstanceId, tabStore]);
const selectedTab = tabs.find(({ name }) => name === selectedTabName);
const previousSelectedTabName = usePrevious(selectedTabName);
useEffect(() => {
if (previousSelectedTabName !== selectedTabName && selectedTabName === initialTabName && !!selectedTabName) onSelect?.(selectedTabName);
}, [
selectedTabName,
initialTabName,
onSelect,
previousSelectedTabName
]);
useLayoutEffect(() => {
if (selectedTab) return;
const initialTab = tabs.find((tab) => tab.name === initialTabName);
if (initialTabName && !initialTab) return;
if (initialTab && !initialTab.disabled) setTabStoreSelectedId(initialTab.name);
else {
const firstEnabledTab = tabs.find((tab) => !tab.disabled);
if (firstEnabledTab) setTabStoreSelectedId(firstEnabledTab.name);
}
}, [
tabs,
selectedTab,
initialTabName,
instanceId,
setTabStoreSelectedId
]);
useEffect(() => {
if (!selectedTab?.disabled) return;
const firstEnabledTab = tabs.find((tab) => !tab.disabled);
if (firstEnabledTab) setTabStoreSelectedId(firstEnabledTab.name);
}, [
tabs,
selectedTab?.disabled,
setTabStoreSelectedId,
instanceId
]);
return /* @__PURE__ */ jsxs("div", {
className,
ref,
children: [/* @__PURE__ */ jsx(Ariakit.TabList, {
store: tabStore,
className: "components-tab-panel__tabs",
children: tabs.map((tab) => {
return /* @__PURE__ */ jsx(Ariakit.Tab, {
id: prependInstanceId(tab.name),
className: clsx("components-tab-panel__tabs-item", tab.className, { [activeClass]: tab.name === selectedTabName }),
disabled: tab.disabled,
"aria-controls": `${prependInstanceId(tab.name)}-view`,
render: /* @__PURE__ */ jsx(Button, {
__next40pxDefaultSize: true,
icon: tab.icon,
label: tab.icon && tab.title,
showTooltip: !!tab.icon
}),
children: !tab.icon && /* @__PURE__ */ jsx("span", {
className: "components-tab-panel__tabs-item-label",
children: tab.title
})
}, tab.name);
})
}), selectedTab && /* @__PURE__ */ jsx(Ariakit.TabPanel, {
id: `${prependInstanceId(selectedTab.name)}-view`,
store: tabStore,
tabId: prependInstanceId(selectedTab.name),
className: "components-tab-panel__tab-content",
children: children(selectedTab)
})]
});
};
const TabPanel = forwardRef(UnforwardedTabPanel);
TabPanel.displayName = "TabPanel";
export { TabPanel, TabPanel as default };
//# sourceMappingURL=index.mjs.map