@instructure/ui-menu 8.8.1-snapshot.3 → 8.8.1-snapshot.63

package/es/Menu/props.js

@@ -0,0 +1,167 @@
+/*
+ * 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 { PositionPropTypes } from '@instructure/ui-position';
+import { controllable, Children as ChildrenPropTypes } from '@instructure/ui-prop-types';
+const propTypes = {
+  /**
+   * Children of type `Menu.Item`, `Menu.Group`, `Menu.Separator`, or `Menu`
+   */
+  children: ChildrenPropTypes.oneOf(['MenuItem', 'MenuItemGroup', 'MenuItemSeparator', 'Menu']),
+
+  /**
+   * Description of the `<Menu />`
+   */
+  label: PropTypes.string,
+
+  /**
+   * Is the `<Menu />` disabled
+   */
+  disabled: PropTypes.bool,
+
+  /**
+   * The trigger element, if the `<Menu />` is to render as a popover
+   */
+  trigger: PropTypes.node,
+
+  /**
+   * If a trigger is supplied, where should the `<Menu />` be placed (relative to the trigger)
+   */
+  placement: PositionPropTypes.placement,
+
+  /**
+   * Should the `<Menu />` be open for the initial render
+   */
+  defaultShow: PropTypes.bool,
+
+  /**
+   * Is the `<Menu />` open (should be accompanied by `onToggle`)
+   */
+  show: controllable(PropTypes.bool, 'onToggle', 'defaultShow'),
+
+  /**
+   * Callback fired when the `<Menu />` is toggled open/closed. When used with `show`,
+   * the component will not control its own state.
+   */
+  onToggle: PropTypes.func,
+
+  /**
+   * Callback fired when an item within the `<Menu />` is selected
+   */
+  onSelect: PropTypes.func,
+
+  /**
+   * If a trigger is supplied, callback fired when the `<Menu />` is closed
+   */
+  onDismiss: PropTypes.func,
+
+  /**
+   * If a trigger is supplied, callback fired when the `<Menu />` trigger is blurred
+   */
+  onBlur: PropTypes.func,
+
+  /**
+   * If a trigger is supplied, callback fired when the `<Menu />` trigger is focused
+   */
+  onFocus: PropTypes.func,
+
+  /**
+   * If a trigger is supplied, callback fired onMouseOver for the `<Menu />` trigger
+   */
+  onMouseOver: PropTypes.func,
+
+  /**
+   * Callback fired on the onKeyDown of the `<Menu />`
+   */
+  onKeyDown: PropTypes.func,
+
+  /**
+   * Callback fired on the onKeyUp of the `<Menu />`
+   */
+  onKeyUp: PropTypes.func,
+
+  /**
+   * A function that returns a reference to the `<Menu />`
+   */
+  menuRef: PropTypes.func,
+
+  /**
+   * A function that returns a reference to the `<Popover />`
+   */
+  popoverRef: PropTypes.func,
+
+  /**
+   * If a trigger is supplied, an element or a function returning an element to use as the mount node
+   * for the `<Menu />` (defaults to `document.body`)
+   */
+  mountNode: PositionPropTypes.mountNode,
+
+  /**
+   * The parent in which to constrain the menu.
+   * One of: 'window', 'scroll-parent', 'parent', 'none', an element,
+   * or a function returning an element
+   */
+  constrain: PositionPropTypes.constrain,
+
+  /**
+   * If a trigger is supplied, an element, function returning an element, or array of elements that will not
+   * be hidden from the screen reader when the `<Menu />` is open
+   */
+  liveRegion: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.element), PropTypes.element, PropTypes.func]),
+
+  /**
+   * If a trigger is supplied, should the `<Menu />` hide when an item is selected
+   */
+  shouldHideOnSelect: PropTypes.bool,
+
+  /**
+   * If a trigger is supplied, should the `<Menu />` focus the trigger on after closing
+   */
+  shouldFocusTriggerOnClose: PropTypes.bool,
+
+  /**
+   * The type of `<Menu />`
+   */
+  type: PropTypes.oneOf(['flyout']),
+  id: PropTypes.string,
+
+  /**
+   * Whether or not an arrow pointing to the trigger should be rendered
+   */
+  withArrow: PropTypes.bool,
+
+  /**
+   * The horizontal offset for the positioned content.
+   * Works only if `trigger` is provided.
+   */
+  offsetX: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+
+  /**
+   * The vertical offset for the positioned content.
+   * Works only if `trigger` is provided.
+   */
+  offsetY: PropTypes.oneOfType([PropTypes.string, PropTypes.number])
+};
+const allowedProps = ['children', 'label', 'disabled', 'trigger', 'placement', 'defaultShow', 'show', 'onToggle', 'onSelect', 'onDismiss', 'onBlur', 'onFocus', 'onMouseOver', 'onKeyDown', 'onKeyUp', 'menuRef', 'popoverRef', 'mountNode', 'constrain', 'liveRegion', 'shouldHideOnSelect', 'shouldFocusTriggerOnClose', 'type', 'id', 'withArrow', 'offsetX', 'offsetY'];
+export { propTypes, allowedProps };

