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

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,

package/lib/Menu/MenuItemGroup/props.js

@@ -0,0 +1,87 @@
+"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");
+
+var _Children = require("@instructure/ui-prop-types/lib/Children.js");
+
+var _MenuItem = require("../MenuItem");
+
+var _MenuItemSeparator = require("../MenuItemSeparator");
+
+/*
+ * 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 = {
+  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
+};
+exports.propTypes = propTypes;
+const allowedProps = ['label', 'allowMultiple', 'children', 'selected', 'defaultSelected', 'onSelect', 'onMouseOver', 'onKeyDown', 'controls', 'itemRef', 'disabled', 'isTabbable'];
+exports.allowedProps = allowedProps;

package/lib/Menu/MenuItemSeparator/index.js

@@ -9,8 +9,6 @@ exports.MenuItemSeparator = exports.default = void 0;
 
 var _react = require("react");
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _emotion = require("@instructure/emotion");
 
 var _testable = require("@instructure/ui-testable/lib/testable.js");
@@ -21,6 +19,8 @@ var _styles = _interopRequireDefault(require("./styles"));
 
 var _theme = _interopRequireDefault(require("./theme"));
 
+var _props = require("./props");
+
 var _dec, _dec2, _class, _class2, _temp;
 
 /**
@@ -40,19 +40,16 @@ let MenuItemSeparator = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.
   }
 
   render() {
+    var _this$props$styles;
+
     const props = (0, _omitProps.omitProps)(this.props, MenuItemSeparator.propTypes);
     return (0, _emotion.jsx)("div", Object.assign({}, props, {
       role: "presentation",
-      css: this.props.styles.menuItemSeparator
+      css: (_this$props$styles = this.props.styles) === null || _this$props$styles === void 0 ? void 0 : _this$props$styles.menuItemSeparator
     }));
   }
 
-}, _class2.displayName = "MenuItemSeparator", _class2.componentId = 'Menu.Separator', _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
-}, _temp)) || _class) || _class);
+}, _class2.displayName = "MenuItemSeparator", _class2.componentId = 'Menu.Separator', _class2.propTypes = _props.propTypes, _class2.allowedProps = _props.allowedProps, _temp)) || _class) || _class);
 exports.MenuItemSeparator = MenuItemSeparator;
 var _default = MenuItemSeparator;
 exports.default = _default;

package/{src/Menu/MenuItemGroup/types.ts → lib/Menu/MenuItemSeparator/props.js}

@@ -1,3 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.allowedProps = exports.propTypes = void 0;
+
 /*
  * The MIT License (MIT)
  *
@@ -21,19 +28,9 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-
-export type MenuGroupProps = {
-  makeStyles?: (...args: any[]) => any
-  styles?: any
-  label: React.ReactNode
-  allowMultiple?: boolean
-  selected?: any // TODO: controllable(PropTypes.array, 'onSelect', 'defaultSelected')
-  defaultSelected?: any[]
-  onSelect?: (...args: any[]) => any
-  onMouseOver?: (...args: any[]) => any
-  onKeyDown?: (...args: any[]) => any
-  controls?: string
-  itemRef?: (...args: any[]) => any
-  disabled?: boolean
-  isTabbable?: boolean
-}
+// keeping here to keep the structure of props.ts
+// eslint-disable-next-line
+const propTypes = {};
+exports.propTypes = propTypes;
+const allowedProps = [];
+exports.allowedProps = allowedProps;

package/lib/Menu/index.js

@@ -27,20 +27,12 @@ exports.Menu = exports.default = void 0;
 
 var _react = require("react");
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _keycode = _interopRequireDefault(require("keycode"));
 
 var _Popover = require("@instructure/ui-popover/lib/Popover");
 
 var _uid = require("@instructure/uid");
 
-var _controllable = require("@instructure/ui-prop-types/lib/controllable.js");
-
-var _Children = require("@instructure/ui-prop-types/lib/Children.js");
-
-var _PositionPropTypes = require("@instructure/ui-position/lib/PositionPropTypes.js");
-
 var _safeCloneElement = require("@instructure/ui-react-utils/lib/safeCloneElement.js");
 
 var _matchComponentTypes = require("@instructure/ui-react-utils/lib/matchComponentTypes.js");
@@ -65,6 +57,8 @@ var _styles = _interopRequireDefault(require("./styles"));
 
 var _theme = _interopRequireDefault(require("./theme"));
 
+var _props = require("./props");
+
 var _dec, _dec2, _class, _class2, _temp;
 
 /**
@@ -349,6 +343,8 @@ let Menu = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.default), _de
   }
 
   renderMenu() {
+    var _this$props$styles;
+
     const _this$props2 = this.props,
           menuRef = _this$props2.menuRef,
           disabled = _this$props2.disabled,
@@ -369,7 +365,7 @@ let Menu = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.default), _de
       role: "menu",
       "aria-label": label,
       tabIndex: "0",
-      css: this.props.styles.menu,
+      css: (_this$props$styles = this.props.styles) === null || _this$props$styles === void 0 ? void 0 : _this$props$styles.menu,
       "aria-labelledby": labelledBy || trigger && this._labelId,
       "aria-controls": controls,
       "aria-disabled": disabled ? 'true' : null,
@@ -445,150 +441,7 @@ let Menu = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.default), _de
     }, this.renderMenu()) : this.renderMenu();
   }
 
-}, _class2.displayName = "Menu", _class2.componentId = 'Menu', _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,
-
-  /**
-   * Children of type `Menu.Item`, `Menu.Group`, `Menu.Separator`, or `Menu`
-   */
-  children: _Children.Children.oneOf(['MenuItem', 'MenuItemGroup', 'MenuItemSeparator', 'Menu']),
-
-  /**
-   * Description of the `<Menu />`
-   */
-  label: _propTypes.default.string,
-
-  /**
-   * Is the `<Menu />` disabled
-   */
-  disabled: _propTypes.default.bool,
-
-  /**
-   * The trigger element, if the `<Menu />` is to render as a popover
-   */
-  trigger: _propTypes.default.node,
-
-  /**
-   * If a trigger is supplied, where should the `<Menu />` be placed (relative to the trigger)
-   */
-  placement: _PositionPropTypes.PositionPropTypes.placement,
-
-  /**
-   * Should the `<Menu />` be open for the initial render
-   */
-  defaultShow: _propTypes.default.bool,
-
-  /**
-   * Is the `<Menu />` open (should be accompanied by `onToggle`)
-   */
-  show: (0, _controllable.controllable)(_propTypes.default.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.default.func,
-
-  /**
-   * Callback fired when an item within the `<Menu />` is selected
-   */
-  onSelect: _propTypes.default.func,
-
-  /**
-   * If a trigger is supplied, callback fired when the `<Menu />` is closed
-   */
-  onDismiss: _propTypes.default.func,
-
-  /**
-   * If a trigger is supplied, callback fired when the `<Menu />` trigger is blurred
-   */
-  onBlur: _propTypes.default.func,
-
-  /**
-   * If a trigger is supplied, callback fired when the `<Menu />` trigger is focused
-   */
-  onFocus: _propTypes.default.func,
-
-  /**
-   * If a trigger is supplied, callback fired onMouseOver for the `<Menu />` trigger
-   */
-  onMouseOver: _propTypes.default.func,
-
-  /**
-   * Callback fired on the onKeyDown of the `<Menu />`
-   */
-  onKeyDown: _propTypes.default.func,
-
-  /**
-   * Callback fired on the onKeyUp of the `<Menu />`
-   */
-  onKeyUp: _propTypes.default.func,
-
-  /*
-   * A function that returns a reference to the `<Menu />`
-   */
-  menuRef: _propTypes.default.func,
-
-  /**
-   * A function that returns a reference to the `<Popover />`
-   */
-  popoverRef: _propTypes.default.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.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.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.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.element), _propTypes.default.element, _propTypes.default.func]),
-
-  /**
-   * If a trigger is supplied, should the `<Menu />` hide when an item is selected
-   */
-  shouldHideOnSelect: _propTypes.default.bool,
-
-  /**
-   * If a trigger is supplied, should the `<Menu />` focus the trigger on after closing
-   */
-  shouldFocusTriggerOnClose: _propTypes.default.bool,
-
-  /**
-   * The type of `<Menu />`
-   */
-  type: _propTypes.default.oneOf(['flyout']),
-  id: _propTypes.default.string,
-
-  /**
-   * Whether or not an arrow pointing to the trigger should be rendered
-   */
-  withArrow: _propTypes.default.bool,
-
-  /**
-   * The horizontal offset for the positioned content.
-   * Works only if `trigger` is provided.
-   */
-  offsetX: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.number]),
-
-  /**
-   * The vertical offset for the positioned content.
-   * Works only if `trigger` is provided.
-   */
-  offsetY: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.number])
-}, _class2.defaultProps = {
+}, _class2.displayName = "Menu", _class2.componentId = 'Menu', _class2.propTypes = _props.propTypes, _class2.allowedProps = _props.allowedProps, _class2.defaultProps = {
   children: null,
   label: null,
   disabled: false,
@@ -610,9 +463,6 @@ let Menu = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.default), _de
   liveRegion: null,
   shouldHideOnSelect: true,
   shouldFocusTriggerOnClose: true,
-  show: void 0,
-  id: void 0,
-  type: void 0,
   withArrow: true,
   offsetX: 0,
   offsetY: 0