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

package/lib/Navigation/NavigationItem/props.js

@@ -0,0 +1,73 @@
+"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 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
+};
+exports.propTypes = propTypes;
+const allowedProps = ['icon', 'label', 'as', 'href', 'onClick', 'selected', 'minimized'];
+exports.allowedProps = allowedProps;

package/lib/Navigation/index.js

@@ -15,14 +15,8 @@ exports.Navigation = exports.default = void 0;
 
 var _react = require("react");
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _testable = require("@instructure/ui-testable/lib/testable.js");
 
-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");
@@ -39,6 +33,8 @@ var _styles = _interopRequireDefault(require("./styles"));
 
 var _theme = _interopRequireDefault(require("./theme"));
 
+var _props = require("./props");
+
 var _dec, _dec2, _class, _class2, _temp;
 
 const navMinimized = ({
@@ -71,13 +67,17 @@ let Navigation = (_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, {
       minimized: this.minimized
     });
   }
 
   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, {
       minimized: this.minimized
     });
   }
@@ -96,11 +96,13 @@ let Navigation = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.default
 
   renderChildren() {
     return _react.Children.map(this.props.children, child => {
+      var _this$props$styles;
+
       const navItem = (0, _safeCloneElement.safeCloneElement)(child, {
         minimized: this.state.minimized
       });
       return (0, _emotion.jsx)("li", {
-        css: this.props.styles.list
+        css: (_this$props$styles = this.props.styles) === null || _this$props$styles === void 0 ? void 0 : _this$props$styles.list
       }, navItem);
     });
   }
@@ -110,77 +112,33 @@ let Navigation = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.default
   }
 
   render() {
+    var _this$props$styles2, _this$props$styles3, _this$props$styles4, _this$props$styles5;
+
     const label = this.props.label;
     const props = (0, _omitProps.omitProps)(this.props, Navigation.propTypes, ['minimized']);
     return (0, _emotion.jsx)("nav", Object.assign({}, props, {
-      css: this.props.styles.navigation,
+      css: (_this$props$styles2 = this.props.styles) === null || _this$props$styles2 === void 0 ? void 0 : _this$props$styles2.navigation,
       "aria-label": label
     }), (0, _emotion.jsx)("ul", {
-      css: this.props.styles.content
+      css: (_this$props$styles3 = this.props.styles) === null || _this$props$styles3 === void 0 ? void 0 : _this$props$styles3.content
     }, this.renderChildren()), (0, _emotion.jsx)("div", {
-      css: this.props.styles.toggle
+      css: (_this$props$styles4 = this.props.styles) === null || _this$props$styles4 === void 0 ? void 0 : _this$props$styles4.toggle
     }, (0, _emotion.jsx)(_NavigationItem.NavigationItem, {
       "aria-expanded": !this.minimized,
       onClick: this.handleNavToggle,
       icon: (0, _emotion.jsx)(_IconMoveStartLine.IconMoveStartLine, {
-        css: this.props.styles.toggleIcon,
+        css: (_this$props$styles5 = this.props.styles) === null || _this$props$styles5 === void 0 ? void 0 : _this$props$styles5.toggleIcon,
         inline: false
       }),
       label: (0, _emotion.jsx)(_ScreenReaderContent.ScreenReaderContent, null, this.toggleMessage())
     })));
   }
 
-}, _class2.displayName = "Navigation", _class2.componentId = 'Navigation', _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 Navigation.Item
-   */
-  children: _Children.Children.oneOf([_NavigationItem.NavigationItem]),
-
-  /**
-   * 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: (0, _controllable.controllable)(_propTypes.default.bool, 'onMinimized', 'defaultMinimized'),
-
-  /**
-   * Whether the `<Navigation />` is initially minimized (uncontrolled)
-   */
-  defaultMinimized: _propTypes.default.bool,
-  onMinimized: _propTypes.default.func,
-
-  /**
-   * Screen reader label for the main Navigation
-   */
-  label: _propTypes.default.string.isRequired,
-
-  /**
-   * Screen reader label for the toggle button expanded/minimized state
-   */
-  toggleLabel: _propTypes.default.shape({
-    expandedLabel: _propTypes.default.string,
-    minimizedLabel: _propTypes.default.string
-  }).isRequired,
-
-  /**
-   * If the `<Navigation.Item>` goes to a new page, pass an href
-   */
-  href: _propTypes.default.string,
-
-  /**
-   * If the `<Navigation.Item>` does not go to a new page pass an onClick
-   */
-  onClick: _propTypes.default.func
-}, _class2.defaultProps = {
+}, _class2.displayName = "Navigation", _class2.componentId = 'Navigation', _class2.allowedProps = _props.allowedProps, _class2.propTypes = _props.propTypes, _class2.defaultProps = {
   children: null,
   defaultMinimized: false,
   onMinimized: function (event, minimized) {},
-  onClick: function (e) {},
-  href: void 0,
-  minimized: void 0
+  onClick: function (e) {}
 }, _class2.Item = _NavigationItem.NavigationItem, _temp)) || _class) || _class);
 exports.Navigation = Navigation;
 var _default = Navigation;

