@activelylearn/material-ui
Version:
Material-UI's workspace package
455 lines (405 loc) • 13 kB
JavaScript
import React from 'react';
import PropTypes from 'prop-types';
import warning from 'warning';
import classNames from 'classnames';
import EventListener from 'react-event-listener';
import debounce from 'debounce';
import { getNormalizedScrollLeft, detectScrollType } from 'normalize-scroll-left';
import scroll from 'scroll';
import ScrollbarSize from './ScrollbarSize';
import withStyles from '../styles/withStyles';
import TabIndicator from './TabIndicator';
import TabScrollButton from './TabScrollButton';
export const styles = theme => ({
root: {
overflow: 'hidden',
minHeight: 48,
WebkitOverflowScrolling: 'touch', // Add iOS momentum scrolling.
},
flexContainer: {
display: 'flex',
},
scroller: {
position: 'relative',
display: 'inline-block',
flex: '1 1 auto',
whiteSpace: 'nowrap',
},
fixed: {
overflowX: 'hidden',
width: '100%',
},
scrollable: {
overflowX: 'scroll',
},
centered: {
justifyContent: 'center',
},
scrollButtons: {},
scrollButtonsAuto: {
[theme.breakpoints.down('xs')]: {
display: 'none',
},
},
indicator: {},
});
class Tabs extends React.Component {
state = {
indicatorStyle: {},
scrollerStyle: {
marginBottom: 0,
},
showLeftScroll: false,
showRightScroll: false,
mounted: false,
};
componentDidMount() {
// eslint-disable-next-line react/no-did-mount-set-state
this.setState({ mounted: true });
this.updateIndicatorState(this.props);
this.updateScrollButtonState();
if (this.props.action) {
this.props.action({
updateIndicator: this.handleResize,
});
}
}
componentDidUpdate(prevProps, prevState) {
this.updateScrollButtonState();
// The index might have changed at the same time.
// We need to check again the right indicator position.
this.updateIndicatorState(this.props);
if (this.state.indicatorStyle !== prevState.indicatorStyle) {
this.scrollSelectedIntoView();
}
}
componentWillUnmount() {
this.handleResize.clear();
this.handleTabsScroll.clear();
}
getConditionalElements = () => {
const { classes, scrollable, ScrollButtonComponent, scrollButtons, theme } = this.props;
const conditionalElements = {};
conditionalElements.scrollbarSizeListener = scrollable ? (
<ScrollbarSize
onLoad={this.handleScrollbarSizeChange}
onChange={this.handleScrollbarSizeChange}
/>
) : null;
const showScrollButtons = scrollable && (scrollButtons === 'auto' || scrollButtons === 'on');
conditionalElements.scrollButtonLeft = showScrollButtons ? (
<ScrollButtonComponent
direction={theme && theme.direction === 'rtl' ? 'right' : 'left'}
onClick={this.handleLeftScrollClick}
visible={this.state.showLeftScroll}
className={classNames(classes.scrollButtons, {
[classes.scrollButtonsAuto]: scrollButtons === 'auto',
})}
/>
) : null;
conditionalElements.scrollButtonRight = showScrollButtons ? (
<ScrollButtonComponent
direction={theme && theme.direction === 'rtl' ? 'left' : 'right'}
onClick={this.handleRightScrollClick}
visible={this.state.showRightScroll}
className={classNames(classes.scrollButtons, {
[classes.scrollButtonsAuto]: scrollButtons === 'auto',
})}
/>
) : null;
return conditionalElements;
};
getTabsMeta = (value, direction) => {
let tabsMeta;
if (this.tabs) {
const rect = this.tabs.getBoundingClientRect();
// create a new object with ClientRect class props + scrollLeft
tabsMeta = {
clientWidth: this.tabs ? this.tabs.clientWidth : 0,
scrollLeft: this.tabs ? this.tabs.scrollLeft : 0,
scrollLeftNormalized: this.tabs ? getNormalizedScrollLeft(this.tabs, direction) : 0,
scrollWidth: this.tabs ? this.tabs.scrollWidth : 0,
left: rect.left,
right: rect.right,
};
}
let tabMeta;
if (this.tabs && value !== false) {
const children = this.tabs.children[0].children;
if (children.length > 0) {
const tab = children[this.valueToIndex[value]];
warning(tab, `Material-UI: the value provided \`${value}\` is invalid`);
tabMeta = tab ? tab.getBoundingClientRect() : null;
}
}
return { tabsMeta, tabMeta };
};
tabs = undefined;
valueToIndex = {};
handleResize = debounce(() => {
this.updateIndicatorState(this.props);
this.updateScrollButtonState();
}, 166); // Corresponds to 10 frames at 60 Hz.
handleLeftScrollClick = () => {
if (this.tabs) {
this.moveTabsScroll(-this.tabs.clientWidth);
}
};
handleRightScrollClick = () => {
if (this.tabs) {
this.moveTabsScroll(this.tabs.clientWidth);
}
};
handleScrollbarSizeChange = ({ scrollbarHeight }) => {
this.setState({
scrollerStyle: {
marginBottom: -scrollbarHeight,
},
});
};
handleTabsScroll = debounce(() => {
this.updateScrollButtonState();
}, 166); // Corresponds to 10 frames at 60 Hz.
moveTabsScroll = delta => {
const { theme } = this.props;
if (this.tabs) {
const multiplier = theme.direction === 'rtl' ? -1 : 1;
const nextScrollLeft = this.tabs.scrollLeft + delta * multiplier;
// Fix for Edge
const invert = theme.direction === 'rtl' && detectScrollType() === 'reverse' ? -1 : 1;
scroll.left(this.tabs, invert * nextScrollLeft);
}
};
updateIndicatorState(props) {
const { theme, value } = props;
const { tabsMeta, tabMeta } = this.getTabsMeta(value, theme.direction);
let left = 0;
if (tabMeta && tabsMeta) {
const correction =
theme.direction === 'rtl'
? tabsMeta.scrollLeftNormalized + tabsMeta.clientWidth - tabsMeta.scrollWidth
: tabsMeta.scrollLeft;
left = tabMeta.left - tabsMeta.left + correction;
}
const indicatorStyle = {
left,
// May be wrong until the font is loaded.
width: tabMeta ? tabMeta.width : 0,
};
if (
(indicatorStyle.left !== this.state.indicatorStyle.left ||
indicatorStyle.width !== this.state.indicatorStyle.width) &&
!Number.isNaN(indicatorStyle.left) &&
!Number.isNaN(indicatorStyle.width)
) {
this.setState({ indicatorStyle });
}
}
scrollSelectedIntoView = () => {
const { theme, value } = this.props;
const { tabsMeta, tabMeta } = this.getTabsMeta(value, theme.direction);
if (!tabMeta || !tabsMeta) {
return;
}
if (tabMeta.left < tabsMeta.left) {
// left side of button is out of view
const nextScrollLeft = tabsMeta.scrollLeft + (tabMeta.left - tabsMeta.left);
scroll.left(this.tabs, nextScrollLeft);
} else if (tabMeta.right > tabsMeta.right) {
// right side of button is out of view
const nextScrollLeft = tabsMeta.scrollLeft + (tabMeta.right - tabsMeta.right);
scroll.left(this.tabs, nextScrollLeft);
}
};
updateScrollButtonState = () => {
const { scrollable, scrollButtons, theme } = this.props;
if (this.tabs && scrollable && scrollButtons !== 'off') {
const { scrollWidth, clientWidth } = this.tabs;
const scrollLeft = getNormalizedScrollLeft(this.tabs, theme.direction);
const showLeftScroll =
theme.direction === 'rtl' ? scrollWidth > clientWidth + scrollLeft : scrollLeft > 0;
const showRightScroll =
theme.direction === 'rtl' ? scrollLeft > 0 : scrollWidth > clientWidth + scrollLeft;
if (
showLeftScroll !== this.state.showLeftScroll ||
showRightScroll !== this.state.showRightScroll
) {
this.setState({ showLeftScroll, showRightScroll });
}
}
};
render() {
const {
action,
centered,
children: childrenProp,
classes,
className: classNameProp,
fullWidth,
indicatorColor,
onChange,
scrollable,
ScrollButtonComponent,
scrollButtons,
TabIndicatorProps = {},
textColor,
theme,
value,
...other
} = this.props;
warning(
!centered || !scrollable,
'Material-UI: you can not use the `centered={true}` and `scrollable={true}` properties ' +
'at the same time on a `Tabs` component.',
);
const className = classNames(classes.root, classNameProp);
const scrollerClassName = classNames(classes.scroller, {
[classes.fixed]: !scrollable,
[classes.scrollable]: scrollable,
});
const flexContainerClassName = classNames(classes.flexContainer, {
[classes.centered]: centered && !scrollable,
});
const indicator = (
<TabIndicator
className={classes.indicator}
color={indicatorColor}
{...TabIndicatorProps}
style={{
...this.state.indicatorStyle,
...TabIndicatorProps.style,
}}
/>
);
this.valueToIndex = {};
let childIndex = 0;
const children = React.Children.map(childrenProp, child => {
if (!React.isValidElement(child)) {
return null;
}
const childValue = child.props.value === undefined ? childIndex : child.props.value;
this.valueToIndex[childValue] = childIndex;
const selected = childValue === value;
childIndex += 1;
return React.cloneElement(child, {
fullWidth,
indicator: selected && !this.state.mounted && indicator,
selected,
onChange,
textColor,
value: childValue,
});
});
const conditionalElements = this.getConditionalElements();
return (
<div className={className} {...other}>
<EventListener target="window" onResize={this.handleResize} />
{conditionalElements.scrollbarSizeListener}
<div className={classes.flexContainer}>
{conditionalElements.scrollButtonLeft}
<div
className={scrollerClassName}
style={this.state.scrollerStyle}
ref={node => {
this.tabs = node;
}}
role="tablist"
onScroll={this.handleTabsScroll}
>
<div className={flexContainerClassName}>{children}</div>
{this.state.mounted && indicator}
</div>
{conditionalElements.scrollButtonRight}
</div>
</div>
);
}
}
Tabs.propTypes = {
/**
* Callback fired when the component mounts.
* This is useful when you want to trigger an action programmatically.
* It currently only supports `updateIndicator()` action.
*
* @param {object} actions This object contains all possible actions
* that can be triggered programmatically.
*/
action: PropTypes.func,
/**
* If `true`, the tabs will be centered.
* This property is intended for large views.
*/
centered: PropTypes.bool,
/**
* The content of the component.
*/
children: PropTypes.node,
/**
* Override or extend the styles applied to the component.
* See [CSS API](#css-api) below for more details.
*/
classes: PropTypes.object.isRequired,
/**
* @ignore
*/
className: PropTypes.string,
/**
* If `true`, the tabs will grow to use all the available space.
* This property is intended for small views, like on mobile.
*/
fullWidth: PropTypes.bool,
/**
* Determines the color of the indicator.
*/
indicatorColor: PropTypes.oneOf(['secondary', 'primary']),
/**
* Callback fired when the value changes.
*
* @param {object} event The event source of the callback
* @param {number} value We default to the index of the child
*/
onChange: PropTypes.func,
/**
* True invokes scrolling properties and allow for horizontally scrolling
* (or swiping) the tab bar.
*/
scrollable: PropTypes.bool,
/**
* The component used to render the scroll buttons.
*/
ScrollButtonComponent: PropTypes.oneOfType([PropTypes.string, PropTypes.func]),
/**
* Determine behavior of scroll buttons when tabs are set to scroll
* `auto` will only present them on medium and larger viewports
* `on` will always present them
* `off` will never present them
*/
scrollButtons: PropTypes.oneOf(['auto', 'on', 'off']),
/**
* Properties applied to the `TabIndicator` element.
*/
TabIndicatorProps: PropTypes.object,
/**
* Determines the color of the `Tab`.
*/
textColor: PropTypes.oneOf(['secondary', 'primary', 'inherit']),
/**
* @ignore
*/
theme: PropTypes.object.isRequired,
/**
* The value of the currently selected `Tab`.
* If you don't want any selected `Tab`, you can set this property to `false`.
*/
value: PropTypes.any,
};
Tabs.defaultProps = {
centered: false,
fullWidth: false,
indicatorColor: 'secondary',
scrollable: false,
ScrollButtonComponent: TabScrollButton,
scrollButtons: 'auto',
textColor: 'inherit',
};
export default withStyles(styles, { name: 'MuiTabs', withTheme: true })(Tabs);