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,42 +1,45 @@
import * as React from 'react';
import { StandardProps } from '..';
import { PaperProps } from '../Paper';
import { TransitionDuration, TransitionHandlers } from '../internal/transition';
import { ModalProps, ModalClassKey } from '../internal/Modal';
import { ModalProps, ModalClassKey } from '../Modal';
import { TransitionHandlerProps, TransitionProps } from '../transitions/transition';
export interface Origin {
export interface PopoverOrigin {
horizontal: 'left' | 'center' | 'right' | number;
vertical: 'top' | 'center' | 'bottom' | number;
}
export interface PopoverProps extends StandardProps<
ModalProps & Partial<TransitionHandlers>,
PopoverClassKey,
'onRequestClose'
> {
anchorEl?: Object;
anchorOrigin?: Origin;
elevation?: number;
enteredClassName?: string;
enteringClassName?: string;
exitedClassName?: string;
exitingClassName?: string;
getContentAnchorEl?: Function;
marginThreshold?: number;
modal?: boolean;
onRequestClose?: Function;
open?: boolean;
role?: string;
transformOrigin?: Origin;
transitionDuration?: TransitionDuration;
theme?: Object;
PaperProps?: Partial<PaperProps>;
export interface PopoverPosition {
top: number;
left: number;
}
export type PopoverClassKey =
| ModalClassKey
| 'paper'
;
export type PopoverReference = 'anchorEl' | 'anchorPosition';
export interface PopoverProps
extends StandardProps<ModalProps & Partial<TransitionHandlerProps>, PopoverClassKey, 'children'> {
action?: (actions: PopoverActions) => void;
anchorEl?: HTMLElement;
anchorOrigin?: PopoverOrigin;
anchorPosition?: PopoverPosition;
anchorReference?: PopoverReference;
children?: React.ReactNode;
elevation?: number;
getContentAnchorEl?: (element: HTMLElement) => HTMLElement;
marginThreshold?: number;
modal?: boolean;
PaperProps?: Partial<PaperProps>;
role?: string;
transformOrigin?: PopoverOrigin;
transition?: React.ReactType;
transitionDuration?: TransitionProps['timeout'] | 'auto';
}
export type PopoverClassKey = ModalClassKey | 'paper';
export interface PopoverActions {
updatePosition(): void;
}
declare const Popover: React.ComponentType<PopoverProps>;

View File

@@ -37,6 +37,10 @@ var _react = require('react');
var _react2 = _interopRequireDefault(_react);
var _propTypes = require('prop-types');
var _propTypes2 = _interopRequireDefault(_propTypes);
var _reactDom = require('react-dom');
var _reactDom2 = _interopRequireDefault(_reactDom);
@@ -49,6 +53,14 @@ var _contains = require('dom-helpers/query/contains');
var _contains2 = _interopRequireDefault(_contains);
var _ownerDocument = require('dom-helpers/ownerDocument');
var _ownerDocument2 = _interopRequireDefault(_ownerDocument);
var _ownerWindow = require('dom-helpers/ownerWindow');
var _ownerWindow2 = _interopRequireDefault(_ownerWindow);
var _debounce = require('lodash/debounce');
var _debounce2 = _interopRequireDefault(_debounce);
@@ -61,7 +73,7 @@ var _withStyles = require('../styles/withStyles');
var _withStyles2 = _interopRequireDefault(_withStyles);
var _Modal = require('../internal/Modal');
var _Modal = require('../Modal');
var _Modal2 = _interopRequireDefault(_Modal);
@@ -75,12 +87,6 @@ var _Paper2 = _interopRequireDefault(_Paper);
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
var babelPluginFlowReactPropTypes_proptype_Node = require('react').babelPluginFlowReactPropTypes_proptype_Node || require('prop-types').any;
var babelPluginFlowReactPropTypes_proptype_TransitionClasses = require('../internal/transition').babelPluginFlowReactPropTypes_proptype_TransitionClasses || require('prop-types').any;
var babelPluginFlowReactPropTypes_proptype_TransitionCallback = require('../internal/transition').babelPluginFlowReactPropTypes_proptype_TransitionCallback || require('prop-types').any;
function getOffsetTop(rect, vertical) {
var offset = 0;
@@ -93,7 +99,7 @@ function getOffsetTop(rect, vertical) {
}
return offset;
}
} // @inheritedComponent Modal
function getOffsetLeft(rect, horizontal) {
var offset = 0;
@@ -127,6 +133,10 @@ function getScrollParent(parent, child) {
return scrollTop;
}
function getAnchorEl(anchorEl) {
return typeof anchorEl === 'function' ? anchorEl() : anchorEl;
}
var styles = exports.styles = {
paper: {
position: 'absolute',
@@ -144,140 +154,6 @@ var styles = exports.styles = {
}
};
var babelPluginFlowReactPropTypes_proptype_Origin = {
horizontal: require('prop-types').oneOfType([require('prop-types').oneOf(['left']), require('prop-types').oneOf(['center']), require('prop-types').oneOf(['right']), require('prop-types').number]).isRequired,
vertical: require('prop-types').oneOfType([require('prop-types').oneOf(['top']), require('prop-types').oneOf(['center']), require('prop-types').oneOf(['bottom']), require('prop-types').number]).isRequired
};
var babelPluginFlowReactPropTypes_proptype_Props = {
/**
* This is the DOM element that will be used
* to set the position of the popover.
*/
anchorEl: typeof HTMLElement === 'function' ? require('prop-types').instanceOf(HTMLElement) : require('prop-types').any,
/**
* 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: require('prop-types').shape({
horizontal: require('prop-types').oneOfType([require('prop-types').oneOf(['left']), require('prop-types').oneOf(['center']), require('prop-types').oneOf(['right']), require('prop-types').number]).isRequired,
vertical: require('prop-types').oneOfType([require('prop-types').oneOf(['top']), require('prop-types').oneOf(['center']), require('prop-types').oneOf(['bottom']), require('prop-types').number]).isRequired
}),
/**
* The content of the component.
*/
children: typeof babelPluginFlowReactPropTypes_proptype_Node === 'function' ? babelPluginFlowReactPropTypes_proptype_Node.isRequired ? babelPluginFlowReactPropTypes_proptype_Node.isRequired : babelPluginFlowReactPropTypes_proptype_Node : require('prop-types').shape(babelPluginFlowReactPropTypes_proptype_Node).isRequired,
/**
* Useful to extend the style applied to components.
*/
classes: require('prop-types').object,
/**
* The elevation of the popover.
*/
elevation: require('prop-types').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: require('prop-types').func,
/**
* Specifies how close to the edge of the window the popover can appear.
*/
marginThreshold: require('prop-types').number,
/**
* Callback fired before the component is entering.
*/
onEnter: typeof babelPluginFlowReactPropTypes_proptype_TransitionCallback === 'function' ? babelPluginFlowReactPropTypes_proptype_TransitionCallback : require('prop-types').shape(babelPluginFlowReactPropTypes_proptype_TransitionCallback),
/**
* Callback fired when the component is entering.
*/
onEntering: typeof babelPluginFlowReactPropTypes_proptype_TransitionCallback === 'function' ? babelPluginFlowReactPropTypes_proptype_TransitionCallback : require('prop-types').shape(babelPluginFlowReactPropTypes_proptype_TransitionCallback),
/**
* Callback fired when the component has entered.
*/
onEntered: typeof babelPluginFlowReactPropTypes_proptype_TransitionCallback === 'function' ? babelPluginFlowReactPropTypes_proptype_TransitionCallback : require('prop-types').shape(babelPluginFlowReactPropTypes_proptype_TransitionCallback),
/**
* Callback fired before the component is exiting.
*/
onExit: typeof babelPluginFlowReactPropTypes_proptype_TransitionCallback === 'function' ? babelPluginFlowReactPropTypes_proptype_TransitionCallback : require('prop-types').shape(babelPluginFlowReactPropTypes_proptype_TransitionCallback),
/**
* Callback fired when the component is exiting.
*/
onExiting: typeof babelPluginFlowReactPropTypes_proptype_TransitionCallback === 'function' ? babelPluginFlowReactPropTypes_proptype_TransitionCallback : require('prop-types').shape(babelPluginFlowReactPropTypes_proptype_TransitionCallback),
/**
* Callback fired when the component has exited.
*/
onExited: typeof babelPluginFlowReactPropTypes_proptype_TransitionCallback === 'function' ? babelPluginFlowReactPropTypes_proptype_TransitionCallback : require('prop-types').shape(babelPluginFlowReactPropTypes_proptype_TransitionCallback),
/**
* Callback fired when the component requests to be closed.
*
* @param {object} event The event source of the callback.
*/
onRequestClose: require('prop-types').func,
/**
* If `true`, the popover is visible.
*/
open: require('prop-types').bool.isRequired,
/**
* Properties applied to the `Paper` element.
*/
PaperProps: require('prop-types').object,
/**
* @ignore
*/
role: require('prop-types').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: require('prop-types').shape({
horizontal: require('prop-types').oneOfType([require('prop-types').oneOf(['left']), require('prop-types').oneOf(['center']), require('prop-types').oneOf(['right']), require('prop-types').number]).isRequired,
vertical: require('prop-types').oneOfType([require('prop-types').oneOf(['top']), require('prop-types').oneOf(['center']), require('prop-types').oneOf(['bottom']), require('prop-types').number]).isRequired
}),
/**
* 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: typeof babelPluginFlowReactPropTypes_proptype_TransitionClasses === 'function' ? babelPluginFlowReactPropTypes_proptype_TransitionClasses : require('prop-types').shape(babelPluginFlowReactPropTypes_proptype_TransitionClasses),
/**
* Set to 'auto' to automatically calculate transition time based on height.
*/
transitionDuration: require('prop-types').oneOfType([require('prop-types').number, require('prop-types').shape({
enter: require('prop-types').number,
exit: require('prop-types').number
}), require('prop-types').oneOf(['auto'])])
};
var Popover = function (_React$Component) {
(0, _inherits3.default)(Popover, _React$Component);
@@ -297,13 +173,14 @@ var Popover = function (_React$Component) {
}, _this.setPositioningStyles = function (element) {
if (element && element.style) {
var positioning = _this.getPositioningStyle(element);
element.style.top = positioning.top;
element.style.left = positioning.left;
element.style.transformOrigin = positioning.transformOrigin;
}
}, _this.getPositioningStyle = function (element) {
var marginThreshold = _this.props.marginThreshold;
var _this$props = _this.props,
anchorEl = _this$props.anchorEl,
marginThreshold = _this$props.marginThreshold;
// Check if the parent has requested anchoring on an inner content node
@@ -324,9 +201,12 @@ var Popover = function (_React$Component) {
var bottom = top + elemRect.height;
var right = left + elemRect.width;
// Use the parent window of the anchorEl if provided
var containerWindow = (0, _ownerWindow2.default)(getAnchorEl(anchorEl));
// Window thresholds taking required margin into account
var heightThreshold = window.innerHeight - marginThreshold;
var widthThreshold = window.innerWidth - marginThreshold;
var heightThreshold = containerWindow.innerHeight - marginThreshold;
var widthThreshold = containerWindow.innerWidth - marginThreshold;
// Check if the vertical axis needs shifting
if (top < marginThreshold) {
@@ -370,18 +250,34 @@ var Popover = function (_React$Component) {
}
(0, _createClass3.default)(Popover, [{
key: 'componentDidMount',
value: function componentDidMount() {
if (this.props.action) {
this.props.action({
updatePosition: this.handleResize
});
}
}
}, {
key: 'getAnchorOffset',
// Returns the top/left offset of the position
// to attach to on the anchor element (or body if none is provided)
value: function getAnchorOffset(contentAnchorOffset) {
// $FlowFixMe
var _props = this.props,
anchorEl = _props.anchorEl,
anchorOrigin = _props.anchorOrigin;
anchorOrigin = _props.anchorOrigin,
anchorReference = _props.anchorReference,
anchorPosition = _props.anchorPosition;
var anchorElement = anchorEl || document.body;
if (anchorReference === 'anchorPosition') {
return anchorPosition;
}
// If an anchor element wasn't provided, just use the parent body element of this Popover
var anchorElement = getAnchorEl(anchorEl) || (0, _ownerDocument2.default)(_reactDom2.default.findDOMNode(this.transitionEl)).body;
var anchorRect = anchorElement.getBoundingClientRect();
var anchorVertical = contentAnchorOffset === 0 ? anchorOrigin.vertical : 'center';
@@ -396,10 +292,14 @@ var Popover = function (_React$Component) {
}, {
key: 'getContentAnchorOffset',
value: function getContentAnchorOffset(element) {
var _props2 = this.props,
getContentAnchorEl = _props2.getContentAnchorEl,
anchorReference = _props2.anchorReference;
var contentAnchorOffset = 0;
if (this.props.getContentAnchorEl) {
var contentAnchorEl = this.props.getContentAnchorEl(element);
if (getContentAnchorEl && anchorReference === 'anchorEl') {
var contentAnchorEl = getContentAnchorEl(element);
if (contentAnchorEl && (0, _contains2.default)(element, contentAnchorEl)) {
var scrollTop = getScrollParent(element, contentAnchorEl);
@@ -407,7 +307,7 @@ var Popover = function (_React$Component) {
}
// != the default value
process.env.NODE_ENV !== "production" ? (0, _warning2.default)(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()) : void 0;
process.env.NODE_ENV !== "production" ? (0, _warning2.default)(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('\n')) : void 0;
}
return contentAnchorOffset;
@@ -432,54 +332,68 @@ var Popover = function (_React$Component) {
value: function render() {
var _this2 = this;
var _props2 = this.props,
anchorEl = _props2.anchorEl,
anchorOrigin = _props2.anchorOrigin,
children = _props2.children,
classes = _props2.classes,
elevation = _props2.elevation,
getContentAnchorEl = _props2.getContentAnchorEl,
marginThreshold = _props2.marginThreshold,
onEnter = _props2.onEnter,
onEntering = _props2.onEntering,
onEntered = _props2.onEntered,
onExit = _props2.onExit,
onExiting = _props2.onExiting,
onExited = _props2.onExited,
open = _props2.open,
PaperProps = _props2.PaperProps,
role = _props2.role,
transformOrigin = _props2.transformOrigin,
transitionClasses = _props2.transitionClasses,
transitionDuration = _props2.transitionDuration,
other = (0, _objectWithoutProperties3.default)(_props2, ['anchorEl', 'anchorOrigin', 'children', 'classes', 'elevation', 'getContentAnchorEl', 'marginThreshold', 'onEnter', 'onEntering', 'onEntered', 'onExit', 'onExiting', 'onExited', 'open', 'PaperProps', 'role', 'transformOrigin', 'transitionClasses', 'transitionDuration']);
var _props3 = this.props,
action = _props3.action,
anchorEl = _props3.anchorEl,
anchorOrigin = _props3.anchorOrigin,
anchorPosition = _props3.anchorPosition,
anchorReference = _props3.anchorReference,
children = _props3.children,
classes = _props3.classes,
containerProp = _props3.container,
elevation = _props3.elevation,
getContentAnchorEl = _props3.getContentAnchorEl,
marginThreshold = _props3.marginThreshold,
onEnter = _props3.onEnter,
onEntered = _props3.onEntered,
onEntering = _props3.onEntering,
onExit = _props3.onExit,
onExited = _props3.onExited,
onExiting = _props3.onExiting,
open = _props3.open,
PaperProps = _props3.PaperProps,
role = _props3.role,
transformOrigin = _props3.transformOrigin,
TransitionProp = _props3.transition,
transitionDuration = _props3.transitionDuration,
other = (0, _objectWithoutProperties3.default)(_props3, ['action', 'anchorEl', 'anchorOrigin', 'anchorPosition', 'anchorReference', 'children', 'classes', 'container', 'elevation', 'getContentAnchorEl', 'marginThreshold', 'onEnter', 'onEntered', 'onEntering', 'onExit', 'onExited', 'onExiting', 'open', 'PaperProps', 'role', 'transformOrigin', 'transition', 'transitionDuration']);
// 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
var container = containerProp || (anchorEl ? (0, _ownerDocument2.default)(getAnchorEl(anchorEl)).body : undefined);
var transitionProps = {};
// The provided transition might not support the auto timeout value.
if (TransitionProp === _Grow2.default) {
transitionProps.timeout = transitionDuration;
}
return _react2.default.createElement(
_Modal2.default,
(0, _extends3.default)({ show: open, BackdropInvisible: true }, other),
(0, _extends3.default)({ container: container, open: open, BackdropProps: { invisible: true } }, other),
_react2.default.createElement(
_Grow2.default,
{
TransitionProp,
(0, _extends3.default)({
appear: true,
'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: function rootRef(node) {
ref: function ref(node) {
_this2.transitionEl = node;
}
},
}, transitionProps),
_react2.default.createElement(
_Paper2.default,
(0, _extends3.default)({
className: classes.paper,
elevation: elevation
}, PaperProps),
_react2.default.createElement(_reactEventListener2.default, { target: 'window', onResize: this.handleResize }),
@@ -492,17 +406,159 @@ var Popover = function (_React$Component) {
return Popover;
}(_react2.default.Component);
Popover.propTypes = process.env.NODE_ENV !== "production" ? {
/**
* 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: _propTypes2.default.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: _propTypes2.default.oneOfType([_propTypes2.default.object, _propTypes2.default.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: _propTypes2.default.shape({
horizontal: _propTypes2.default.oneOfType([_propTypes2.default.number, _propTypes2.default.oneOf(['left', 'center', 'right'])]),
vertical: _propTypes2.default.oneOfType([_propTypes2.default.number, _propTypes2.default.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: _propTypes2.default.shape({
top: _propTypes2.default.number,
left: _propTypes2.default.number
}),
/*
* This determines which anchor prop to refer to to set
* the position of the popover.
*/
anchorReference: _propTypes2.default.oneOf(['anchorEl', 'anchorPosition']),
/**
* The content of the component.
*/
children: _propTypes2.default.node,
/**
* Useful to extend the style applied to components.
*/
classes: _propTypes2.default.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: _propTypes2.default.oneOfType([_propTypes2.default.object, _propTypes2.default.func]),
/**
* The elevation of the popover.
*/
elevation: _propTypes2.default.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: _propTypes2.default.func,
/**
* Specifies how close to the edge of the window the popover can appear.
*/
marginThreshold: _propTypes2.default.number,
/**
* Callback fired when the component requests to be closed.
*
* @param {object} event The event source of the callback.
*/
onClose: _propTypes2.default.func,
/**
* Callback fired before the component is entering.
*/
onEnter: _propTypes2.default.func,
/**
* Callback fired when the component has entered.
*/
onEntered: _propTypes2.default.func,
/**
* Callback fired when the component is entering.
*/
onEntering: _propTypes2.default.func,
/**
* Callback fired before the component is exiting.
*/
onExit: _propTypes2.default.func,
/**
* Callback fired when the component has exited.
*/
onExited: _propTypes2.default.func,
/**
* Callback fired when the component is exiting.
*/
onExiting: _propTypes2.default.func,
/**
* If `true`, the popover is visible.
*/
open: _propTypes2.default.bool.isRequired,
/**
* Properties applied to the `Paper` element.
*/
PaperProps: _propTypes2.default.object,
/**
* @ignore
*/
role: _propTypes2.default.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: _propTypes2.default.shape({
horizontal: _propTypes2.default.oneOfType([_propTypes2.default.number, _propTypes2.default.oneOf(['left', 'center', 'right'])]),
vertical: _propTypes2.default.oneOfType([_propTypes2.default.number, _propTypes2.default.oneOf(['top', 'center', 'bottom'])])
}),
/**
* Transition component.
*/
transition: _propTypes2.default.oneOfType([_propTypes2.default.string, _propTypes2.default.func]),
/**
* Set to 'auto' to automatically calculate transition time based on height.
*/
transitionDuration: _propTypes2.default.oneOfType([_propTypes2.default.number, _propTypes2.default.shape({ enter: _propTypes2.default.number, exit: _propTypes2.default.number }), _propTypes2.default.oneOf(['auto'])])
} : {};
Popover.defaultProps = {
anchorReference: 'anchorEl',
anchorOrigin: {
vertical: 'top',
horizontal: 'left'
},
elevation: 8,
marginThreshold: 16,
transformOrigin: {
vertical: 'top',
horizontal: 'left'
},
transitionDuration: 'auto',
elevation: 8,
marginThreshold: 16
transition: _Grow2.default,
transitionDuration: 'auto'
};
exports.default = (0, _withStyles2.default)(styles, { name: 'MuiPopover' })(Popover);

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);

View File

@@ -1,2 +1,2 @@
export { default } from './Popover';
export * from './Popover';
export * from './Popover';

View File

@@ -1,3 +1 @@
// @flow
export { default } from './Popover';