import clsx from 'clsx'; import { useRtl } from 'i18n-calypso'; import { defer } from 'lodash'; import PropTypes from 'prop-types'; import { createRef, useState, useEffect, Component } from 'react'; import ReactDom from 'react-dom'; import RootChild from '../root-child'; import { bindWindowListeners, unbindWindowListeners, onViewportChange, suggested as suggestPosition, constrainLeft, offset, } from './util'; import './style.scss'; const noop = () => {}; class PopoverInner extends Component { static defaultProps = { autoPosition: true, autoRtl: true, className: '', closeOnEsc: true, isRtl: false, focusOnShow: true, position: 'top', onShow: noop, onClose: noop, onMouseEnter: noop, onMouseLeave: noop, hideArrow: false, autoRepositionOnInitialLoad: false, // use with caution, read comment about autoRepositionOnInitialLoad below ignoreViewportSize: false, // To avoid constraining the popover to the viewport that causes the arrow shows in the wrong place }; /** * Timeout ID that determines if repositioning the Popover is currently scheduled and lets us * cancel the task. * @type {number|null} `setTimeout` handle or null */ scheduledPositionUpdate = null; /** * Timeout ID for the scheduled focus. Lets us cancel the task when hiding/unmounting. * @type {number|null} `setTimeout` handle or null */ scheduledFocus = null; popoverNodeRef = createRef(); popoverInnerNodeRef = createRef(); state = { left: -99999, top: -99999, positionClass: this.getPositionClass( this.props.position ), }; /** * Used to prevent inifinite repositioning when autoReposition is enabled. * @type {number} Number of times the position has not changed after this.setPosition() */ autoRepositionStability = 0; componentDidMount() { // make sure to set the viewport when mounting, because it might have been changed between two mounts of this // component, e.g. when the viewport is changed while the popover is hidden onViewportChange(); this.bindListeners(); this.setPosition(); this.show(); this.autoRepositionOnInitialLoad(); } componentDidUpdate() { // Update our position even when only our children change. To prevent infinite loops, // use `defer` and avoid scheduling a second update when one is already scheduled by // setting and checking `this.scheduledPositionUpdate`. // See https://github.com/Automattic/wp-calypso/commit/38e779cfebf6dd42bb30d8be7127951b0c531ae2 if ( this.scheduledPositionUpdate == null ) { this.scheduledPositionUpdate = defer( () => { this.setPosition(); this.scheduledPositionUpdate = null; } ); } } componentWillUnmount() { this.unbindListeners(); this.clearAutoRepositionOnInitialLoad(); } bindListeners() { this.bindClickoutHandler(); this.bindEscKeyListener(); this.bindReposition(); bindWindowListeners(); } unbindListeners() { this.unbindClickoutHandler(); this.unbindEscKeyListener(); this.unbindReposition(); unbindWindowListeners(); // cancel the scheduled reposition when the Popover is being removed from DOM if ( this.scheduledPositionUpdate != null ) { window.clearTimeout( this.scheduledPositionUpdate ); this.scheduledPositionUpdate = null; } // cancel the scheduled focus when we're hiding the Popover before the task had a chance to run if ( this.scheduledFocus != null ) { window.clearTimeout( this.scheduledFocus ); this.scheduledFocus = null; } } // --- ESC key --- bindEscKeyListener() { if ( this.props.closeOnEsc ) { document.addEventListener( 'keydown', this.onKeydown, true ); } } unbindEscKeyListener() { if ( this.props.closeOnEsc ) { document.removeEventListener( 'keydown', this.onKeydown, true ); } } onKeydown = ( event ) => { if ( event.keyCode === 27 ) { const domContext = ReactDom.findDOMNode( this.props.context ); if ( domContext ) { domContext.focus(); } this.close( true ); } }; getTouchEvent = () => { if ( 'onpointerdown' in document ) { return 'pointerdown'; } if ( 'ontouchstart' in document ) { return 'touchstart'; } return 'click'; }; // --- click outside --- bindClickoutHandler() { // run the listener in the capture phase, to run before the React click handler that // runs in the bubble phase. Sometimes, the React UI handler for a click closes its // UI element and removes the event target from DOM. Running the clickout handler after // that would fail to evaluate correctly if the `event.target` (already removed from DOM) // is a DOM child of the popover's DOM element. document.addEventListener( this.getTouchEvent(), this.onClickout, true ); } unbindClickoutHandler() { document.removeEventListener( this.getTouchEvent(), this.onClickout, true ); } onClickout = ( event ) => { const popoverContext = this.popoverInnerNodeRef.current; let shouldClose = popoverContext && ! popoverContext.contains( event.target ); if ( shouldClose && this.props.context ) { const domContext = ReactDom.findDOMNode( this.props.context ); shouldClose = domContext && ! domContext.contains( event.target ); } if ( shouldClose && this.props.ignoreContext ) { const ignoreContext = ReactDom.findDOMNode( this.props.ignoreContext ); shouldClose = ignoreContext && ! ignoreContext.contains( event.target ); } if ( shouldClose ) { this.close(); } }; // --- window `scroll` and `resize` --- bindReposition() { window.addEventListener( 'scroll', this.onWindowChange, true ); window.addEventListener( 'resize', this.onWindowChange, true ); } unbindReposition() { window.removeEventListener( 'scroll', this.onWindowChange, true ); window.removeEventListener( 'resize', this.onWindowChange, true ); } onWindowChange = () => { this.setPosition(); }; focusPopover() { // Defer the focus a bit to make sure that the popover already has the final position. // Initially, after first render, the popover is positioned outside the screen, at // { top: -9999, left: -9999 } where it already has dimensions. These dimensions are measured // and used to calculate the final position. // Focusing the element while it's off the screen would cause unwanted scrolling. this.scheduledFocus = defer( () => { if ( this.popoverNodeRef.current ) { this.popoverNodeRef.current.focus(); } this.scheduledFocus = null; } ); } getPositionClass( position ) { return `is-${ position.replace( /\s+/g, '-' ) }`; } /** * Adjusts position swapping left and right values * when right-to-left directionality is found. * @param {string} position Original position * @returns {string} Adjusted position */ adjustRtlPosition( position ) { if ( this.props.isRtl ) { switch ( position ) { case 'top right': case 'right top': return 'top left'; case 'right': return 'left'; case 'bottom right': case 'right bottom': return 'bottom left'; case 'bottom left': case 'left bottom': return 'bottom right'; case 'left': return 'right'; case 'top left': case 'left top': return 'top right'; } } return position; } /** * Computes the position of the Popover in function * of its main container and the target. * @returns {Object} reposition parameters */ computePosition() { const { position, relativePosition } = this.props; const domContainer = this.popoverInnerNodeRef.current; const domContext = ReactDom.findDOMNode( this.props.context ); if ( ! domContext ) { return null; } let suggestedPosition = position; if ( this.props.autoRtl ) { suggestedPosition = this.adjustRtlPosition( suggestedPosition ); } if ( this.props.autoPosition ) { suggestedPosition = suggestPosition( suggestedPosition, domContainer, domContext ); } const reposition = Object.assign( {}, constrainLeft( offset( suggestedPosition, domContainer, domContext, relativePosition ), domContainer, this.props.ignoreViewportSize ), { positionClass: this.getPositionClass( suggestedPosition ) } ); return reposition; } setPosition = () => { let position; // Do we have a custom position provided? if ( this.props.customPosition ) { position = Object.assign( { // Use the default if positionClass hasn't been provided positionClass: this.getPositionClass( this.constructor.defaultProps.position ), }, this.props.customPosition ); } else { position = this.computePosition(); } if ( position ) { this.setState( position ); } return position; }; /** * Last resort to position the popover in its correct position initially. * Might be due to other components have delayed render, for example, rendering based on API results, * causing the target object to "jump positions". * * This results in the popover to be rendered in the wrong position, so we need to reposition it. * @returns {void} */ autoRepositionOnInitialLoad = () => { if ( this.props.autoRepositionOnInitialLoad ) { this.autoRepositionOnInitialLoadInterval = setInterval( () => { const lastPosition = this.state; const { left, top } = this.setPosition(); if ( lastPosition.left === left || lastPosition.top === top ) { this.autoRepositionStability += 1; } // Arbitrary number to stop trying to reposition if the position has stabilized for performance reasons. if ( this.autoRepositionStability > 5 ) { clearInterval( this.autoRepositionOnInitialLoadInterval ); } }, 500 ); } }; clearAutoRepositionOnInitialLoad = () => { if ( this.autoRepositionOnInitialLoadInterval ) { clearInterval( this.autoRepositionOnInitialLoadInterval ); } }; getStylePosition() { const { left, top } = this.state; return { left, top }; } show() { if ( this.props.focusOnShow ) { this.focusPopover(); } this.props.onShow(); } close( wasCanceled = false ) { this.props.onClose( wasCanceled ); } handleOnMouseEnter = () => { const { onMouseEnter } = this.props; onMouseEnter?.(); }; handleOnMouseLeave = () => { const { onMouseLeave } = this.props; onMouseLeave?.(); }; render() { if ( ! this.props.context ) { return null; } const classes = clsx( 'popover', this.props.className, this.state.positionClass ); return (