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

package/lib/Popover/index.js

@@ -11,14 +11,10 @@ exports.Popover = exports.default = void 0;
 
 var _react = _interopRequireWildcard(require("react"));
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _keycode = _interopRequireDefault(require("keycode"));
 
 var _Position = require("@instructure/ui-position/lib/Position");
 
-var _PositionPropTypes = require("@instructure/ui-position/lib/PositionPropTypes.js");
-
 var _parsePlacement = require("@instructure/ui-position/lib/parsePlacement.js");
 
 var _mirrorHorizontalPlacement = require("@instructure/ui-position/lib/mirrorHorizontalPlacement.js");
@@ -31,8 +27,6 @@ var _Dialog = require("@instructure/ui-dialog/lib/Dialog");
 
 var _bidirectional = require("@instructure/ui-i18n/lib/bidirectional.js");
 
-var _element = require("@instructure/ui-prop-types/lib/element.js");
-
 var _findDOMNode = require("@instructure/ui-dom-utils/lib/findDOMNode.js");
 
 var _containsActiveElement = require("@instructure/ui-dom-utils/lib/containsActiveElement.js");
@@ -55,12 +49,12 @@ var _console = require("@instructure/console");
 
 var _uid = require("@instructure/uid");
 
-var _emotion = require("@instructure/emotion");
-
 var _testable = require("@instructure/ui-testable/lib/testable.js");
 
 var _FocusRegion = require("@instructure/ui-a11y-utils/lib/FocusRegion.js");
 