package/lib/Menu/MenuItem/index.js

@@ -9,8 +9,6 @@ exports.MenuItem = exports.default = void 0;
 
 var _react = require("react");
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _keycode = _interopRequireDefault(require("keycode"));
 
 var _IconCheckSolid2 = require("@instructure/ui-icons/lib/IconCheckSolid.js");
@@ -19,8 +17,6 @@ var _IconArrowOpenEndSolid = require("@instructure/ui-icons/lib/IconArrowOpenEnd
 
 var _uid = require("@instructure/uid");
 
-var _controllable = require("@instructure/ui-prop-types/lib/controllable.js");
-
 var _omitProps = require("@instructure/ui-react-utils/lib/omitProps.js");
 
 var _getElementType = require("@instructure/ui-react-utils/lib/getElementType.js");
@@ -41,6 +37,8 @@ var _styles = _interopRequireDefault(require("./styles"));
 
 var _theme = _interopRequireDefault(require("./theme"));
 
+var _props = require("./props");
+
 var _dec, _dec2, _class, _class2, _temp, _IconCheckSolid, _IconArrowOpenEndSoli;
 
 /**
@@ -182,20 +180,24 @@ let MenuItem = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.default),
   }
 
   renderContent() {
+    var _this$props$styles, _this$props$styles2, _this$props$styles3;
+
     const _this$props2 = this.props,
           children = _this$props2.children,
           type = _this$props2.type;
     return (0, _emotion.jsx)("span", null, (type === 'checkbox' || type === 'radio') && (0, _emotion.jsx)("span", {
-      css: this.props.styles.icon
+      css: (_this$props$styles = this.props.styles) === null || _this$props$styles === void 0 ? void 0 : _this$props$styles.icon
     }, this.selected && (_IconCheckSolid || (_IconCheckSolid = (0, _emotion.jsx)(_IconCheckSolid2.IconCheckSolid, null)))), (0, _emotion.jsx)("span", {
-      css: this.props.styles.label,
+      css: (_this$props$styles2 = this.props.styles) === null || _this$props$styles2 === void 0 ? void 0 : _this$props$styles2.label,
       id: this.labelId
     }, children), type === 'flyout' && (0, _emotion.jsx)("span", {
-      css: this.props.styles.icon
+      css: (_this$props$styles3 = this.props.styles) === null || _this$props$styles3 === void 0 ? void 0 : _this$props$styles3.icon
     }, _IconArrowOpenEndSoli || (_IconArrowOpenEndSoli = (0, _emotion.jsx)(_IconArrowOpenEndSolid.IconArrowOpenEndSolid, null))));
   }
 
   render() {
+    var _this$props$styles4;
+
     const _this$props3 = this.props,
           disabled = _this$props3.disabled,
           controls = _this$props3.controls,
@@ -207,79 +209,30 @@ let MenuItem = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.default),
     const ElementType = this.elementType;
     return (0, _emotion.jsx)(ElementType // eslint-disable-line jsx-a11y/mouse-events-have-key-events
     , Object.assign({
-      tabIndex: "-1" // note: tabIndex can be overridden by Menu or MenuItemGroup components
+      tabIndex: -1 // note: tabIndex can be overridden by Menu or MenuItemGroup components
 
     }, props, {
       href: href,
       role: this.role,
       "aria-labelledby": this.labelId,
-      "aria-disabled": disabled ? 'true' : null,
+      "aria-disabled": disabled ? 'true' : void 0,
       "aria-controls": controls,
-      "aria-checked": type === 'checkbox' || type === 'radio' ? this.selected ? 'true' : 'false' : null,
+      "aria-checked": type === 'checkbox' || type === 'radio' ? this.selected ? 'true' : 'false' : void 0,
       onClick: this.handleClick,
       onKeyUp: (0, _createChainedFunction.createChainedFunction)(onKeyUp, this.handleKeyUp),
       onKeyDown: (0, _createChainedFunction.createChainedFunction)(onKeyDown, this.handleKeyDown),
       ref: c => {
         this._node = c;
       },
-      css: this.props.styles.menuItem,
+      css: (_this$props$styles4 = this.props.styles) === null || _this$props$styles4 === void 0 ? void 0 : _this$props$styles4.menuItem,
       onMouseOver: this.handleMouseOver
     }), this.renderContent());
   }
 
-}, _class2.displayName = "MenuItem", _class2.componentId = 'Menu.Item', _class2.propTypes = {
-  // eslint-disable-next-line react/require-default-props
-  makeStyles: _propTypes.default.func,
-  // eslint-disable-next-line react/require-default-props
-  styles: _propTypes.default.object,
-
-  /* the menu item label */
-  children: _propTypes.default.node.isRequired,
-
-  /* whether to set the menu item state to selected or not on initial render */
-  defaultSelected: _propTypes.default.bool,
-
-  /**
-   * whether the menu item is selected or not (must be accompanied by an `onSelect` prop)
-   */
-  selected: (0, _controllable.controllable)(_propTypes.default.bool, 'onSelect', 'defaultSelected'),
-
-  /**
-   * when used with the `selected` prop, the component will not control its own state
-   */
-  onSelect: _propTypes.default.func,
-  onClick: _propTypes.default.func,
-  onKeyDown: _propTypes.default.func,
-  onKeyUp: _propTypes.default.func,
-  onMouseOver: _propTypes.default.func,
-
-  /**
-   * the id of the element that the menu item will act upon
-   */
-  controls: _propTypes.default.string,
-  disabled: _propTypes.default.bool,
-
-  /**
-   * the element type to render as (will default to `<a>` if href is provided)
-   */
-  as: _propTypes.default.elementType,
-  // eslint-disable-line react/require-default-props
-  type: _propTypes.default.oneOf(['button', 'checkbox', 'radio', 'flyout']),
-  value: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.number]),
-  href: _propTypes.default.string
-}, _class2.defaultProps = {
+}, _class2.displayName = "MenuItem", _class2.componentId = 'Menu.Item', _class2.propTypes = _props.propTypes, _class2.allowedProps = _props.allowedProps, _class2.defaultProps = {
   type: 'button',
   disabled: false,
-  onSelect: function (e, value, selected, item) {},
-  defaultSelected: void 0,
-  selected: void 0,
-  onClick: void 0,
-  onKeyDown: void 0,
-  onKeyUp: void 0,
-  onMouseOver: void 0,
-  controls: void 0,
-  value: void 0,
-  href: void 0
+  onSelect: function (e, value, selected, item) {}
 }, _class2.contextType = _MenuContext.MenuContext, _temp)) || _class) || _class);
 exports.MenuItem = MenuItem;
 var _default = MenuItem;

