@base-ui-components/react
Version:
Base UI is a library of headless ('unstyled') React components and low-level hooks. You gain complete control over your app's CSS and accessibility features.
126 lines (122 loc) • 4.47 kB
JavaScript
'use client';
import * as React from 'react';
import { useControlled } from '@base-ui-components/utils/useControlled';
import { useStableCallback } from '@base-ui-components/utils/useStableCallback';
import { useRenderElement } from "../../utils/useRenderElement.js";
import { CompositeList } from "../../composite/list/CompositeList.js";
import { useDirection } from "../../direction-provider/DirectionContext.js";
import { TabsRootContext } from "./TabsRootContext.js";
import { tabsStateAttributesMapping } from "./stateAttributesMapping.js";
import { jsx as _jsx } from "react/jsx-runtime";
/**
* Groups the tabs and the corresponding panels.
* Renders a `<div>` element.
*
* Documentation: [Base UI Tabs](https://base-ui.com/react/components/tabs)
*/
export const TabsRoot = /*#__PURE__*/React.forwardRef(function TabsRoot(componentProps, forwardedRef) {
const {
className,
defaultValue = 0,
onValueChange: onValueChangeProp,
orientation = 'horizontal',
render,
value: valueProp,
...elementProps
} = componentProps;
const direction = useDirection();
const tabPanelRefs = React.useRef([]);
const [mountedTabPanels, setMountedTabPanels] = React.useState(() => new Map());
const [value, setValue] = useControlled({
controlled: valueProp,
default: defaultValue,
name: 'Tabs',
state: 'value'
});
const [tabMap, setTabMap] = React.useState(() => new Map());
const [tabActivationDirection, setTabActivationDirection] = React.useState('none');
const onValueChange = useStableCallback((newValue, eventDetails) => {
onValueChangeProp?.(newValue, eventDetails);
if (eventDetails.isCanceled) {
return;
}
setValue(newValue);
setTabActivationDirection(eventDetails.activationDirection);
});
const registerMountedTabPanel = useStableCallback((panelValue, panelId) => {
setMountedTabPanels(prev => {
if (prev.get(panelValue) === panelId) {
return prev;
}
const next = new Map(prev);
next.set(panelValue, panelId);
return next;
});
});
const unregisterMountedTabPanel = useStableCallback((panelValue, panelId) => {
setMountedTabPanels(prev => {
if (!prev.has(panelValue) || prev.get(panelValue) !== panelId) {
return prev;
}
const next = new Map(prev);
next.delete(panelValue);
return next;
});
});
// get the `id` attribute of <Tabs.Panel> to set as the value of `aria-controls` on <Tabs.Tab>
const getTabPanelIdByValue = React.useCallback(tabValue => {
return mountedTabPanels.get(tabValue);
}, [mountedTabPanels]);
// get the `id` attribute of <Tabs.Tab> to set as the value of `aria-labelledby` on <Tabs.Panel>
const getTabIdByPanelValue = React.useCallback(tabPanelValue => {
for (const tabMetadata of tabMap.values()) {
if (tabPanelValue === tabMetadata?.value) {
return tabMetadata?.id;
}
}
return undefined;
}, [tabMap]);
// used in `useActivationDirectionDetector` for setting data-activation-direction
const getTabElementBySelectedValue = React.useCallback(selectedValue => {
if (selectedValue === undefined) {
return null;
}
for (const [tabElement, tabMetadata] of tabMap.entries()) {
if (tabMetadata != null && selectedValue === (tabMetadata.value ?? tabMetadata.index)) {
return tabElement;
}
}
return null;
}, [tabMap]);
const tabsContextValue = React.useMemo(() => ({
direction,
getTabElementBySelectedValue,
getTabIdByPanelValue,
getTabPanelIdByValue,
onValueChange,
orientation,
registerMountedTabPanel,
setTabMap,
unregisterMountedTabPanel,
tabActivationDirection,
value
}), [direction, getTabElementBySelectedValue, getTabIdByPanelValue, getTabPanelIdByValue, onValueChange, orientation, registerMountedTabPanel, setTabMap, unregisterMountedTabPanel, tabActivationDirection, value]);
const state = {
orientation,
tabActivationDirection
};
const element = useRenderElement('div', componentProps, {
state,
ref: forwardedRef,
props: elementProps,
stateAttributesMapping: tabsStateAttributesMapping
});
return /*#__PURE__*/_jsx(TabsRootContext.Provider, {
value: tabsContextValue,
children: /*#__PURE__*/_jsx(CompositeList, {
elementsRef: tabPanelRefs,
children: element
})
});
});
if (process.env.NODE_ENV !== "production") TabsRoot.displayName = "TabsRoot";