+var _props = require("./props");
+
 var _dec, _dec2, _class, _class2, _temp;
 
 /**
@@ -486,219 +480,7 @@ let Popover = (_dec = (0, _bidirectional.bidirectional)(), _dec2 = (0, _testable
     }
   }
 
-}, _class2.displayName = "Popover", _class2.componentId = 'Popover', _class2.propTypes = {
-  /**
-   * Whether or not the `<Popover />` content is shown
-   */
-  isShowingContent: _propTypes.default.bool,
-
-  /**
-   * Whether or not to show the content by default, when uncontrolled
-   */
-  defaultIsShowingContent: _propTypes.default.bool,
-
-  /**
-   * The action that causes the content to display (`click`, `hover`, `focus`)
-   */
-  on: _propTypes.default.oneOfType([_propTypes.default.oneOf(['click', 'hover', 'focus']), _propTypes.default.arrayOf(_propTypes.default.oneOf(['click', 'hover', 'focus']))]),
-
-  /**
-   * Whether or not an arrow pointing to the trigger should be rendered
-   */
-  withArrow: _propTypes.default.bool,
-
-  /**
-   * Color variant of the popover content
-   */
-  color: _propTypes.default.oneOf(['primary', 'primary-inverse']),
-
-  /**
-   * The placement of the content in relation to the trigger
-   */
-  placement: _PositionPropTypes.PositionPropTypes.placement,
-
-  /**
-   * Controls the shadow depth for the `<Popover />`
-   */
-  shadow: _emotion.ThemeablePropTypes.shadow,
-
-  /**
-   * Controls the z-index depth for the `<Popover />` content
-   */
-  stacking: _emotion.ThemeablePropTypes.stacking,
-
-  /**
-   * A function that returns a reference to the content element
-   */
-  contentRef: _propTypes.default.func,
-
-  /**
-   * An element or a function returning an element to focus by default
-   */
-  defaultFocusElement: _propTypes.default.oneOfType([_propTypes.default.element, _propTypes.default.func]),
-
-  /**
-   * An accessible label for the `<Popover />` content
-   */
-  screenReaderLabel: _propTypes.default.string,
-
-  /**
-   * The horizontal offset for the positioned content
-   */
-  offsetX: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.number]),
-
-  /**
-   * The vertical offset for the positioned content
-   */
-  offsetY: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.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.PositionPropTypes.constrain,
-
-  /**
-   * Target element for positioning the Popover (if it differs from the trigger)
-   */
-  positionTarget: _propTypes.default.oneOfType([_element.element, _propTypes.default.func]),
-
-  /**
-   * An element or a function returning an element to use as the mount node
-   * for the `<Popover />` (defaults to `document.body`)
-   */
-  mountNode: _PositionPropTypes.PositionPropTypes.mountNode,
-
-  /**
-   * Insert the element at the 'top' of the mountNode or at the 'bottom'
-   */
-  insertAt: _propTypes.default.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.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.element), _propTypes.default.element, _propTypes.default.func]),
-
-  /**
-   * An id is generated if not supplied.
-   */
-  id: _propTypes.default.string,
-
-  /**
-   * Whether or not the content should offset to align by its arrow
-   */
-  shouldAlignArrow: _propTypes.default.bool,
-
-  /**
-   * Whether or not position should be tracked or just set on initial render
-   */
-  shouldTrackPosition: _propTypes.default.bool,
-
-  /**
-   * Should the `<Popover />` render offscreen when visually hidden
-   */
-  shouldRenderOffscreen: _propTypes.default.bool,
-
-  /**
-   * Whether focus should contained within the `<Popover/>` when it is open
-   */
-  shouldContainFocus: _propTypes.default.bool,
-
-  /**
-   * Whether focus should be returned to the trigger when the `<Popover/>` is closed
-   */
-  shouldReturnFocus: _propTypes.default.bool,
-
-  /**
-   * Should the `<Popover />` hide when clicks occur outside the content
-   */
-  shouldCloseOnDocumentClick: _propTypes.default.bool,
-
-  /**
-   * Should the `<Popover />` hide when the escape key is pressed
-   */
-  shouldCloseOnEscape: _propTypes.default.bool,
-
-  /**
-   * Should the content become focused when the trigger is blurred
-   */
-  shouldFocusContentOnTriggerBlur: _propTypes.default.bool,
-
-  /**
-   * Callback fired when content is shown. When controlled, this callback is
-   * fired when the Popover expects to be shown
-   */
-  onShowContent: _propTypes.default.func,
-
-  /**
-   * Callback fired when content is hidden. When controlled, this callback is
-   * fired when the Popover expects to be hidden
-   */
-  onHideContent: _propTypes.default.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.default.func,
-
-  /**
-   * Callback fired when the position changes
-   */
-  onPositionChanged: _propTypes.default.func,
-
-  /**
-   * Callback fired when component is clicked
-   */
-  onClick: _propTypes.default.func,
-
-  /**
-   * Callback fired when trigger is focused
-   */
-  onFocus: _propTypes.default.func,
-
-  /**
-   * Callback fired when component is blurred
-   */
-  onBlur: _propTypes.default.func,
-
-  /**
-   * Callback fired on keydown
-   */
-  onKeyDown: _propTypes.default.func,
-
-  /**
-   * Callback fired on keyup
-   */
-  onKeyUp: _propTypes.default.func,
-
-  /**
-  /**
-   * Callback fired when mouse is over trigger
-   */
-  onMouseOver: _propTypes.default.func,
-
-  /**
-   * Callback fired when mouse leaves trigger
-   */
-  onMouseOut: _propTypes.default.func,
-
-  /**
-   * The element that triggers the popover
-   */
-  renderTrigger: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]),
-
-  /**
-   * The content to be shown by the popover
-   */
-  children: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]),
-  // eslint-disable-next-line react/require-default-props
-  dir: _propTypes.default.oneOf(Object.values(_bidirectional.bidirectional.DIRECTION))
-}, _class2.defaultProps = {
-  isShowingContent: void 0,
+}, _class2.displayName = "Popover", _class2.componentId = 'Popover', _class2.allowedProps = _props.allowedProps, _class2.propTypes = _props.propTypes, _class2.defaultProps = {
   defaultIsShowingContent: false,
   placement: 'bottom center',
   stacking: 'topmost',
@@ -710,13 +492,7 @@ let Popover = (_dec = (0, _bidirectional.bidirectional)(), _dec2 = (0, _testable
   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/lib/Popover/props.js

@@ -0,0 +1,253 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.allowedProps = exports.propTypes = void 0;
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _element = require("@instructure/ui-prop-types/lib/element.js");
+
+var _emotion = require("@instructure/emotion");
+
+var _PositionPropTypes = require("@instructure/ui-position/lib/PositionPropTypes.js");
+
+/*
+ * 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.
+ */
+const propTypes = {
+  /**
+   * Whether or not the `<Popover />` content is shown
+   */
+  isShowingContent: _propTypes.default.bool,
+
+  /**
+   * Whether or not to show the content by default, when uncontrolled
+   */
+  defaultIsShowingContent: _propTypes.default.bool,
+
+  /**
+   * The action that causes the content to display (`click`, `hover`, `focus`)
+   */
+  on: _propTypes.default.oneOfType([_propTypes.default.oneOf(['click', 'hover', 'focus']), _propTypes.default.arrayOf(_propTypes.default.oneOf(['click', 'hover', 'focus']))]),
+
+  /**
+   * Whether or not an arrow pointing to the trigger should be rendered
+   */
+  withArrow: _propTypes.default.bool,
+
+  /**
+   * Color variant of the popover content
+   */
+  color: _propTypes.default.oneOf(['primary', 'primary-inverse']),
+
+  /**
+   * The placement of the content in relation to the trigger
+   */
+  placement: _PositionPropTypes.PositionPropTypes.placement,
+
+  /**
+   * Controls the shadow depth for the `<Popover />`
+   */
+  shadow: _emotion.ThemeablePropTypes.shadow,
+
+  /**
+   * Controls the z-index depth for the `<Popover />` content
+   */
+  stacking: _emotion.ThemeablePropTypes.stacking,
+
+  /**
+   * A function that returns a reference to the content element
+   */
+  contentRef: _propTypes.default.func,
+
+  /**
+   * An element or a function returning an element to focus by default
+   */
+  defaultFocusElement: _propTypes.default.oneOfType([_propTypes.default.element, _propTypes.default.func]),
+
+  /**
+   * An accessible label for the `<Popover />` content
+   */
+  screenReaderLabel: _propTypes.default.string,
+
+  /**
+   * The horizontal offset for the positioned content
+   */
+  offsetX: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.number]),
+
+  /**
+   * The vertical offset for the positioned content
+   */
+  offsetY: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.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.PositionPropTypes.constrain,
+
+  /**
+   * Target element for positioning the Popover (if it differs from the trigger)
+   */
+  positionTarget: _propTypes.default.oneOfType([_element.element, _propTypes.default.func]),
+
+  /**
+   * An element or a function returning an element to use as the mount node
+   * for the `<Popover />` (defaults to `document.body`)
+   */
+  mountNode: _PositionPropTypes.PositionPropTypes.mountNode,
+
+  /**
+   * Insert the element at the 'top' of the mountNode or at the 'bottom'
+   */
+  insertAt: _propTypes.default.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.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.element), _propTypes.default.element, _propTypes.default.func]),
+
+  /**
+   * An id is generated if not supplied.
+   */
+  id: _propTypes.default.string,
+
+  /**
+   * Whether or not the content should offset to align by its arrow
+   */
+  shouldAlignArrow: _propTypes.default.bool,
+
+  /**
+   * Whether or not position should be tracked or just set on initial render
+   */
+  shouldTrackPosition: _propTypes.default.bool,
+
+  /**
+   * Should the `<Popover />` render offscreen when visually hidden
+   */
+  shouldRenderOffscreen: _propTypes.default.bool,
+
+  /**
+   * Whether focus should contained within the `<Popover/>` when it is open
+   */
+  shouldContainFocus: _propTypes.default.bool,
+
+  /**
+   * Whether focus should be returned to the trigger when the `<Popover/>` is closed
+   */
+  shouldReturnFocus: _propTypes.default.bool,
+
+  /**
+   * Should the `<Popover />` hide when clicks occur outside the content
+   */
+  shouldCloseOnDocumentClick: _propTypes.default.bool,
+
+  /**
+   * Should the `<Popover />` hide when the escape key is pressed
+   */
+  shouldCloseOnEscape: _propTypes.default.bool,
+
+  /**
+   * Should the content become focused when the trigger is blurred
+   */
+  shouldFocusContentOnTriggerBlur: _propTypes.default.bool,
+
+  /**
+   * Callback fired when content is shown. When controlled, this callback is
+   * fired when the Popover expects to be shown
+   */
+  onShowContent: _propTypes.default.func,
+
+  /**
+   * Callback fired when content is hidden. When controlled, this callback is
+   * fired when the Popover expects to be hidden
+   */
+  onHideContent: _propTypes.default.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.default.func,
+
+  /**
+   * Callback fired when the position changes
+   */
+  onPositionChanged: _propTypes.default.func,
+
+  /**
+   * Callback fired when component is clicked
+   */
+  onClick: _propTypes.default.func,
+
+  /**
+   * Callback fired when trigger is focused
+   */
+  onFocus: _propTypes.default.func,
+
+  /**
+   * Callback fired when component is blurred
+   */
+  onBlur: _propTypes.default.func,
+
+  /**
+   * Callback fired on keydown
+   */
+  onKeyDown: _propTypes.default.func,
+
+  /**
+   * Callback fired on keyup
+   */
+  onKeyUp: _propTypes.default.func,
+
+  /**
+  /**
+   * Callback fired when mouse is over trigger
+   */
+  onMouseOver: _propTypes.default.func,
+
+  /**
+   * Callback fired when mouse leaves trigger
+   */
+  onMouseOut: _propTypes.default.func,
+
+  /**
+   * The element that triggers the popover
+   */
+  renderTrigger: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]),
+
+  /**
+   * The content to be shown by the popover
+   */
+  children: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func])
+};
+exports.propTypes = propTypes;
+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'];
+exports.allowedProps = allowedProps;