package/lib/Menu/MenuItem/props.js

@@ -0,0 +1,79 @@
+"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 _controllable = require("@instructure/ui-prop-types/lib/controllable.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 = {
+  /**
+   * the menu item label
+   */
+  children: _propTypes.default.node.isRequired,
+
+  /**
+   * whether to set the menu item state to selected or not on initial render
+   */
+  defaultSelected: _propTypes.default.bool,
+
+  /**
+   * whether the menu item is selected or not (must be accompanied by an `onSelect` prop)
+   */
+  selected: (0, _controllable.controllable)(_propTypes.default.bool, 'onSelect', 'defaultSelected'),
+
+  /**
+   * when used with the `selected` prop, the component will not control its own state
+   */
+  onSelect: _propTypes.default.func,
+  onClick: _propTypes.default.func,
+  onKeyDown: _propTypes.default.func,
+  onKeyUp: _propTypes.default.func,
+  onMouseOver: _propTypes.default.func,
+
+  /**
+   * the id of the element that the menu item will act upon
+   */
+  controls: _propTypes.default.string,
+  disabled: _propTypes.default.bool,
+
+  /**
+   * the element type to render as (will default to `<a>` if href is provided)
+   */
+  as: _propTypes.default.elementType,
+  // eslint-disable-line react/require-default-props
+  type: _propTypes.default.oneOf(['button', 'checkbox', 'radio', 'flyout']),
+  value: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.number]),
+  href: _propTypes.default.string
+};
+exports.propTypes = propTypes;
+const allowedProps = ['children', 'defaultSelected', 'selected', 'onSelect', 'onClick', 'onKeyDown', 'onKeyUp', 'onMouseOver', 'controls', 'disabled', 'as', 'type', 'value', 'href'];
+exports.allowedProps = allowedProps;

package/lib/Menu/MenuItemGroup/index.js

@@ -9,14 +9,8 @@ exports.MenuItemGroup = exports.default = void 0;
 
 var _react = require("react");
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _emotion = require("@instructure/emotion");
 
