@instructure/ui-popover 8.8.1-snapshot.7 → 8.9.1-snapshot.2

package/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [8.9.0](https://github.com/instructure/instructure-ui/compare/v8.8.0...v8.9.0) (2021-09-15)
+
+**Note:** Version bump only for package @instructure/ui-popover
+
 # [8.8.0](https://github.com/instructure/instructure-ui/compare/v8.7.0...v8.8.0) (2021-08-27)
 
 ### Features

package/es/Popover/index.js

@@ -24,28 +24,26 @@ var _dec, _dec2, _class, _class2, _temp;
  * SOFTWARE.
  */
 import React, { Component } from 'react';
-import PropTypes from 'prop-types';
 import keycode from 'keycode';
-import { Position, PositionPropTypes, parsePlacement, mirrorHorizontalPlacement } from '@instructure/ui-position';
+import { Position, parsePlacement, mirrorHorizontalPlacement } from '@instructure/ui-position';
 import { ContextView, View } from '@instructure/ui-view';
 import { Dialog } from '@instructure/ui-dialog';
 import { bidirectional } from '@instructure/ui-i18n';
-import { element } from '@instructure/ui-prop-types';
 import { findDOMNode, containsActiveElement, requestAnimationFrame, handleMouseOverOut } from '@instructure/ui-dom-utils';
 import { safeCloneElement, callRenderProp } from '@instructure/ui-react-utils';
 import { createChainedFunction, shallowEqual, px } from '@instructure/ui-utils';
 import { logError as error } from '@instructure/console';
 import { uid } from '@instructure/uid';
-import { ThemeablePropTypes } from '@instructure/emotion';
 import { testable } from '@instructure/ui-testable';
 import { FocusRegion } from '@instructure/ui-a11y-utils';
-
+import { allowedProps, propTypes } from './props';
 /**
 ---
 category: components
 tags: overlay, portal, dialog
 ---
 **/
+
 let Popover = (_dec = bidirectional(), _dec2 = testable(), _dec(_class = _dec2(_class = (_temp = _class2 = class Popover extends Component {
   constructor(props) {
     super(props);
@@ -463,219 +461,7 @@ let Popover = (_dec = bidirectional(), _dec2 = testable(), _dec(_class = _dec2(_
     }
   }
 
-}, _class2.displayName = "Popover", _class2.componentId = 'Popover', _class2.propTypes = {
-  /**
-   * Whether or not the `<Popover />` content is shown
-   */
-  isShowingContent: PropTypes.bool,
-
-  /**
-   * Whether or not to show the content by default, when uncontrolled
-   */
-  defaultIsShowingContent: PropTypes.bool,
-
-  /**
-   * The action that causes the content to display (`click`, `hover`, `focus`)
-   */
-  on: PropTypes.oneOfType([PropTypes.oneOf(['click', 'hover', 'focus']), PropTypes.arrayOf(PropTypes.oneOf(['click', 'hover', 'focus']))]),
-
-  /**
-   * Whether or not an arrow pointing to the trigger should be rendered
-   */
-  withArrow: PropTypes.bool,
-
-  /**
-   * Color variant of the popover content
-   */
-  color: PropTypes.oneOf(['primary', 'primary-inverse']),
-
-  /**
-   * The placement of the content in relation to the trigger
-   */
-  placement: PositionPropTypes.placement,
-
-  /**
-   * Controls the shadow depth for the `<Popover />`
-   */
-  shadow: ThemeablePropTypes.shadow,
-
-  /**
-   * Controls the z-index depth for the `<Popover />` content
-   */
-  stacking: ThemeablePropTypes.stacking,
-
-  /**
-   * A function that returns a reference to the content element
-   */
-  contentRef: PropTypes.func,
-
-  /**
-   * An element or a function returning an element to focus by default
-   */
-  defaultFocusElement: PropTypes.oneOfType([PropTypes.element, PropTypes.func]),
-
-  /**
-   * An accessible label for the `<Popover />` content
-   */
-  screenReaderLabel: PropTypes.string,
-
-  /**
-   * The horizontal offset for the positioned content
-   */
-  offsetX: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
-
-  /**
-   * The vertical offset for the positioned content
-   */
-  offsetY: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
-
-  /**
-   * The parent in which to constrain the popover.
-   * One of: 'window', 'scroll-parent', 'parent', 'none', an element,
-   * or a function returning an element
-   */
-  constrain: PositionPropTypes.constrain,
-
-  /**
-   * Target element for positioning the Popover (if it differs from the trigger)
-   */
-  positionTarget: PropTypes.oneOfType([element, PropTypes.func]),
-
-  /**
-   * An element or a function returning an element to use as the mount node
-   * for the `<Popover />` (defaults to `document.body`)
-   */
-  mountNode: PositionPropTypes.mountNode,
-
-  /**
-   * Insert the element at the 'top' of the mountNode or at the 'bottom'
-   */
-  insertAt: PropTypes.oneOf(['bottom', 'top']),
-
-  /**
-   * An element, function returning an element, or array of elements that will
-   * not be hidden from the screen reader when the `<Popover />` is open
-   */
-  liveRegion: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.element), PropTypes.element, PropTypes.func]),
-
-  /**
-   * An id is generated if not supplied.
-   */
-  id: PropTypes.string,
-
-  /**
-   * Whether or not the content should offset to align by its arrow
-   */
-  shouldAlignArrow: PropTypes.bool,
-
-  /**
-   * Whether or not position should be tracked or just set on initial render
-   */
-  shouldTrackPosition: PropTypes.bool,
-
-  /**
-   * Should the `<Popover />` render offscreen when visually hidden
-   */
-  shouldRenderOffscreen: PropTypes.bool,
-
-  /**
-   * Whether focus should contained within the `<Popover/>` when it is open
-   */
-  shouldContainFocus: PropTypes.bool,
-
-  /**
-   * Whether focus should be returned to the trigger when the `<Popover/>` is closed
-   */
-  shouldReturnFocus: PropTypes.bool,
-
-  /**
-   * Should the `<Popover />` hide when clicks occur outside the content
-   */
-  shouldCloseOnDocumentClick: PropTypes.bool,
-
-  /**
-   * Should the `<Popover />` hide when the escape key is pressed
-   */
-  shouldCloseOnEscape: PropTypes.bool,
-
-  /**
-   * Should the content become focused when the trigger is blurred
-   */
-  shouldFocusContentOnTriggerBlur: PropTypes.bool,
-
-  /**
-   * Callback fired when content is shown. When controlled, this callback is
-   * fired when the Popover expects to be shown
-   */
-  onShowContent: PropTypes.func,
-
-  /**
-   * Callback fired when content is hidden. When controlled, this callback is
-   * fired when the Popover expects to be hidden
-   */
-  onHideContent: PropTypes.func,
-
-  /**
-   * Callback fired when content has been is initially positioned.
-   * If `shouldRenderOffscreen` is true, it will only fire once, the first
-   * time the content is shown
-   */
-  onPositioned: PropTypes.func,
-
-  /**
-   * Callback fired when the position changes
-   */
-  onPositionChanged: PropTypes.func,
-
-  /**
-   * Callback fired when component is clicked
-   */
-  onClick: PropTypes.func,
-
-  /**
-   * Callback fired when trigger is focused
-   */
-  onFocus: PropTypes.func,
-
-  /**
-   * Callback fired when component is blurred
-   */
-  onBlur: PropTypes.func,
-
-  /**
-   * Callback fired on keydown
-   */
-  onKeyDown: PropTypes.func,
-
-  /**
-   * Callback fired on keyup
-   */
-  onKeyUp: PropTypes.func,
-
-  /**
-  /**
-   * Callback fired when mouse is over trigger
-   */
-  onMouseOver: PropTypes.func,
-
-  /**
-   * Callback fired when mouse leaves trigger
-   */
-  onMouseOut: PropTypes.func,
-
-  /**
-   * The element that triggers the popover
-   */
-  renderTrigger: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
-
-  /**
-   * The content to be shown by the popover
-   */
-  children: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
-  // eslint-disable-next-line react/require-default-props
-  dir: PropTypes.oneOf(Object.values(bidirectional.DIRECTION))
-}, _class2.defaultProps = {
-  isShowingContent: void 0,
+}, _class2.displayName = "Popover", _class2.componentId = 'Popover', _class2.allowedProps = allowedProps, _class2.propTypes = propTypes, _class2.defaultProps = {
   defaultIsShowingContent: false,
   placement: 'bottom center',
   stacking: 'topmost',
@@ -687,13 +473,7 @@ let Popover = (_dec = bidirectional(), _dec2 = testable(), _dec(_class = _dec2(_
   contentRef: el => {},
   withArrow: true,
   constrain: 'window',
-  defaultFocusElement: void 0,
-  screenReaderLabel: void 0,
-  mountNode: void 0,
   insertAt: 'bottom',
-  liveRegion: void 0,
-  positionTarget: void 0,
-  id: void 0,
   shouldAlignArrow: false,
   shouldTrackPosition: true,
   shouldRenderOffscreen: false,

package/es/Popover/props.js

@@ -0,0 +1,239 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+import PropTypes from 'prop-types';
+import { element } from '@instructure/ui-prop-types';
+import { ThemeablePropTypes } from '@instructure/emotion';
+import { PositionPropTypes } from '@instructure/ui-position';
+const propTypes = {
+  /**
+   * Whether or not the `<Popover />` content is shown
+   */
+  isShowingContent: PropTypes.bool,
+
+  /**
+   * Whether or not to show the content by default, when uncontrolled
+   */
+  defaultIsShowingContent: PropTypes.bool,
+
+  /**
+   * The action that causes the content to display (`click`, `hover`, `focus`)
+   */
+  on: PropTypes.oneOfType([PropTypes.oneOf(['click', 'hover', 'focus']), PropTypes.arrayOf(PropTypes.oneOf(['click', 'hover', 'focus']))]),
+
+  /**
+   * Whether or not an arrow pointing to the trigger should be rendered
+   */
+  withArrow: PropTypes.bool,
+
+  /**
+   * Color variant of the popover content
+   */
+  color: PropTypes.oneOf(['primary', 'primary-inverse']),
+
+  /**
+   * The placement of the content in relation to the trigger
+   */
+  placement: PositionPropTypes.placement,
+
+  /**
+   * Controls the shadow depth for the `<Popover />`
+   */
+  shadow: ThemeablePropTypes.shadow,
+
+  /**
+   * Controls the z-index depth for the `<Popover />` content
+   */
+  stacking: ThemeablePropTypes.stacking,
+
+  /**
+   * A function that returns a reference to the content element
+   */
+  contentRef: PropTypes.func,
+
+  /**
+   * An element or a function returning an element to focus by default
+   */
+  defaultFocusElement: PropTypes.oneOfType([PropTypes.element, PropTypes.func]),
+
+  /**
+   * An accessible label for the `<Popover />` content
+   */
+  screenReaderLabel: PropTypes.string,
+
+  /**
+   * The horizontal offset for the positioned content
+   */
+  offsetX: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+
+  /**
+   * The vertical offset for the positioned content
+   */
+  offsetY: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+
+  /**
+   * The parent in which to constrain the popover.
+   * One of: 'window', 'scroll-parent', 'parent', 'none', an element,
+   * or a function returning an element
+   */
+  constrain: PositionPropTypes.constrain,
+
+  /**
+   * Target element for positioning the Popover (if it differs from the trigger)
+   */
+  positionTarget: PropTypes.oneOfType([element, PropTypes.func]),
+
+  /**
+   * An element or a function returning an element to use as the mount node
+   * for the `<Popover />` (defaults to `document.body`)
+   */
+  mountNode: PositionPropTypes.mountNode,
+
+  /**
+   * Insert the element at the 'top' of the mountNode or at the 'bottom'
+   */
+  insertAt: PropTypes.oneOf(['bottom', 'top']),
+
+  /**
+   * An element, function returning an element, or array of elements that will
+   * not be hidden from the screen reader when the `<Popover />` is open
+   */
+  liveRegion: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.element), PropTypes.element, PropTypes.func]),
+
+  /**
+   * An id is generated if not supplied.
+   */
+  id: PropTypes.string,
+
+  /**
+   * Whether or not the content should offset to align by its arrow
+   */
+  shouldAlignArrow: PropTypes.bool,
+
+  /**
+   * Whether or not position should be tracked or just set on initial render
+   */
+  shouldTrackPosition: PropTypes.bool,
+
+  /**
+   * Should the `<Popover />` render offscreen when visually hidden
+   */
+  shouldRenderOffscreen: PropTypes.bool,
+
+  /**
+   * Whether focus should contained within the `<Popover/>` when it is open
+   */
+  shouldContainFocus: PropTypes.bool,
+
+  /**
+   * Whether focus should be returned to the trigger when the `<Popover/>` is closed
+   */
+  shouldReturnFocus: PropTypes.bool,
+
+  /**
+   * Should the `<Popover />` hide when clicks occur outside the content
+   */
+  shouldCloseOnDocumentClick: PropTypes.bool,
+
+  /**
+   * Should the `<Popover />` hide when the escape key is pressed
+   */
+  shouldCloseOnEscape: PropTypes.bool,
+
+  /**
+   * Should the content become focused when the trigger is blurred
+   */
+  shouldFocusContentOnTriggerBlur: PropTypes.bool,
+
+  /**
+   * Callback fired when content is shown. When controlled, this callback is
+   * fired when the Popover expects to be shown
+   */
+  onShowContent: PropTypes.func,
+
+  /**
+   * Callback fired when content is hidden. When controlled, this callback is
+   * fired when the Popover expects to be hidden
+   */
+  onHideContent: PropTypes.func,
+
+  /**
+   * Callback fired when content has been is initially positioned.
+   * If `shouldRenderOffscreen` is true, it will only fire once, the first
+   * time the content is shown
+   */
+  onPositioned: PropTypes.func,
+
+  /**
+   * Callback fired when the position changes
+   */
+  onPositionChanged: PropTypes.func,
+
+  /**
+   * Callback fired when component is clicked
+   */
+  onClick: PropTypes.func,
+
+  /**
+   * Callback fired when trigger is focused
+   */
+  onFocus: PropTypes.func,
+
+  /**
+   * Callback fired when component is blurred
+   */
+  onBlur: PropTypes.func,
+
+  /**
+   * Callback fired on keydown
+   */
+  onKeyDown: PropTypes.func,
+
+  /**
+   * Callback fired on keyup
+   */
+  onKeyUp: PropTypes.func,
+
+  /**
+  /**
+   * Callback fired when mouse is over trigger
+   */
+  onMouseOver: PropTypes.func,
+
+  /**
+   * Callback fired when mouse leaves trigger
+   */
+  onMouseOut: PropTypes.func,
+
+  /**
+   * The element that triggers the popover
+   */
+  renderTrigger: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
+
+  /**
+   * The content to be shown by the popover
+   */
+  children: PropTypes.oneOfType([PropTypes.node, PropTypes.func])
+};
+const allowedProps = ['isShowingContent', 'defaultIsShowingContent', 'on', 'withArrow', 'color', 'placement', 'shadow', 'stacking', 'contentRef', 'defaultFocusElement', 'screenReaderLabel', 'offsetX', 'offsetY', 'constrain', 'positionTarget', 'mountNode', 'insertAt', 'liveRegion', 'id', 'shouldAlignArrow', 'shouldTrackPosition', 'shouldRenderOffscreen', 'shouldContainFocus', 'shouldReturnFocus', 'shouldCloseOnDocumentClick', 'shouldCloseOnEscape', 'shouldFocusContentOnTriggerBlur', 'onShowContent', 'onHideContent', 'onPositioned', 'onPositionChanged', 'onClick', 'onFocus', 'onBlur', 'onKeyDown', 'onKeyUp', 'onMouseOver', 'onMouseOut', 'renderTrigger', 'children'];
+export { propTypes, allowedProps };