@instructure/ui-navigation 8.8.1-snapshot.8 → 8.9.1

package/lib/AppNav/Item/props.js

@@ -0,0 +1,90 @@
+"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"));
+
+/*
+ * 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 text to display. If the `icon` prop is used, label text must be wrapped
+   * in `ScreenReaderContent`.
+   */
+  renderLabel: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]).isRequired,
+
+  /**
+   * Content to display after the renderLabel text, such as a badge
+   */
+  renderAfter: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]),
+
+  /**
+   * The visual to display (ex. an Image, Logo, Avatar, or Icon)
+   */
+  renderIcon: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]),
+
+  /**
+   * If the item goes to a new page, pass an href
+   */
+  href: _propTypes.default.string,
+
+  /**
+   * If the item does not go to a new page, pass an onClick
+   */
+  onClick: _propTypes.default.func,
+
+  /**
+   * Denotes which item is currently selected
+   */
+  isSelected: _propTypes.default.bool,
+
+  /**
+   * provides a reference to the underlying focusable (`button` or `a`) element
+   */
+  elementRef: _propTypes.default.func,
+
+  /**
+   * The element type to render as (will default to `<a>` if href is provided)
+   */
+  as: _propTypes.default.elementType,
+
+  /**
+   * Specify the mouse cursor to use on :hover.
+   * The `pointer` cursor is used by default.
+   */
+  cursor: _propTypes.default.string,
+
+  /**
+   * Disables the link or button visually and functionally
+   */
+  isDisabled: _propTypes.default.bool
+};
+exports.propTypes = propTypes;
+const allowedProps = ['renderLabel', 'renderAfter', 'renderIcon', 'href', 'onClick', 'isSelected', 'elementRef', 'as', 'cursor', 'isDisabled'];
+exports.allowedProps = allowedProps;

package/lib/AppNav/index.js

@@ -9,12 +9,8 @@ exports.default = exports.AppNav = void 0;
 
 var _react = require("react");
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _emotion = require("@instructure/emotion");
 
-var _Children = require("@instructure/ui-prop-types/lib/Children.js");
-
 var _getBoundingClientRect = require("@instructure/ui-dom-utils/lib/getBoundingClientRect.js");
 
 var _callRenderProp = require("@instructure/ui-react-utils/lib/callRenderProp.js");
@@ -37,6 +33,8 @@ var _styles = _interopRequireDefault(require("./styles"));
 
 var _theme = _interopRequireDefault(require("./theme"));
 
