FrontPastel/node_modules/@mui/material/Tabs/Tabs.js

840 lines
29 KiB
JavaScript
Raw Normal View History

2024-04-17 13:55:11 +00:00
'use client';
import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
import _extends from "@babel/runtime/helpers/esm/extends";
const _excluded = ["aria-label", "aria-labelledby", "action", "centered", "children", "className", "component", "allowScrollButtonsMobile", "indicatorColor", "onChange", "orientation", "ScrollButtonComponent", "scrollButtons", "selectionFollowsFocus", "slots", "slotProps", "TabIndicatorProps", "TabScrollButtonProps", "textColor", "value", "variant", "visibleScrollbar"];
import * as React from 'react';
import { isFragment } from 'react-is';
import PropTypes from 'prop-types';
import clsx from 'clsx';
import refType from '@mui/utils/refType';
import { useSlotProps } from '@mui/base/utils';
import composeClasses from '@mui/utils/composeClasses';
import { useRtl } from '@mui/system/RtlProvider';
import styled from '../styles/styled';
import useThemeProps from '../styles/useThemeProps';
import useTheme from '../styles/useTheme';
import debounce from '../utils/debounce';
import { getNormalizedScrollLeft, detectScrollType } from '../utils/scrollLeft';
import animate from '../internal/animate';
import ScrollbarSize from './ScrollbarSize';
import TabScrollButton from '../TabScrollButton';
import useEventCallback from '../utils/useEventCallback';
import tabsClasses, { getTabsUtilityClass } from './tabsClasses';
import ownerDocument from '../utils/ownerDocument';
import ownerWindow from '../utils/ownerWindow';
import { jsx as _jsx } from "react/jsx-runtime";
import { jsxs as _jsxs } from "react/jsx-runtime";
const nextItem = (list, item) => {
if (list === item) {
return list.firstChild;
}
if (item && item.nextElementSibling) {
return item.nextElementSibling;
}
return list.firstChild;
};
const previousItem = (list, item) => {
if (list === item) {
return list.lastChild;
}
if (item && item.previousElementSibling) {
return item.previousElementSibling;
}
return list.lastChild;
};
const moveFocus = (list, currentFocus, traversalFunction) => {
let wrappedOnce = false;
let nextFocus = traversalFunction(list, currentFocus);
while (nextFocus) {
// Prevent infinite loop.
if (nextFocus === list.firstChild) {
if (wrappedOnce) {
return;
}
wrappedOnce = true;
}
// Same logic as useAutocomplete.js
const nextFocusDisabled = nextFocus.disabled || nextFocus.getAttribute('aria-disabled') === 'true';
if (!nextFocus.hasAttribute('tabindex') || nextFocusDisabled) {
// Move to the next element.
nextFocus = traversalFunction(list, nextFocus);
} else {
nextFocus.focus();
return;
}
}
};
const useUtilityClasses = ownerState => {
const {
vertical,
fixed,
hideScrollbar,
scrollableX,
scrollableY,
centered,
scrollButtonsHideMobile,
classes
} = ownerState;
const slots = {
root: ['root', vertical && 'vertical'],
scroller: ['scroller', fixed && 'fixed', hideScrollbar && 'hideScrollbar', scrollableX && 'scrollableX', scrollableY && 'scrollableY'],
flexContainer: ['flexContainer', vertical && 'flexContainerVertical', centered && 'centered'],
indicator: ['indicator'],
scrollButtons: ['scrollButtons', scrollButtonsHideMobile && 'scrollButtonsHideMobile'],
scrollableX: [scrollableX && 'scrollableX'],
hideScrollbar: [hideScrollbar && 'hideScrollbar']
};
return composeClasses(slots, getTabsUtilityClass, classes);
};
const TabsRoot = styled('div', {
name: 'MuiTabs',
slot: 'Root',
overridesResolver: (props, styles) => {
const {
ownerState
} = props;
return [{
[`& .${tabsClasses.scrollButtons}`]: styles.scrollButtons
}, {
[`& .${tabsClasses.scrollButtons}`]: ownerState.scrollButtonsHideMobile && styles.scrollButtonsHideMobile
}, styles.root, ownerState.vertical && styles.vertical];
}
})(({
ownerState,
theme
}) => _extends({
overflow: 'hidden',
minHeight: 48,
// Add iOS momentum scrolling for iOS < 13.0
WebkitOverflowScrolling: 'touch',
display: 'flex'
}, ownerState.vertical && {
flexDirection: 'column'
}, ownerState.scrollButtonsHideMobile && {
[`& .${tabsClasses.scrollButtons}`]: {
[theme.breakpoints.down('sm')]: {
display: 'none'
}
}
}));
const TabsScroller = styled('div', {
name: 'MuiTabs',
slot: 'Scroller',
overridesResolver: (props, styles) => {
const {
ownerState
} = props;
return [styles.scroller, ownerState.fixed && styles.fixed, ownerState.hideScrollbar && styles.hideScrollbar, ownerState.scrollableX && styles.scrollableX, ownerState.scrollableY && styles.scrollableY];
}
})(({
ownerState
}) => _extends({
position: 'relative',
display: 'inline-block',
flex: '1 1 auto',
whiteSpace: 'nowrap'
}, ownerState.fixed && {
overflowX: 'hidden',
width: '100%'
}, ownerState.hideScrollbar && {
// Hide dimensionless scrollbar on macOS
scrollbarWidth: 'none',
// Firefox
'&::-webkit-scrollbar': {
display: 'none' // Safari + Chrome
}
}, ownerState.scrollableX && {
overflowX: 'auto',
overflowY: 'hidden'
}, ownerState.scrollableY && {
overflowY: 'auto',
overflowX: 'hidden'
}));
const FlexContainer = styled('div', {
name: 'MuiTabs',
slot: 'FlexContainer',
overridesResolver: (props, styles) => {
const {
ownerState
} = props;
return [styles.flexContainer, ownerState.vertical && styles.flexContainerVertical, ownerState.centered && styles.centered];
}
})(({
ownerState
}) => _extends({
display: 'flex'
}, ownerState.vertical && {
flexDirection: 'column'
}, ownerState.centered && {
justifyContent: 'center'
}));
const TabsIndicator = styled('span', {
name: 'MuiTabs',
slot: 'Indicator',
overridesResolver: (props, styles) => styles.indicator
})(({
ownerState,
theme
}) => _extends({
position: 'absolute',
height: 2,
bottom: 0,
width: '100%',
transition: theme.transitions.create()
}, ownerState.indicatorColor === 'primary' && {
backgroundColor: (theme.vars || theme).palette.primary.main
}, ownerState.indicatorColor === 'secondary' && {
backgroundColor: (theme.vars || theme).palette.secondary.main
}, ownerState.vertical && {
height: '100%',
width: 2,
right: 0
}));
const TabsScrollbarSize = styled(ScrollbarSize)({
overflowX: 'auto',
overflowY: 'hidden',
// Hide dimensionless scrollbar on macOS
scrollbarWidth: 'none',
// Firefox
'&::-webkit-scrollbar': {
display: 'none' // Safari + Chrome
}
});
const defaultIndicatorStyle = {};
let warnedOnceTabPresent = false;
const Tabs = /*#__PURE__*/React.forwardRef(function Tabs(inProps, ref) {
const props = useThemeProps({
props: inProps,
name: 'MuiTabs'
});
const theme = useTheme();
const isRtl = useRtl();
const {
'aria-label': ariaLabel,
'aria-labelledby': ariaLabelledBy,
action,
centered = false,
children: childrenProp,
className,
component = 'div',
allowScrollButtonsMobile = false,
indicatorColor = 'primary',
onChange,
orientation = 'horizontal',
ScrollButtonComponent = TabScrollButton,
scrollButtons = 'auto',
selectionFollowsFocus,
slots = {},
slotProps = {},
TabIndicatorProps = {},
TabScrollButtonProps = {},
textColor = 'primary',
value,
variant = 'standard',
visibleScrollbar = false
} = props,
other = _objectWithoutPropertiesLoose(props, _excluded);
const scrollable = variant === 'scrollable';
const vertical = orientation === 'vertical';
const scrollStart = vertical ? 'scrollTop' : 'scrollLeft';
const start = vertical ? 'top' : 'left';
const end = vertical ? 'bottom' : 'right';
const clientSize = vertical ? 'clientHeight' : 'clientWidth';
const size = vertical ? 'height' : 'width';
const ownerState = _extends({}, props, {
component,
allowScrollButtonsMobile,
indicatorColor,
orientation,
vertical,
scrollButtons,
textColor,
variant,
visibleScrollbar,
fixed: !scrollable,
hideScrollbar: scrollable && !visibleScrollbar,
scrollableX: scrollable && !vertical,
scrollableY: scrollable && vertical,
centered: centered && !scrollable,
scrollButtonsHideMobile: !allowScrollButtonsMobile
});
const classes = useUtilityClasses(ownerState);
const startScrollButtonIconProps = useSlotProps({
elementType: slots.StartScrollButtonIcon,
externalSlotProps: slotProps.startScrollButtonIcon,
ownerState
});
const endScrollButtonIconProps = useSlotProps({
elementType: slots.EndScrollButtonIcon,
externalSlotProps: slotProps.endScrollButtonIcon,
ownerState
});
if (process.env.NODE_ENV !== 'production') {
if (centered && scrollable) {
console.error('MUI: You can not use the `centered={true}` and `variant="scrollable"` properties ' + 'at the same time on a `Tabs` component.');
}
}
const [mounted, setMounted] = React.useState(false);
const [indicatorStyle, setIndicatorStyle] = React.useState(defaultIndicatorStyle);
const [displayStartScroll, setDisplayStartScroll] = React.useState(false);
const [displayEndScroll, setDisplayEndScroll] = React.useState(false);
const [updateScrollObserver, setUpdateScrollObserver] = React.useState(false);
const [scrollerStyle, setScrollerStyle] = React.useState({
overflow: 'hidden',
scrollbarWidth: 0
});
const valueToIndex = new Map();
const tabsRef = React.useRef(null);
const tabListRef = React.useRef(null);
const getTabsMeta = () => {
const tabsNode = tabsRef.current;
let tabsMeta;
if (tabsNode) {
const rect = tabsNode.getBoundingClientRect();
// create a new object with ClientRect class props + scrollLeft
tabsMeta = {
clientWidth: tabsNode.clientWidth,
scrollLeft: tabsNode.scrollLeft,
scrollTop: tabsNode.scrollTop,
scrollLeftNormalized: getNormalizedScrollLeft(tabsNode, isRtl ? 'rtl' : 'ltr'),
scrollWidth: tabsNode.scrollWidth,
top: rect.top,
bottom: rect.bottom,
left: rect.left,
right: rect.right
};
}
let tabMeta;
if (tabsNode && value !== false) {
const children = tabListRef.current.children;
if (children.length > 0) {
const tab = children[valueToIndex.get(value)];
if (process.env.NODE_ENV !== 'production') {
if (!tab) {
console.error([`MUI: The \`value\` provided to the Tabs component is invalid.`, `None of the Tabs' children match with "${value}".`, valueToIndex.keys ? `You can provide one of the following values: ${Array.from(valueToIndex.keys()).join(', ')}.` : null].join('\n'));
}
}
tabMeta = tab ? tab.getBoundingClientRect() : null;
if (process.env.NODE_ENV !== 'production') {
if (process.env.NODE_ENV !== 'test' && !warnedOnceTabPresent && tabMeta && tabMeta.width === 0 && tabMeta.height === 0 &&
// if the whole Tabs component is hidden, don't warn
tabsMeta.clientWidth !== 0) {
tabsMeta = null;
console.error(['MUI: The `value` provided to the Tabs component is invalid.', `The Tab with this \`value\` ("${value}") is not part of the document layout.`, "Make sure the tab item is present in the document or that it's not `display: none`."].join('\n'));
warnedOnceTabPresent = true;
}
}
}
}
return {
tabsMeta,
tabMeta
};
};
const updateIndicatorState = useEventCallback(() => {
const {
tabsMeta,
tabMeta
} = getTabsMeta();
let startValue = 0;
let startIndicator;
if (vertical) {
startIndicator = 'top';
if (tabMeta && tabsMeta) {
startValue = tabMeta.top - tabsMeta.top + tabsMeta.scrollTop;
}
} else {
startIndicator = isRtl ? 'right' : 'left';
if (tabMeta && tabsMeta) {
const correction = isRtl ? tabsMeta.scrollLeftNormalized + tabsMeta.clientWidth - tabsMeta.scrollWidth : tabsMeta.scrollLeft;
startValue = (isRtl ? -1 : 1) * (tabMeta[startIndicator] - tabsMeta[startIndicator] + correction);
}
}
const newIndicatorStyle = {
[startIndicator]: startValue,
// May be wrong until the font is loaded.
[size]: tabMeta ? tabMeta[size] : 0
};
// IE11 support, replace with Number.isNaN
// eslint-disable-next-line no-restricted-globals
if (isNaN(indicatorStyle[startIndicator]) || isNaN(indicatorStyle[size])) {
setIndicatorStyle(newIndicatorStyle);
} else {
const dStart = Math.abs(indicatorStyle[startIndicator] - newIndicatorStyle[startIndicator]);
const dSize = Math.abs(indicatorStyle[size] - newIndicatorStyle[size]);
if (dStart >= 1 || dSize >= 1) {
setIndicatorStyle(newIndicatorStyle);
}
}
});
const scroll = (scrollValue, {
animation = true
} = {}) => {
if (animation) {
animate(scrollStart, tabsRef.current, scrollValue, {
duration: theme.transitions.duration.standard
});
} else {
tabsRef.current[scrollStart] = scrollValue;
}
};
const moveTabsScroll = delta => {
let scrollValue = tabsRef.current[scrollStart];
if (vertical) {
scrollValue += delta;
} else {
scrollValue += delta * (isRtl ? -1 : 1);
// Fix for Edge
scrollValue *= isRtl && detectScrollType() === 'reverse' ? -1 : 1;
}
scroll(scrollValue);
};
const getScrollSize = () => {
const containerSize = tabsRef.current[clientSize];
let totalSize = 0;
const children = Array.from(tabListRef.current.children);
for (let i = 0; i < children.length; i += 1) {
const tab = children[i];
if (totalSize + tab[clientSize] > containerSize) {
// If the first item is longer than the container size, then only scroll
// by the container size.
if (i === 0) {
totalSize = containerSize;
}
break;
}
totalSize += tab[clientSize];
}
return totalSize;
};
const handleStartScrollClick = () => {
moveTabsScroll(-1 * getScrollSize());
};
const handleEndScrollClick = () => {
moveTabsScroll(getScrollSize());
};
// TODO Remove <ScrollbarSize /> as browser support for hiding the scrollbar
// with CSS improves.
const handleScrollbarSizeChange = React.useCallback(scrollbarWidth => {
setScrollerStyle({
overflow: null,
scrollbarWidth
});
}, []);
const getConditionalElements = () => {
const conditionalElements = {};
conditionalElements.scrollbarSizeListener = scrollable ? /*#__PURE__*/_jsx(TabsScrollbarSize, {
onChange: handleScrollbarSizeChange,
className: clsx(classes.scrollableX, classes.hideScrollbar)
}) : null;
const scrollButtonsActive = displayStartScroll || displayEndScroll;
const showScrollButtons = scrollable && (scrollButtons === 'auto' && scrollButtonsActive || scrollButtons === true);
conditionalElements.scrollButtonStart = showScrollButtons ? /*#__PURE__*/_jsx(ScrollButtonComponent, _extends({
slots: {
StartScrollButtonIcon: slots.StartScrollButtonIcon
},
slotProps: {
startScrollButtonIcon: startScrollButtonIconProps
},
orientation: orientation,
direction: isRtl ? 'right' : 'left',
onClick: handleStartScrollClick,
disabled: !displayStartScroll
}, TabScrollButtonProps, {
className: clsx(classes.scrollButtons, TabScrollButtonProps.className)
})) : null;
conditionalElements.scrollButtonEnd = showScrollButtons ? /*#__PURE__*/_jsx(ScrollButtonComponent, _extends({
slots: {
EndScrollButtonIcon: slots.EndScrollButtonIcon
},
slotProps: {
endScrollButtonIcon: endScrollButtonIconProps
},
orientation: orientation,
direction: isRtl ? 'left' : 'right',
onClick: handleEndScrollClick,
disabled: !displayEndScroll
}, TabScrollButtonProps, {
className: clsx(classes.scrollButtons, TabScrollButtonProps.className)
})) : null;
return conditionalElements;
};
const scrollSelectedIntoView = useEventCallback(animation => {
const {
tabsMeta,
tabMeta
} = getTabsMeta();
if (!tabMeta || !tabsMeta) {
return;
}
if (tabMeta[start] < tabsMeta[start]) {
// left side of button is out of view
const nextScrollStart = tabsMeta[scrollStart] + (tabMeta[start] - tabsMeta[start]);
scroll(nextScrollStart, {
animation
});
} else if (tabMeta[end] > tabsMeta[end]) {
// right side of button is out of view
const nextScrollStart = tabsMeta[scrollStart] + (tabMeta[end] - tabsMeta[end]);
scroll(nextScrollStart, {
animation
});
}
});
const updateScrollButtonState = useEventCallback(() => {
if (scrollable && scrollButtons !== false) {
setUpdateScrollObserver(!updateScrollObserver);
}
});
React.useEffect(() => {
const handleResize = debounce(() => {
// If the Tabs component is replaced by Suspense with a fallback, the last
// ResizeObserver's handler that runs because of the change in the layout is trying to
// access a dom node that is no longer there (as the fallback component is being shown instead).
// See https://github.com/mui/material-ui/issues/33276
// TODO: Add tests that will ensure the component is not failing when
// replaced by Suspense with a fallback, once React is updated to version 18
if (tabsRef.current) {
updateIndicatorState();
}
});
let resizeObserver;
/**
* @type {MutationCallback}
*/
const handleMutation = records => {
records.forEach(record => {
record.removedNodes.forEach(item => {
var _resizeObserver;
(_resizeObserver = resizeObserver) == null || _resizeObserver.unobserve(item);
});
record.addedNodes.forEach(item => {
var _resizeObserver2;
(_resizeObserver2 = resizeObserver) == null || _resizeObserver2.observe(item);
});
});
handleResize();
updateScrollButtonState();
};
const win = ownerWindow(tabsRef.current);
win.addEventListener('resize', handleResize);
let mutationObserver;
if (typeof ResizeObserver !== 'undefined') {
resizeObserver = new ResizeObserver(handleResize);
Array.from(tabListRef.current.children).forEach(child => {
resizeObserver.observe(child);
});
}
if (typeof MutationObserver !== 'undefined') {
mutationObserver = new MutationObserver(handleMutation);
mutationObserver.observe(tabListRef.current, {
childList: true
});
}
return () => {
var _mutationObserver, _resizeObserver3;
handleResize.clear();
win.removeEventListener('resize', handleResize);
(_mutationObserver = mutationObserver) == null || _mutationObserver.disconnect();
(_resizeObserver3 = resizeObserver) == null || _resizeObserver3.disconnect();
};
}, [updateIndicatorState, updateScrollButtonState]);
/**
* Toggle visibility of start and end scroll buttons
* Using IntersectionObserver on first and last Tabs.
*/
React.useEffect(() => {
const tabListChildren = Array.from(tabListRef.current.children);
const length = tabListChildren.length;
if (typeof IntersectionObserver !== 'undefined' && length > 0 && scrollable && scrollButtons !== false) {
const firstTab = tabListChildren[0];
const lastTab = tabListChildren[length - 1];
const observerOptions = {
root: tabsRef.current,
threshold: 0.99
};
const handleScrollButtonStart = entries => {
setDisplayStartScroll(!entries[0].isIntersecting);
};
const firstObserver = new IntersectionObserver(handleScrollButtonStart, observerOptions);
firstObserver.observe(firstTab);
const handleScrollButtonEnd = entries => {
setDisplayEndScroll(!entries[0].isIntersecting);
};
const lastObserver = new IntersectionObserver(handleScrollButtonEnd, observerOptions);
lastObserver.observe(lastTab);
return () => {
firstObserver.disconnect();
lastObserver.disconnect();
};
}
return undefined;
}, [scrollable, scrollButtons, updateScrollObserver, childrenProp == null ? void 0 : childrenProp.length]);
React.useEffect(() => {
setMounted(true);
}, []);
React.useEffect(() => {
updateIndicatorState();
});
React.useEffect(() => {
// Don't animate on the first render.
scrollSelectedIntoView(defaultIndicatorStyle !== indicatorStyle);
}, [scrollSelectedIntoView, indicatorStyle]);
React.useImperativeHandle(action, () => ({
updateIndicator: updateIndicatorState,
updateScrollButtons: updateScrollButtonState
}), [updateIndicatorState, updateScrollButtonState]);
const indicator = /*#__PURE__*/_jsx(TabsIndicator, _extends({}, TabIndicatorProps, {
className: clsx(classes.indicator, TabIndicatorProps.className),
ownerState: ownerState,
style: _extends({}, indicatorStyle, TabIndicatorProps.style)
}));
let childIndex = 0;
const children = React.Children.map(childrenProp, child => {
if (! /*#__PURE__*/React.isValidElement(child)) {
return null;
}
if (process.env.NODE_ENV !== 'production') {
if (isFragment(child)) {
console.error(["MUI: The Tabs component doesn't accept a Fragment as a child.", 'Consider providing an array instead.'].join('\n'));
}
}
const childValue = child.props.value === undefined ? childIndex : child.props.value;
valueToIndex.set(childValue, childIndex);
const selected = childValue === value;
childIndex += 1;
return /*#__PURE__*/React.cloneElement(child, _extends({
fullWidth: variant === 'fullWidth',
indicator: selected && !mounted && indicator,
selected,
selectionFollowsFocus,
onChange,
textColor,
value: childValue
}, childIndex === 1 && value === false && !child.props.tabIndex ? {
tabIndex: 0
} : {}));
});
const handleKeyDown = event => {
const list = tabListRef.current;
const currentFocus = ownerDocument(list).activeElement;
// Keyboard navigation assumes that [role="tab"] are siblings
// though we might warn in the future about nested, interactive elements
// as a a11y violation
const role = currentFocus.getAttribute('role');
if (role !== 'tab') {
return;
}
let previousItemKey = orientation === 'horizontal' ? 'ArrowLeft' : 'ArrowUp';
let nextItemKey = orientation === 'horizontal' ? 'ArrowRight' : 'ArrowDown';
if (orientation === 'horizontal' && isRtl) {
// swap previousItemKey with nextItemKey
previousItemKey = 'ArrowRight';
nextItemKey = 'ArrowLeft';
}
switch (event.key) {
case previousItemKey:
event.preventDefault();
moveFocus(list, currentFocus, previousItem);
break;
case nextItemKey:
event.preventDefault();
moveFocus(list, currentFocus, nextItem);
break;
case 'Home':
event.preventDefault();
moveFocus(list, null, nextItem);
break;
case 'End':
event.preventDefault();
moveFocus(list, null, previousItem);
break;
default:
break;
}
};
const conditionalElements = getConditionalElements();
return /*#__PURE__*/_jsxs(TabsRoot, _extends({
className: clsx(classes.root, className),
ownerState: ownerState,
ref: ref,
as: component
}, other, {
children: [conditionalElements.scrollButtonStart, conditionalElements.scrollbarSizeListener, /*#__PURE__*/_jsxs(TabsScroller, {
className: classes.scroller,
ownerState: ownerState,
style: {
overflow: scrollerStyle.overflow,
[vertical ? `margin${isRtl ? 'Left' : 'Right'}` : 'marginBottom']: visibleScrollbar ? undefined : -scrollerStyle.scrollbarWidth
},
ref: tabsRef,
children: [/*#__PURE__*/_jsx(FlexContainer, {
"aria-label": ariaLabel,
"aria-labelledby": ariaLabelledBy,
"aria-orientation": orientation === 'vertical' ? 'vertical' : null,
className: classes.flexContainer,
ownerState: ownerState,
onKeyDown: handleKeyDown,
ref: tabListRef,
role: "tablist",
children: children
}), mounted && indicator]
}), conditionalElements.scrollButtonEnd]
}));
});
process.env.NODE_ENV !== "production" ? Tabs.propTypes /* remove-proptypes */ = {
// ┌────────────────────────────── Warning ──────────────────────────────┐
// │ These PropTypes are generated from the TypeScript type definitions. │
// │ To update them, edit the d.ts file and run `pnpm proptypes`. │
// └─────────────────────────────────────────────────────────────────────┘
/**
* Callback fired when the component mounts.
* This is useful when you want to trigger an action programmatically.
* It supports two actions: `updateIndicator()` and `updateScrollButtons()`
*
* @param {object} actions This object contains all possible actions
* that can be triggered programmatically.
*/
action: refType,
/**
* If `true`, the scroll buttons aren't forced hidden on mobile.
* By default the scroll buttons are hidden on mobile and takes precedence over `scrollButtons`.
* @default false
*/
allowScrollButtonsMobile: PropTypes.bool,
/**
* The label for the Tabs as a string.
*/
'aria-label': PropTypes.string,
/**
* An id or list of ids separated by a space that label the Tabs.
*/
'aria-labelledby': PropTypes.string,
/**
* If `true`, the tabs are centered.
* This prop is intended for large views.
* @default false
*/
centered: PropTypes.bool,
/**
* The content of the component.
*/
children: PropTypes.node,
/**
* Override or extend the styles applied to the component.
*/
classes: PropTypes.object,
/**
* @ignore
*/
className: PropTypes.string,
/**
* The component used for the root node.
* Either a string to use a HTML element or a component.
*/
component: PropTypes.elementType,
/**
* Determines the color of the indicator.
* @default 'primary'
*/
indicatorColor: PropTypes /* @typescript-to-proptypes-ignore */.oneOfType([PropTypes.oneOf(['primary', 'secondary']), PropTypes.string]),
/**
* Callback fired when the value changes.
*
* @param {React.SyntheticEvent} event The event source of the callback. **Warning**: This is a generic event not a change event.
* @param {any} value We default to the index of the child (number)
*/
onChange: PropTypes.func,
/**
* The component orientation (layout flow direction).
* @default 'horizontal'
*/
orientation: PropTypes.oneOf(['horizontal', 'vertical']),
/**
* The component used to render the scroll buttons.
* @default TabScrollButton
*/
ScrollButtonComponent: PropTypes.elementType,
/**
* Determine behavior of scroll buttons when tabs are set to scroll:
*
* - `auto` will only present them when not all the items are visible.
* - `true` will always present them.
* - `false` will never present them.
*
* By default the scroll buttons are hidden on mobile.
* This behavior can be disabled with `allowScrollButtonsMobile`.
* @default 'auto'
*/
scrollButtons: PropTypes /* @typescript-to-proptypes-ignore */.oneOf(['auto', false, true]),
/**
* If `true` the selected tab changes on focus. Otherwise it only
* changes on activation.
*/
selectionFollowsFocus: PropTypes.bool,
/**
* The extra props for the slot components.
* You can override the existing props or add new ones.
* @default {}
*/
slotProps: PropTypes.shape({
endScrollButtonIcon: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
startScrollButtonIcon: PropTypes.oneOfType([PropTypes.func, PropTypes.object])
}),
/**
* The components used for each slot inside.
* @default {}
*/
slots: PropTypes.shape({
EndScrollButtonIcon: PropTypes.elementType,
StartScrollButtonIcon: PropTypes.elementType
}),
/**
* The system prop that allows defining system overrides as well as additional CSS styles.
*/
sx: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.func, PropTypes.object, PropTypes.bool])), PropTypes.func, PropTypes.object]),
/**
* Props applied to the tab indicator element.
* @default {}
*/
TabIndicatorProps: PropTypes.object,
/**
* Props applied to the [`TabScrollButton`](/material-ui/api/tab-scroll-button/) element.
* @default {}
*/
TabScrollButtonProps: PropTypes.object,
/**
* Determines the color of the `Tab`.
* @default 'primary'
*/
textColor: PropTypes.oneOf(['inherit', 'primary', 'secondary']),
/**
* The value of the currently selected `Tab`.
* If you don't want any selected `Tab`, you can set this prop to `false`.
*/
value: PropTypes.any,
/**
* Determines additional display behavior of the tabs:
*
* - `scrollable` will invoke scrolling properties and allow for horizontally
* scrolling (or swiping) of the tab bar.
* - `fullWidth` will make the tabs grow to use all the available space,
* which should be used for small views, like on mobile.
* - `standard` will render the default state.
* @default 'standard'
*/
variant: PropTypes.oneOf(['fullWidth', 'scrollable', 'standard']),
/**
* If `true`, the scrollbar is visible. It can be useful when displaying
* a long vertical list of tabs.
* @default false
*/
visibleScrollbar: PropTypes.bool
} : void 0;
export default Tabs;