package/lib/Navigation/props.js

@@ -0,0 +1,83 @@
+"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 _NavigationItem = require("./NavigationItem");
+
+/*
+ * 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 = {
+  /**
+   * children of type Navigation.Item
+   */
+  children: _Children.Children.oneOf([_NavigationItem.NavigationItem]),
+
+  /**
+   * 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: (0, _controllable.controllable)(_propTypes.default.bool, 'onMinimized', 'defaultMinimized'),
+
+  /**
+   * Whether the `<Navigation />` is initially minimized (uncontrolled)
+   */
+  defaultMinimized: _propTypes.default.bool,
+  onMinimized: _propTypes.default.func,
+
+  /**
+   * Screen reader label for the main Navigation
+   */
+  label: _propTypes.default.string.isRequired,
+
+  /**
+   * Screen reader label for the toggle button expanded/minimized state
+   */
+  toggleLabel: _propTypes.default.shape({
+    expandedLabel: _propTypes.default.string,
+    minimizedLabel: _propTypes.default.string
+  }).isRequired,
+
+  /**
+   * If the `<Navigation.Item>` goes to a new page, pass an href
+   */
+  href: _propTypes.default.string,
+
+  /**
+   * If the `<Navigation.Item>` does not go to a new page pass an onClick
+   */
+  onClick: _propTypes.default.func
+};
+exports.propTypes = propTypes;
+const allowedProps = ['children', 'minimized', 'defaultMinimized', 'onMinimized', 'label', 'toggleLabel', 'href', 'onClick'];
+exports.allowedProps = allowedProps;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-navigation",
-  "version": "8.8.1-snapshot.8+7b83164f4",
+  "version": "8.9.1",
   "description": "Main and application level navigational components",
   "author": "Instructure, Inc. Engineering and Product Design",
   "type": "commonjs",
@@ -24,31 +24,31 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@instructure/ui-babel-preset": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-color-utils": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-test-locator": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-test-utils": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-themes": "8.8.1-snapshot.8+7b83164f4"
+    "@instructure/ui-babel-preset": "8.9.1",
+    "@instructure/ui-color-utils": "8.9.1",
+    "@instructure/ui-test-locator": "8.9.1",
+    "@instructure/ui-test-utils": "8.9.1",
+    "@instructure/ui-themes": "8.9.1"
   },
   "dependencies": {
     "@babel/runtime": "^7.13.10",
-    "@instructure/console": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/debounce": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/emotion": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/shared-types": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-a11y-content": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-a11y-utils": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-badge": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-dom-utils": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-focusable": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-icons": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-menu": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-prop-types": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-react-utils": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-testable": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-tooltip": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-utils": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-view": "8.8.1-snapshot.8+7b83164f4",
+    "@instructure/console": "8.9.1",
+    "@instructure/debounce": "8.9.1",
+    "@instructure/emotion": "8.9.1",
+    "@instructure/shared-types": "8.9.1",
+    "@instructure/ui-a11y-content": "8.9.1",
+    "@instructure/ui-a11y-utils": "8.9.1",
+    "@instructure/ui-badge": "8.9.1",
+    "@instructure/ui-dom-utils": "8.9.1",
+    "@instructure/ui-focusable": "8.9.1",
+    "@instructure/ui-icons": "8.9.1",
+    "@instructure/ui-menu": "8.9.1",
+    "@instructure/ui-prop-types": "8.9.1",
+    "@instructure/ui-react-utils": "8.9.1",
+    "@instructure/ui-testable": "8.9.1",
+    "@instructure/ui-tooltip": "8.9.1",
+    "@instructure/ui-utils": "8.9.1",
+    "@instructure/ui-view": "8.9.1",
     "prop-types": "^15"
   },
   "peerDependencies": {
@@ -57,6 +57,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "sideEffects": false,
-  "gitHead": "7b83164f4c5872f3a217e010563f59bf584ae4fc"
+  "sideEffects": false
 }

