@material-ui/core
Version:
React components that implement Google's Material Design.
170 lines (138 loc) • 5.24 kB
JavaScript
import _objectSpread from "@babel/runtime/helpers/objectSpread";
import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
/* eslint-disable react/no-did-mount-set-state */
import React from 'react';
import PropTypes from 'prop-types';
import EventListener from 'react-event-listener';
import debounce from 'debounce'; // < 1kb payload overhead when lodash/debounce is > 3kb.
import wrapDisplayName from 'recompose/wrapDisplayName';
import hoistNonReactStatics from 'hoist-non-react-statics';
import withTheme from '../styles/withTheme';
import { keys as breakpointKeys } from '../styles/createBreakpoints';
import getThemeProps from '../styles/getThemeProps'; // By default, returns true if screen width is the same or greater than the given breakpoint.
export const isWidthUp = (breakpoint, width, inclusive = true) => {
if (inclusive) {
return breakpointKeys.indexOf(breakpoint) <= breakpointKeys.indexOf(width);
}
return breakpointKeys.indexOf(breakpoint) < breakpointKeys.indexOf(width);
}; // By default, returns true if screen width is the same or less than the given breakpoint.
export const isWidthDown = (breakpoint, width, inclusive = true) => {
if (inclusive) {
return breakpointKeys.indexOf(width) <= breakpointKeys.indexOf(breakpoint);
}
return breakpointKeys.indexOf(width) < breakpointKeys.indexOf(breakpoint);
};
const withWidth = (options = {}) => Component => {
const {
withTheme: withThemeOption = false,
noSSR = false,
initialWidth: initialWidthOption,
resizeInterval = 166 // Corresponds to 10 frames at 60 Hz.
} = options;
class WithWidth extends React.Component {
constructor(props) {
super(props);
this.handleResize = debounce(() => {
const width = this.getWidth();
if (width !== this.state.width) {
this.setState({
width
});
}
}, resizeInterval);
this.state = {
width: noSSR ? this.getWidth() : undefined
};
}
componentDidMount() {
const width = this.getWidth();
if (width !== this.state.width) {
this.setState({
width
});
}
}
componentWillUnmount() {
this.handleResize.clear();
}
getWidth(innerWidth = window.innerWidth) {
const breakpoints = this.props.theme.breakpoints;
let width = null;
/**
* Start with the slowest value as low end devices often have a small screen.
*
* innerWidth |xs sm md lg xl
* |-------|-------|-------|-------|------>
* width | xs | sm | md | lg | xl
*/
let index = 1;
while (width === null && index < breakpointKeys.length) {
const currentWidth = breakpointKeys[index]; // @media are inclusive, so reproduce the behavior here.
if (innerWidth < breakpoints.values[currentWidth]) {
width = breakpointKeys[index - 1];
break;
}
index += 1;
}
width = width || 'xl';
return width;
}
render() {
const _getThemeProps = getThemeProps({
theme: this.props.theme,
name: 'MuiWithWidth',
props: _objectSpread({}, this.props)
}),
{
initialWidth,
theme,
width
} = _getThemeProps,
other = _objectWithoutProperties(_getThemeProps, ["initialWidth", "theme", "width"]);
const more = _objectSpread({
width: width || this.state.width || initialWidth || initialWidthOption
}, other); // When rendering the component on the server,
// we have no idea about the client browser screen width.
// In order to prevent blinks and help the reconciliation of the React tree
// we are not rendering the child component.
//
// An alternative is to use the `initialWidth` property.
if (more.width === undefined) {
return null;
}
if (withThemeOption) {
more.theme = theme;
}
return React.createElement(React.Fragment, null, React.createElement(Component, more), React.createElement(EventListener, {
target: "window",
onResize: this.handleResize
}));
}
}
WithWidth.propTypes = process.env.NODE_ENV !== "production" ? {
/**
* As `window.innerWidth` is unavailable on the server,
* we default to rendering an empty component during the first mount.
* In some situation, you might want to use an heuristic to approximate
* the screen width of the client browser screen width.
*
* For instance, you could be using the user-agent or the client-hints.
* https://caniuse.com/#search=client%20hint
*/
initialWidth: PropTypes.oneOf(['xs', 'sm', 'md', 'lg', 'xl']),
/**
* @ignore
*/
theme: PropTypes.object.isRequired,
/**
* Bypass the width calculation logic.
*/
width: PropTypes.oneOf(['xs', 'sm', 'md', 'lg', 'xl'])
} : {};
if (process.env.NODE_ENV !== 'production') {
WithWidth.displayName = wrapDisplayName(Component, 'WithWidth');
}
hoistNonReactStatics(WithWidth, Component);
return withTheme()(WithWidth);
};
export default withWidth;