+var _props = require("./props");
+
 var _dec, _dec2, _class, _class2, _temp;
 
 /**
@@ -53,7 +51,9 @@ let AppNav = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.default), _
     this._list = null;
 
     this.measureItems = () => {
-      const menuTriggerWidth = (0, _px.px)(this.props.styles.menuTriggerWidth);
+      var _this$props$styles;
+
+      const menuTriggerWidth = (0, _px.px)((_this$props$styles = this.props.styles) === null || _this$props$styles === void 0 ? void 0 : _this$props$styles.menuTriggerWidth);
       let visibleItemsCount = 0;
 
       if (this._list) {
@@ -103,7 +103,9 @@ let AppNav = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.default), _
   }
 
   componentDidMount() {
-    this.props.makeStyles();
+    var _this$props$makeStyle, _this$props;
+
+    (_this$props$makeStyle = (_this$props = this.props).makeStyles) === null || _this$props$makeStyle === void 0 ? void 0 : _this$props$makeStyle.call(_this$props);
 
     const _getBoundingClientRec3 = (0, _getBoundingClientRect.getBoundingClientRect)(this._list),
           origWidth = _getBoundingClientRec3.width;
@@ -128,7 +130,9 @@ let AppNav = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.default), _
   }
 
   componentDidUpdate() {
-    this.props.makeStyles();
+    var _this$props$makeStyle2, _this$props2;
+
+    (_this$props$makeStyle2 = (_this$props2 = this.props).makeStyles) === null || _this$props$makeStyle2 === void 0 ? void 0 : _this$props$makeStyle2.call(_this$props2);
   }
 
   componentWillUnmount() {
@@ -142,9 +146,11 @@ let AppNav = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.default), _
   }
 
   renderListItem(item, isMenuTrigger, key) {
+    var _this$props$styles2, _this$props$styles3;
+
     return (0, _emotion.jsx)("li", {
       key: key,
-      css: isMenuTrigger ? this.props.styles.listItemWithMenuTrigger : this.props.styles.listItem
+      css: isMenuTrigger ? (_this$props$styles2 = this.props.styles) === null || _this$props$styles2 === void 0 ? void 0 : _this$props$styles2.listItemWithMenuTrigger : (_this$props$styles3 = this.props.styles) === null || _this$props$styles3 === void 0 ? void 0 : _this$props$styles3.listItem
     }, item);
   }
 
@@ -166,12 +172,14 @@ let AppNav = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.default), _
   }
 
   render() {
-    const _this$props = this.props,
-          children = _this$props.children,
-          visibleItemsCount = _this$props.visibleItemsCount,
-          screenReaderLabel = _this$props.screenReaderLabel,
-          margin = _this$props.margin,
-          elementRef = _this$props.elementRef;
+    var _this$props$styles4, _this$props$styles5, _this$props$styles6;
+
+    const _this$props3 = this.props,
+          children = _this$props3.children,
+          visibleItemsCount = _this$props3.visibleItemsCount,
+          screenReaderLabel = _this$props3.screenReaderLabel,
+          margin = _this$props3.margin,
+          elementRef = _this$props3.elementRef;
 
     const passthroughProps = _View.View.omitViewProps((0, _omitProps.omitProps)(this.props, AppNav.propTypes), AppNav);
 
@@ -186,86 +194,23 @@ let AppNav = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.default), _
     const hasRenderedContent = renderBeforeItems || renderAfterItems;
     return (0, _emotion.jsx)(_View.View, Object.assign({}, passthroughProps, {
       as: "nav",
-      css: [this.props.styles.appNav, hasRenderedContent ? this.props.styles.alignCenter : ''],
+      css: [(_this$props$styles4 = this.props.styles) === null || _this$props$styles4 === void 0 ? void 0 : _this$props$styles4.appNav, hasRenderedContent ? (_this$props$styles5 = this.props.styles) === null || _this$props$styles5 === void 0 ? void 0 : _this$props$styles5.alignCenter : ''],
       margin: margin,
       display: hasRenderedContent ? 'flex' : 'block',
       elementRef: elementRef
     }), renderBeforeItems && (0, _emotion.jsx)("span", null, renderBeforeItems), (0, _emotion.jsx)("ul", {
       ref: el => this._list = el,
-      css: this.props.styles.list,
+      css: (_this$props$styles6 = this.props.styles) === null || _this$props$styles6 === void 0 ? void 0 : _this$props$styles6.list,
       "aria-label": (0, _callRenderProp.callRenderProp)(screenReaderLabel)
     }, visibleChildren.map((child, index) => {
       return this.renderListItem(child, false, index);
     }), hiddenChildren.length > 0 && this.renderMenu(hiddenChildren)), renderAfterItems && (0, _emotion.jsx)("span", null, renderAfterItems));
   }
 
-}, _class2.displayName = "AppNav", _class2.componentId = 'AppNav', _class2.propTypes = {
-  /**
-   * Screenreader label for the overall navigation
-   */
-  screenReaderLabel: _propTypes.default.string.isRequired,
-
-  /**
-   * Only accepts `AppNav.Item` as children
-   */
-  children: _Children.Children.oneOf([_Item.Item]),
-
-  /**
-   * The rate (in ms) the component responds to container resizing or
-   * an update to one of its child items
-   */
-  debounce: _propTypes.default.number,
-
-  /**
-   * Content to display before the navigation items, such as a logo
-   */
-  renderBeforeItems: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]),
-
-  /**
-   * Content to display after the navigation items, aligned to the far end
-   * of the navigation
-   */
-  renderAfterItems: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]),
-
-  /**
-   * Valid values are `0`, `none`, `auto`, `xxx-small`, `xx-small`, `x-small`,
-   * `small`, `medium`, `large`, `x-large`, `xx-large`. Apply these values via
-   * familiar CSS-like shorthand. For example: `margin="small auto large"`.
-   */
-  margin: _emotion.ThemeablePropTypes.spacing,
-
-  /**
-   * Provides a reference to the underlying nav element
-   */
-  elementRef: _propTypes.default.func,
-
-  /**
-   * Customize the text displayed in the menu trigger when links overflow
-   * the overall nav width.
-   */
-  renderTruncateLabel: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]),
-
-  /**
-   * Called whenever the navigation items are updated or the size of
-   * the navigation changes. Passes in the `visibleItemsCount` as
-   * a parameter.
-   */
-  onUpdate: _propTypes.default.func,
-
-  /**
-   * Sets the number of navigation items that are visible.
-   */
-  visibleItemsCount: _propTypes.default.number,
-  // eslint-disable-next-line react/require-default-props
-  makeStyles: _propTypes.default.func,
-  // eslint-disable-next-line react/require-default-props
-  styles: _propTypes.default.object
-}, _class2.defaultProps = {
+}, _class2.displayName = "AppNav", _class2.componentId = 'AppNav', _class2.allowedProps = _props.allowedProps, _class2.propTypes = _props.propTypes, _class2.defaultProps = {
   children: null,
   debounce: 300,
   margin: '0',
-  renderBeforeItems: void 0,
-  renderAfterItems: void 0,
   elementRef: el => {},
   renderTruncateLabel: () => 'More',
   onUpdate: () => {},

package/lib/AppNav/props.js

@@ -0,0 +1,101 @@
+"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 _Children = require("@instructure/ui-prop-types/lib/Children.js");
+
+var _emotion = require("@instructure/emotion");
+
+var _Item = require("./Item");
+
+/*
+ * 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 = {
+  /**
+   * Screenreader label for the overall navigation
+   */
+  screenReaderLabel: _propTypes.default.string.isRequired,
+
+  /**
+   * Only accepts `AppNav.Item` as children
+   */
+  children: _Children.Children.oneOf([_Item.Item]),
+
+  /**
+   * The rate (in ms) the component responds to container resizing or
+   * an update to one of its child items
+   */
+  debounce: _propTypes.default.number,
+
+  /**
+   * Content to display before the navigation items, such as a logo
+   */
+  renderBeforeItems: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]),
+
+  /**
+   * Content to display after the navigation items, aligned to the far end
+   * of the navigation
+   */
+  renderAfterItems: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]),
+
+  /**
+   * Valid values are `0`, `none`, `auto`, `xxx-small`, `xx-small`, `x-small`,
+   * `small`, `medium`, `large`, `x-large`, `xx-large`. Apply these values via
+   * familiar CSS-like shorthand. For example: `margin="small auto large"`.
+   */
+  margin: _emotion.ThemeablePropTypes.spacing,
+
+  /**
+   * Provides a reference to the underlying nav element
+   */
+  elementRef: _propTypes.default.func,
+
+  /**
+   * Customize the text displayed in the menu trigger when links overflow
+   * the overall nav width.
+   */
+  renderTruncateLabel: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]),
+
+  /**
+   * Called whenever the navigation items are updated or the size of
+   * the navigation changes. Passes in the `visibleItemsCount` as
+   * a parameter.
+   */
+  onUpdate: _propTypes.default.func,
+
+  /**
+   * Sets the number of navigation items that are visible.
+   */
+  visibleItemsCount: _propTypes.default.number
+};
+exports.propTypes = propTypes;
+const allowedProps = ['screenReaderLabel', 'children', 'debounce', 'renderBeforeItems', 'renderAfterItems', 'margin', 'elementRef', 'renderTruncateLabel', 'onUpdate', 'visibleItemsCount'];
+exports.allowedProps = allowedProps;