package/src/AppNav/Item/index.tsx

@@ -23,7 +23,6 @@
  */
 /** @jsx jsx */
 import { Component } from 'react'
-import PropTypes from 'prop-types'
 
 import { logError as error } from '@instructure/console'
 import {
@@ -40,7 +39,8 @@ import { withStyle, jsx } from '@instructure/emotion'
 
 import generateStyle from './styles'
 import generateComponentTheme from './theme'
-import { AppNavItemProps } from './types'
+import type { AppNavItemProps } from './props'
+import { allowedProps, propTypes } from './props'
 
 /**
 ---
@@ -54,78 +54,24 @@ id: AppNav.Item
 class Item extends Component<AppNavItemProps> {
   static readonly componentId = 'AppNav.Item'
 
-  static propTypes = {
-    // eslint-disable-next-line react/require-default-props
-    makeStyles: PropTypes.func,
-    // eslint-disable-next-line react/require-default-props
-    styles: PropTypes.object,
-    /**
-     * The text to display. If the `icon` prop is used, label text must be wrapped
-     * in `ScreenReaderContent`.
-     */
-    renderLabel: PropTypes.oneOfType([PropTypes.node, PropTypes.func])
-      .isRequired,
-    /**
-     * Content to display after the renderLabel text, such as a badge
-     */
-    renderAfter: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
-    /**
-     * The visual to display (ex. an Image, Logo, Avatar, or Icon)
-     */
-    renderIcon: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
-    /**
-     * If the item goes to a new page, pass an href
-     */
-    href: PropTypes.string,
-    /**
-     * If the item does not go to a new page, pass an onClick
-     */
-    onClick: PropTypes.func,
-    /**
-     * Denotes which item is currently selected
-     */
-    isSelected: PropTypes.bool,
-    /**
-     * provides a reference to the underlying focusable (`button` or `a`) element
-     */
-    elementRef: PropTypes.func,
-    /**
-     * The element type to render as (will default to `<a>` if href is provided)
-     */
-    as: PropTypes.elementType,
-    /**
-     * Specify the mouse cursor to use on :hover.
-     * The `pointer` cursor is used by default.
-     */
-    cursor: PropTypes.string,
-    /**
-     * Disables the link or button visually and functionally
-     */
-    isDisabled: PropTypes.bool
-  }
+  static allowedProps = allowedProps
+  static propTypes = propTypes
 
   static defaultProps = {
     children: null,
     // @ts-expect-error ts-migrate(6133) FIXME: 'event' is declared but its value is never read.
     onClick: function (event) {},
     isSelected: false,
-    href: undefined,
-    elementRef: undefined,
-    renderIcon: undefined,
-    renderAfter: undefined,
-    as: undefined,
     cursor: 'pointer',
     isDisabled: false
   }
 
   componentDidMount() {
-    // @ts-expect-error ts-migrate(2722) FIXME: Cannot invoke an object which is possibly 'undefin... Remove this comment to see the full error message
-    this.props.makeStyles()
+    this.props.makeStyles?.()
   }
 
   componentDidUpdate() {
-    // @ts-expect-error ts-migrate(2722) FIXME: Cannot invoke an object which is possibly 'undefin... Remove this comment to see the full error message
-    this.props.makeStyles()
+    this.props.makeStyles?.()
   }
 
   // @ts-expect-error ts-migrate(7006) FIXME: Parameter 'e' implicitly has an 'any' type.
@@ -183,13 +129,13 @@ class Item extends Component<AppNavItemProps> {
         // @ts-expect-error ts-migrate(2339) FIXME: Property 'handleBlur' does not exist on type 'Item... Remove this comment to see the full error message
         onBlur={this.handleBlur}
         cursor={isDisabled ? 'not-allowed' : cursor}
-        css={this.props.styles.item}
+        css={this.props.styles?.item}
       >
         {icon}
         {labelIsForScreenReaders ? (
           label
         ) : (
-          <span css={this.props.styles.label}>{label}</span>
+          <span css={this.props.styles?.label}>{label}</span>
         )}
         {renderAfter && callRenderProp(renderAfter)}
       </View>