Completely updated React, fixed #11, (hopefully)

This commit is contained in:
2018-03-04 19:11:49 -05:00
parent 6e0afd6e2a
commit 34e5f5139a
13674 changed files with 333464 additions and 473223 deletions

View File

@@ -1,15 +1,16 @@
// @flow
// @inheritedComponent Modal
import React from 'react';
import type { Node } from 'react';
import PropTypes from 'prop-types';
import ReactDOM from 'react-dom';
import warning from 'warning';
import contains from 'dom-helpers/query/contains';
import ownerDocument from 'dom-helpers/ownerDocument';
import ownerWindow from 'dom-helpers/ownerWindow';
import debounce from 'lodash/debounce';
import EventListener from 'react-event-listener';
import withStyles from '../styles/withStyles';
import Modal from '../internal/Modal';
import type { TransitionCallback, TransitionClasses } from '../internal/transition';
import Modal from '../Modal';
import Grow from '../transitions/Grow';
import Paper from '../Paper';
@@ -61,6 +62,10 @@ function getScrollParent(parent, child) {
return scrollTop;
}
function getAnchorEl(anchorEl) {
return typeof anchorEl === 'function' ? anchorEl() : anchorEl;
}
export const styles = {
paper: {
position: 'absolute',
@@ -78,143 +83,22 @@ export const styles = {
},
};
export type Origin = {
horizontal: 'left' | 'center' | 'right' | number,
vertical: 'top' | 'center' | 'bottom' | number,
};
type ProvidedProps = {
anchorOrigin: Origin,
classes: Object,
transformOrigin: Origin,
marginThreshold: number,
};
export type Props = {
/**
* This is the DOM element that will be used
* to set the position of the popover.
*/
anchorEl?: ?HTMLElement,
/**
* This is the point on the anchor where the popover's
* `anchorEl` will attach to.
*
* Options:
* vertical: [top, center, bottom];
* horizontal: [left, center, right].
*/
anchorOrigin?: Origin,
/**
* The content of the component.
*/
children: Node,
/**
* Useful to extend the style applied to components.
*/
classes?: Object,
/**
* The elevation of the popover.
*/
elevation?: number,
/**
* This function is called in order to retrieve the content anchor element.
* It's the opposite of the `anchorEl` property.
* The content anchor element should be an element inside the popover.
* It's used to correctly scroll and set the position of the popover.
* The positioning strategy tries to make the content anchor element just above the
* anchor element.
*/
getContentAnchorEl?: Function,
/**
* Specifies how close to the edge of the window the popover can appear.
*/
marginThreshold?: number,
/**
* Callback fired before the component is entering.
*/
onEnter?: TransitionCallback,
/**
* Callback fired when the component is entering.
*/
onEntering?: TransitionCallback,
/**
* Callback fired when the component has entered.
*/
onEntered?: TransitionCallback,
/**
* Callback fired before the component is exiting.
*/
onExit?: TransitionCallback,
/**
* Callback fired when the component is exiting.
*/
onExiting?: TransitionCallback,
/**
* Callback fired when the component has exited.
*/
onExited?: TransitionCallback,
/**
* Callback fired when the component requests to be closed.
*
* @param {object} event The event source of the callback.
*/
onRequestClose?: Function,
/**
* If `true`, the popover is visible.
*/
open: boolean,
/**
* Properties applied to the `Paper` element.
*/
PaperProps?: Object,
/**
* @ignore
*/
role?: string,
/**
* This is the point on the popover which
* will attach to the anchor's origin.
*
* Options:
* vertical: [top, center, bottom, x(px)];
* horizontal: [left, center, right, x(px)].
*/
transformOrigin?: Origin,
/**
* The animation classNames applied to the component as it enters or exits.
* This property is a direct binding to [`CSSTransition.classNames`](https://reactcommunity.org/react-transition-group/#CSSTransition-prop-classNames).
*/
transitionClasses?: TransitionClasses,
/**
* Set to 'auto' to automatically calculate transition time based on height.
*/
transitionDuration?: number | { enter?: number, exit?: number } | 'auto',
};
class Popover extends React.Component<ProvidedProps & Props> {
static defaultProps = {
anchorOrigin: {
vertical: 'top',
horizontal: 'left',
},
transformOrigin: {
vertical: 'top',
horizontal: 'left',
},
transitionDuration: 'auto',
elevation: 8,
marginThreshold: 16,
};
class Popover extends React.Component {
componentDidMount() {
if (this.props.action) {
this.props.action({
updatePosition: this.handleResize,
});
}
}
componentWillUnmount = () => {
this.handleResize.cancel();
};
setPositioningStyles = (element: HTMLElement) => {
setPositioningStyles = element => {
if (element && element.style) {
const positioning = this.getPositioningStyle(element);
element.style.top = positioning.top;
element.style.left = positioning.left;
element.style.transformOrigin = positioning.transformOrigin;
@@ -222,7 +106,7 @@ class Popover extends React.Component<ProvidedProps & Props> {
};
getPositioningStyle = element => {
const { marginThreshold } = this.props;
const { anchorEl, marginThreshold } = this.props;
// Check if the parent has requested anchoring on an inner content node
const contentAnchorOffset = this.getContentAnchorOffset(element);
@@ -242,9 +126,12 @@ class Popover extends React.Component<ProvidedProps & Props> {
const bottom = top + elemRect.height;
const right = left + elemRect.width;
// Use the parent window of the anchorEl if provided
const containerWindow = ownerWindow(getAnchorEl(anchorEl));
// Window thresholds taking required margin into account
const heightThreshold = window.innerHeight - marginThreshold;
const widthThreshold = window.innerWidth - marginThreshold;
const heightThreshold = containerWindow.innerHeight - marginThreshold;
const widthThreshold = containerWindow.innerWidth - marginThreshold;
// Check if the vertical axis needs shifting
if (top < marginThreshold) {
@@ -287,9 +174,15 @@ class Popover extends React.Component<ProvidedProps & Props> {
// Returns the top/left offset of the position
// to attach to on the anchor element (or body if none is provided)
getAnchorOffset(contentAnchorOffset) {
// $FlowFixMe
const { anchorEl, anchorOrigin } = this.props;
const anchorElement = anchorEl || document.body;
const { anchorEl, anchorOrigin, anchorReference, anchorPosition } = this.props;
if (anchorReference === 'anchorPosition') {
return anchorPosition;
}
// If an anchor element wasn't provided, just use the parent body element of this Popover
const anchorElement =
getAnchorEl(anchorEl) || ownerDocument(ReactDOM.findDOMNode(this.transitionEl)).body;
const anchorRect = anchorElement.getBoundingClientRect();
const anchorVertical = contentAnchorOffset === 0 ? anchorOrigin.vertical : 'center';
@@ -301,10 +194,11 @@ class Popover extends React.Component<ProvidedProps & Props> {
// Returns the vertical offset of inner content to anchor the transform on if provided
getContentAnchorOffset(element) {
const { getContentAnchorEl, anchorReference } = this.props;
let contentAnchorOffset = 0;
if (this.props.getContentAnchorEl) {
const contentAnchorEl = this.props.getContentAnchorEl(element);
if (getContentAnchorEl && anchorReference === 'anchorEl') {
const contentAnchorEl = getContentAnchorEl(element);
if (contentAnchorEl && contains(element, contentAnchorEl)) {
const scrollTop = getScrollParent(element, contentAnchorEl);
@@ -316,11 +210,11 @@ class Popover extends React.Component<ProvidedProps & Props> {
warning(
this.props.anchorOrigin.vertical === 'top',
[
'Material-UI: you can not change the default `anchorOrigin.vertical` value when also ',
'providing the `getContentAnchorEl` property to the popover component.',
'Only use one of the two properties',
'Set `getContentAnchorEl` to null or left `anchorOrigin.vertical` unchanged',
].join(),
'Material-UI: you can not change the default `anchorOrigin.vertical` value ',
'when also providing the `getContentAnchorEl` property to the popover component.',
'Only use one of the two properties.',
'Set `getContentAnchorEl` to null or left `anchorOrigin.vertical` unchanged.',
].join('\n'),
);
}
@@ -343,7 +237,7 @@ class Popover extends React.Component<ProvidedProps & Props> {
handleGetOffsetLeft = getOffsetLeft;
handleEnter = (element: HTMLElement) => {
handleEnter = element => {
if (this.props.onEnter) {
this.props.onEnter(element);
}
@@ -352,65 +246,245 @@ class Popover extends React.Component<ProvidedProps & Props> {
};
handleResize = debounce(() => {
const element: any = ReactDOM.findDOMNode(this.transitionEl);
const element = ReactDOM.findDOMNode(this.transitionEl);
this.setPositioningStyles(element);
}, 166);
render() {
const {
action,
anchorEl,
anchorOrigin,
anchorPosition,
anchorReference,
children,
classes,
container: containerProp,
elevation,
getContentAnchorEl,
marginThreshold,
onEnter,
onEntering,
onEntered,
onEntering,
onExit,
onExiting,
onExited,
onExiting,
open,
PaperProps,
role,
transformOrigin,
transitionClasses,
transition: TransitionProp,
transitionDuration,
...other
} = this.props;
// If the container prop is provided, use that
// If the anchorEl prop is provided, use its parent body element as the container
// If neither are provided let the Modal take care of choosing the container
const container =
containerProp || (anchorEl ? ownerDocument(getAnchorEl(anchorEl)).body : undefined);
const transitionProps = {};
// The provided transition might not support the auto timeout value.
if (TransitionProp === Grow) {
transitionProps.timeout = transitionDuration;
}
return (
<Modal show={open} BackdropInvisible {...other}>
<Grow
<Modal container={container} open={open} BackdropProps={{ invisible: true }} {...other}>
<TransitionProp
appear
in={open}
onEnter={this.handleEnter}
onEntering={onEntering}
onEntered={onEntered}
onEntering={onEntering}
onExit={onExit}
onExiting={onExiting}
onExited={onExited}
onExiting={onExiting}
role={role}
transitionClasses={transitionClasses}
timeout={transitionDuration}
rootRef={node => {
ref={node => {
this.transitionEl = node;
}}
{...transitionProps}
>
<Paper
data-mui-test="Popover"
className={classes.paper}
data-mui-test="Popover"
elevation={elevation}
{...PaperProps}
>
<EventListener target="window" onResize={this.handleResize} />
{children}
</Paper>
</Grow>
</TransitionProp>
</Modal>
);
}
}
Popover.propTypes = {
/**
* This is callback property. It's called by the component on mount.
* This is useful when you want to trigger an action programmatically.
* It currently only supports updatePosition() action.
*
* @param {object} actions This object contains all posible actions
* that can be triggered programmatically.
*/
action: PropTypes.func,
/**
* This is the DOM element, or a function that returns the DOM element,
* that may be used to set the position of the popover.
*/
anchorEl: PropTypes.oneOfType([PropTypes.object, PropTypes.func]),
/**
* This is the point on the anchor where the popover's
* `anchorEl` will attach to. This is not used when the
* anchorReference is 'anchorPosition'.
*
* Options:
* vertical: [top, center, bottom];
* horizontal: [left, center, right].
*/
anchorOrigin: PropTypes.shape({
horizontal: PropTypes.oneOfType([
PropTypes.number,
PropTypes.oneOf(['left', 'center', 'right']),
]),
vertical: PropTypes.oneOfType([PropTypes.number, PropTypes.oneOf(['top', 'center', 'bottom'])]),
}),
/**
* This is the position that may be used
* to set the position of the popover.
* The coordinates are relative to
* the application's client area.
*/
anchorPosition: PropTypes.shape({
top: PropTypes.number,
left: PropTypes.number,
}),
/*
* This determines which anchor prop to refer to to set
* the position of the popover.
*/
anchorReference: PropTypes.oneOf(['anchorEl', 'anchorPosition']),
/**
* The content of the component.
*/
children: PropTypes.node,
/**
* Useful to extend the style applied to components.
*/
classes: PropTypes.object.isRequired,
/**
* A node, component instance, or function that returns either.
* The `container` will passed to the Modal component.
* By default, it's using the body of the anchorEl's top-level document object,
* so it's simply `document.body` most of the time.
*/
container: PropTypes.oneOfType([PropTypes.object, PropTypes.func]),
/**
* The elevation of the popover.
*/
elevation: PropTypes.number,
/**
* This function is called in order to retrieve the content anchor element.
* It's the opposite of the `anchorEl` property.
* The content anchor element should be an element inside the popover.
* It's used to correctly scroll and set the position of the popover.
* The positioning strategy tries to make the content anchor element just above the
* anchor element.
*/
getContentAnchorEl: PropTypes.func,
/**
* Specifies how close to the edge of the window the popover can appear.
*/
marginThreshold: PropTypes.number,
/**
* Callback fired when the component requests to be closed.
*
* @param {object} event The event source of the callback.
*/
onClose: PropTypes.func,
/**
* Callback fired before the component is entering.
*/
onEnter: PropTypes.func,
/**
* Callback fired when the component has entered.
*/
onEntered: PropTypes.func,
/**
* Callback fired when the component is entering.
*/
onEntering: PropTypes.func,
/**
* Callback fired before the component is exiting.
*/
onExit: PropTypes.func,
/**
* Callback fired when the component has exited.
*/
onExited: PropTypes.func,
/**
* Callback fired when the component is exiting.
*/
onExiting: PropTypes.func,
/**
* If `true`, the popover is visible.
*/
open: PropTypes.bool.isRequired,
/**
* Properties applied to the `Paper` element.
*/
PaperProps: PropTypes.object,
/**
* @ignore
*/
role: PropTypes.string,
/**
* This is the point on the popover which
* will attach to the anchor's origin.
*
* Options:
* vertical: [top, center, bottom, x(px)];
* horizontal: [left, center, right, x(px)].
*/
transformOrigin: PropTypes.shape({
horizontal: PropTypes.oneOfType([
PropTypes.number,
PropTypes.oneOf(['left', 'center', 'right']),
]),
vertical: PropTypes.oneOfType([PropTypes.number, PropTypes.oneOf(['top', 'center', 'bottom'])]),
}),
/**
* Transition component.
*/
transition: PropTypes.oneOfType([PropTypes.string, PropTypes.func]),
/**
* Set to 'auto' to automatically calculate transition time based on height.
*/
transitionDuration: PropTypes.oneOfType([
PropTypes.number,
PropTypes.shape({ enter: PropTypes.number, exit: PropTypes.number }),
PropTypes.oneOf(['auto']),
]),
};
Popover.defaultProps = {
anchorReference: 'anchorEl',
anchorOrigin: {
vertical: 'top',
horizontal: 'left',
},
elevation: 8,
marginThreshold: 16,
transformOrigin: {
vertical: 'top',
horizontal: 'left',
},
transition: Grow,
transitionDuration: 'auto',
};
export default withStyles(styles, { name: 'MuiPopover' })(Popover);