package/lib/Navigation/NavigationItem/index.js

@@ -9,8 +9,6 @@ exports.NavigationItem = exports.default = void 0;
 
 var _react = require("react");
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _testable = require("@instructure/ui-testable/lib/testable.js");
 
 var _omitProps = require("@instructure/ui-react-utils/lib/omitProps.js");
@@ -27,6 +25,8 @@ var _styles = _interopRequireDefault(require("./styles"));
 
 var _theme = _interopRequireDefault(require("./theme"));
 
+var _props = require("./props");
+
 var _dec, _dec2, _class, _class2, _temp;
 
 /**
@@ -37,42 +37,48 @@ id: Navigation.Item
 **/
 let NavigationItem = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.default), _dec2 = (0, _testable.testable)(), _dec(_class = _dec2(_class = (_temp = _class2 = class NavigationItem extends _react.Component {
   componentDidMount() {
-    this.props.makeStyles({
-      minimized: this.minimized
+    var _this$props$makeStyle, _this$props;
+
+    (_this$props$makeStyle = (_this$props = this.props).makeStyles) === null || _this$props$makeStyle === void 0 ? void 0 : _this$props$makeStyle.call(_this$props, {
+      minimized: this.props.minimized
     });
   }
 
   componentDidUpdate() {
-    this.props.makeStyles({
-      minimized: this.minimized
+    var _this$props$makeStyle2, _this$props2;
+
+    (_this$props$makeStyle2 = (_this$props2 = this.props).makeStyles) === null || _this$props$makeStyle2 === void 0 ? void 0 : _this$props$makeStyle2.call(_this$props2, {
+      minimized: this.props.minimized
     });
   }
 
   renderLink() {
+    var _this$props$styles, _this$props$styles2, _this$props$styles3;
+
     const ElementType = (0, _getElementType.getElementType)(NavigationItem, this.props);
-    const _this$props = this.props,
-          href = _this$props.href,
-          onClick = _this$props.onClick,
-          icon = _this$props.icon,
-          label = _this$props.label;
+    const _this$props3 = this.props,
+          href = _this$props3.href,
+          onClick = _this$props3.onClick,
+          icon = _this$props3.icon,
+          label = _this$props3.label;
     const props = (0, _omitProps.omitProps)(this.props, NavigationItem.propTypes);
     return (0, _emotion.jsx)(ElementType, Object.assign({}, props, {
       href: href,
       onClick: onClick,
-      css: this.props.styles.navigationItem,
+      css: (_this$props$styles = this.props.styles) === null || _this$props$styles === void 0 ? void 0 : _this$props$styles.navigationItem,
       "aria-label": this.props.minimized ? label : void 0
     }), (0, _emotion.jsx)("div", {
-      css: this.props.styles.icon,
+      css: (_this$props$styles2 = this.props.styles) === null || _this$props$styles2 === void 0 ? void 0 : _this$props$styles2.icon,
       "aria-hidden": "true"
     }, icon), !this.props.minimized ? (0, _emotion.jsx)("div", {
-      css: this.props.styles.label
+      css: (_this$props$styles3 = this.props.styles) === null || _this$props$styles3 === void 0 ? void 0 : _this$props$styles3.label
     }, label) : null);
   }
 
   render() {
-    const _this$props2 = this.props,
-          minimized = _this$props2.minimized,
-          label = _this$props2.label;
+    const _this$props4 = this.props,
+          minimized = _this$props4.minimized,
+          label = _this$props4.label;
     const link = this.renderLink();
     return minimized && (0, _hasVisibleChildren.hasVisibleChildren)(label) ? (0, _emotion.jsx)(_Tooltip.Tooltip, {
       renderTip: label,
@@ -80,52 +86,11 @@ let NavigationItem = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.def
     }, link) : link;
   }
 
-}, _class2.displayName = "NavigationItem", _class2.componentId = 'Navigation.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 visual to display (ex. an Image, Logo, Avatar, or Icon)
-   */
-  icon: _propTypes.default.node.isRequired,
-
-  /**
-   * The text to display  for the Navigation Link
-   */
-  label: _propTypes.default.node.isRequired,
-
-  /**
-   * The element type to render as (will default to `<a>` if href is provided)
-   */
-  as: _propTypes.default.elementType,
-
-  /**
-   * If the NavigationItem goes to a new page, pass an href
-   */
-  href: _propTypes.default.string,
-
-  /**
-   * If the NavigationItem does not go to a new page pass an onClick
-   */
-  onClick: _propTypes.default.func,
-
-  /**
-   * Denotes which NavigationItem is currently selected
-   */
-  selected: _propTypes.default.bool,
-
-  /**
-   * When minimized is set to true, the `<Navigation />` shows icons only while the text becomes a tooltip. When it is set to false, the `<Navigation />` shows text in addition to the icons
-   */
-  minimized: _propTypes.default.bool
-}, _class2.defaultProps = {
+}, _class2.displayName = "NavigationItem", _class2.componentId = 'Navigation.Item', _class2.allowedProps = _props.allowedProps, _class2.propTypes = _props.propTypes, _class2.defaultProps = {
   as: 'a',
   onClick: function (e, selected) {},
   selected: false,
-  minimized: false,
-  href: void 0
+  minimized: false
 }, _temp)) || _class) || _class);
 exports.NavigationItem = NavigationItem;
 var _default = NavigationItem;