Skip to content

useTabsList API

API reference docs for the useTabsList hook. Learn about the input parameters and other APIs of this exported module.

Demos

For examples and details on the usage of this React hook, visit the demo pages:

Import

import useTabsList from '@mui/base/useTabsList';

Parameters

NameTypeDefaultDescription
ref*React.Ref<unknown>
aria-labelstring
aria-labelledbystring
childrenReact.ReactNode
The content of the component.

Return value

NameTypeDefaultDescription
getRootProps<TOther extends Record<string, any> = {}>(externalProps?: TOther) => UseTabsListRootSlotProps<TOther>
Resolver for the root slot's props.
isRtlbooleanfalse
If true, it will indicate that the text's direction in right-to-left.
orientation'horizontal' | 'vertical''horizontal'
The component orientation (layout flow direction).
processChildren() => React.ReactElement<any, string | React.JSXElementConstructor<any>>[] | null | undefined
Callback for processing the children of the tabs list. It adds the necessary attributes for correct a11y and navigation.
valuestring | number | false
The value of the currently selected Tab.