-var _controllable = require("@instructure/ui-prop-types/lib/controllable.js");
-
-var _Children = require("@instructure/ui-prop-types/lib/Children.js");
-
 var _omitProps = require("@instructure/ui-react-utils/lib/omitProps.js");
 
 var _safeCloneElement = require("@instructure/ui-react-utils/lib/safeCloneElement.js");
@@ -31,12 +25,12 @@ var _testable = require("@instructure/ui-testable/lib/testable.js");
 
 var _MenuItem = require("../MenuItem");
 
-var _MenuItemSeparator = require("../MenuItemSeparator");
-
 var _styles = _interopRequireDefault(require("./styles"));
 
 var _theme = _interopRequireDefault(require("./theme"));
 
+var _props = require("./props");
+
 var _dec, _dec2, _class, _class2, _temp;
 
 /**
@@ -130,9 +124,11 @@ let MenuItemGroup = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.defa
   }
 
   renderLabel() {
+    var _this$props$styles;
+
     const label = this.props.label;
     return (0, _hasVisibleChildren.hasVisibleChildren)(label) ? (0, _emotion.jsx)("span", {
-      css: this.props.styles.label
+      css: (_this$props$styles = this.props.styles) === null || _this$props$styles === void 0 ? void 0 : _this$props$styles.label
     }, label) : label;
   }
 
@@ -169,71 +165,24 @@ let MenuItemGroup = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.defa
   }
 
   render() {
+    var _this$props$styles2, _this$props$styles3;
+
     const props = (0, _omitProps.omitProps)(this.props, MenuItemGroup.propTypes);
     return (0, _emotion.jsx)("span", Object.assign({}, props, {
-      css: this.props.styles.menuItemGroup,
+      css: (_this$props$styles2 = this.props.styles) === null || _this$props$styles2 === void 0 ? void 0 : _this$props$styles2.menuItemGroup,
       role: "presentation"
     }), (0, _emotion.jsx)("span", {
       id: this._labelId
     }, this.renderLabel()), (0, _emotion.jsx)("ul", {
       role: "menu",
-      css: this.props.styles.items,
-      "aria-disabled": this.props.disabled ? 'true' : null,
+      css: (_this$props$styles3 = this.props.styles) === null || _this$props$styles3 === void 0 ? void 0 : _this$props$styles3.items,
+      "aria-disabled": this.props.disabled ? 'true' : void 0,
       "aria-labelledby": this._labelId
     }, this.renderChildren()));
   }
 
-}, _class2.displayName = "MenuItemGroup", _class2.componentId = 'Menu.Group', _class2.propTypes = {
-  // eslint-disable-next-line react/require-default-props
-  makeStyles: _propTypes.default.func,
-  // eslint-disable-next-line react/require-default-props
-  styles: _propTypes.default.object,
-  label: _propTypes.default.node.isRequired,
-  allowMultiple: _propTypes.default.bool,
-
-  /**
-   * children of type `Menu.Item`, `Menu.Separator`
-   */
-  children: _Children.Children.oneOf([_MenuItem.MenuItem, _MenuItemSeparator.MenuItemSeparator]),
-
-  /**
-   * an array of the values (or indices by default) for the selected items
-   */
-  selected: (0, _controllable.controllable)(_propTypes.default.array, 'onSelect', 'defaultSelected'),
-
-  /**
-   * an array of the values (or indices by default) for the selected items on initial render
-   */
-  defaultSelected: _propTypes.default.array,
-
-  /**
-   * call this function when a menu item is selected
-   */
-  onSelect: _propTypes.default.func,
-  onMouseOver: _propTypes.default.func,
-  onKeyDown: _propTypes.default.func,
-
-  /**
-   * the id of the element that the menu items will act upon
-   */
-  controls: _propTypes.default.string,
-
-  /**
-   * returns a reference to the `MenuItem`
-   */
-  itemRef: _propTypes.default.func,
-  disabled: _propTypes.default.bool,
-
-  /**
-   * should the group appear in the tab order (the first item will have a tabIndex of 0)
-   */
-  isTabbable: _propTypes.default.bool
-}, _class2.defaultProps = {
-  onMouseOver: void 0,
+}, _class2.displayName = "MenuItemGroup", _class2.componentId = 'Menu.Group', _class2.propTypes = _props.propTypes, _class2.allowedProps = _props.allowedProps, _class2.defaultProps = {
   disabled: false,
-  controls: void 0,
-  onKeyDown: void 0,
-  selected: void 0,
   children: null,
   isTabbable: false,
   allowMultiple: false,