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

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [8.9.1](https://github.com/instructure/instructure-ui/compare/v8.9.0...v8.9.1) (2021-09-16)
+
+**Note:** Version bump only for package @instructure/ui-navigation
+
+# [8.9.0](https://github.com/instructure/instructure-ui/compare/v8.8.0...v8.9.0) (2021-09-15)
+
+### Bug Fixes
+
+- fix shared-types TS errors ([7b83164](https://github.com/instructure/instructure-ui/commit/7b83164f4c5872f3a217e010563f59bf584ae4fc))
+
 # [8.8.0](https://github.com/instructure/instructure-ui/compare/v8.7.0...v8.8.0) (2021-08-27)
 
 **Note:** Version bump only for package @instructure/ui-navigation

package/es/AppNav/Item/index.js

@@ -26,7 +26,6 @@ var _dec, _dec2, _class, _class2, _temp;
 
 /** @jsx jsx */
 import { Component } from 'react';
-import PropTypes from 'prop-types';
 import { logError as error } from '@instructure/console';
 import { callRenderProp, getElementType, matchComponentTypes, passthroughProps } from '@instructure/ui-react-utils';
 import { testable } from '@instructure/ui-testable';
@@ -35,7 +34,7 @@ import { ScreenReaderContent } from '@instructure/ui-a11y-content';
 import { withStyle, jsx } from '@instructure/emotion';
 import generateStyle from './styles';
 import generateComponentTheme from './theme';
-
+import { allowedProps, propTypes } from './props';
 /**
 ---
 parent: AppNav
@@ -43,6 +42,7 @@ id: AppNav.Item
 ---
 @module Item
 **/
+
 let Item = (_dec = withStyle(generateStyle, generateComponentTheme), _dec2 = testable(), _dec(_class = _dec2(_class = (_temp = _class2 = class Item extends Component {
   constructor(...args) {
     super(...args);
@@ -62,23 +62,29 @@ let Item = (_dec = withStyle(generateStyle, generateComponentTheme), _dec2 = tes
   }
 
   componentDidMount() {
-    this.props.makeStyles();
+    var _this$props$makeStyle, _this$props2;
+
+    (_this$props$makeStyle = (_this$props2 = this.props).makeStyles) === null || _this$props$makeStyle === void 0 ? void 0 : _this$props$makeStyle.call(_this$props2);
   }
 
   componentDidUpdate() {
-    this.props.makeStyles();
+    var _this$props$makeStyle2, _this$props3;
+
+    (_this$props$makeStyle2 = (_this$props3 = this.props).makeStyles) === null || _this$props$makeStyle2 === void 0 ? void 0 : _this$props$makeStyle2.call(_this$props3);
   }
 
   render() {
+    var _this$props$styles, _this$props$styles2;
+
     const ElementType = getElementType(Item, this.props);
-    const _this$props2 = this.props,
-          renderIcon = _this$props2.renderIcon,
-          renderLabel = _this$props2.renderLabel,
-          href = _this$props2.href,
-          elementRef = _this$props2.elementRef,
-          renderAfter = _this$props2.renderAfter,
-          cursor = _this$props2.cursor,
-          isDisabled = _this$props2.isDisabled;
+    const _this$props4 = this.props,
+          renderIcon = _this$props4.renderIcon,
+          renderLabel = _this$props4.renderLabel,
+          href = _this$props4.href,
+          elementRef = _this$props4.elementRef,
+          renderAfter = _this$props4.renderAfter,
+          cursor = _this$props4.cursor,
+          isDisabled = _this$props4.isDisabled;
     const icon = callRenderProp(renderIcon);
     const label = callRenderProp(renderLabel);
     const labelIsForScreenReaders = matchComponentTypes(label, [ScreenReaderContent]);
@@ -99,78 +105,16 @@ let Item = (_dec = withStyle(generateStyle, generateComponentTheme), _dec2 = tes
       onFocus: this.handleFocus,
       onBlur: this.handleBlur,
       cursor: isDisabled ? 'not-allowed' : cursor,
-      css: this.props.styles.item
+      css: (_this$props$styles = this.props.styles) === null || _this$props$styles === void 0 ? void 0 : _this$props$styles.item
     }), icon, labelIsForScreenReaders ? label : 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
     }, label), renderAfter && callRenderProp(renderAfter));
   }
 
-}, _class2.displayName = "Item", _class2.componentId = 'AppNav.Item', _class2.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
-}, _class2.defaultProps = {
+}, _class2.displayName = "Item", _class2.componentId = 'AppNav.Item', _class2.allowedProps = allowedProps, _class2.propTypes = propTypes, _class2.defaultProps = {
   children: null,
   onClick: function (event) {},
   isSelected: false,
-  href: void 0,
-  elementRef: void 0,
-  renderIcon: void 0,
-  renderAfter: void 0,
-  as: void 0,
   cursor: 'pointer',
   isDisabled: false
 }, _temp)) || _class) || _class);

package/es/AppNav/Item/props.js

@@ -0,0 +1,79 @@
+/*
+ * 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';
+const propTypes = {
+  /**
+   * 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
+};
+const allowedProps = ['renderLabel', 'renderAfter', 'renderIcon', 'href', 'onClick', 'isSelected', 'elementRef', 'as', 'cursor', 'isDisabled'];
+export { propTypes, allowedProps };

package/es/AppNav/index.js

@@ -26,9 +26,7 @@ var _dec, _dec2, _class, _class2, _temp;
 
 /** @jsx jsx */
 import { Children, Component } from 'react';
-import PropTypes from 'prop-types';
-import { withStyle, jsx, ThemeablePropTypes } from '@instructure/emotion';
-import { Children as ChildrenPropTypes } from '@instructure/ui-prop-types';
+import { withStyle, jsx } from '@instructure/emotion';
 import { getBoundingClientRect } from '@instructure/ui-dom-utils';
 import { callRenderProp, omitProps } from '@instructure/ui-react-utils';
 import { px } from '@instructure/ui-utils';
@@ -39,12 +37,13 @@ import { Menu } from '@instructure/ui-menu';
 import { Item } from './Item';
 import generateStyle from './styles';
 import generateComponentTheme from './theme';
-
+import { allowedProps, propTypes } from './props';
 /**
 ---
 category: components
 ---
 **/
+
 let AppNav = (_dec = withStyle(generateStyle, generateComponentTheme), _dec2 = testable(), _dec(_class = _dec2(_class = (_temp = _class2 = class AppNav extends Component {
   constructor(...args) {
     super(...args);
@@ -54,7 +53,9 @@ let AppNav = (_dec = withStyle(generateStyle, generateComponentTheme), _dec2 = t
     this._list = null;
 
     this.measureItems = () => {
-      const menuTriggerWidth = px(this.props.styles.menuTriggerWidth);
+      var _this$props$styles;
+
+      const menuTriggerWidth = 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) {
@@ -104,7 +105,9 @@ let AppNav = (_dec = withStyle(generateStyle, generateComponentTheme), _dec2 = t
   }
 
   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 = getBoundingClientRect(this._list),
           origWidth = _getBoundingClientRec3.width;
@@ -129,7 +132,9 @@ let AppNav = (_dec = withStyle(generateStyle, generateComponentTheme), _dec2 = t
   }
 
   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() {
@@ -143,9 +148,11 @@ let AppNav = (_dec = withStyle(generateStyle, generateComponentTheme), _dec2 = t
   }
 
   renderListItem(item, isMenuTrigger, key) {
+    var _this$props$styles2, _this$props$styles3;
+
     return 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);
   }
 
@@ -167,12 +174,14 @@ let AppNav = (_dec = withStyle(generateStyle, generateComponentTheme), _dec2 = t
   }
 
   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.omitViewProps(omitProps(this.props, AppNav.propTypes), AppNav);
     const isMeasuring = this.state.isMeasuring;
     const childrenArray = Children.toArray(children);
@@ -183,86 +192,23 @@ let AppNav = (_dec = withStyle(generateStyle, generateComponentTheme), _dec2 = t
     const hasRenderedContent = renderBeforeItems || renderAfterItems;
     return jsx(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 && jsx("span", null, renderBeforeItems), 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": callRenderProp(screenReaderLabel)
     }, visibleChildren.map((child, index) => {
       return this.renderListItem(child, false, index);
     }), hiddenChildren.length > 0 && this.renderMenu(hiddenChildren)), renderAfterItems && jsx("span", null, renderAfterItems));
   }
 
-}, _class2.displayName = "AppNav", _class2.componentId = 'AppNav', _class2.propTypes = {
-  /**
-   * Screenreader label for the overall navigation
-   */
-  screenReaderLabel: PropTypes.string.isRequired,
-
-  /**
-   * Only accepts `AppNav.Item` as children
-   */
-  children: ChildrenPropTypes.oneOf([Item]),
-
-  /**
-   * The rate (in ms) the component responds to container resizing or
-   * an update to one of its child items
-   */
-  debounce: PropTypes.number,
-
-  /**
-   * Content to display before the navigation items, such as a logo
-   */
-  renderBeforeItems: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
-
-  /**
-   * Content to display after the navigation items, aligned to the far end
-   * of the navigation
-   */
-  renderAfterItems: PropTypes.oneOfType([PropTypes.node, PropTypes.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: ThemeablePropTypes.spacing,
-
-  /**
-   * Provides a reference to the underlying nav element
-   */
-  elementRef: PropTypes.func,
-
-  /**
-   * Customize the text displayed in the menu trigger when links overflow
-   * the overall nav width.
-   */
-  renderTruncateLabel: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
-
-  /**
-   * Called whenever the navigation items are updated or the size of
-   * the navigation changes. Passes in the `visibleItemsCount` as
-   * a parameter.
-   */
-  onUpdate: PropTypes.func,
-
-  /**
-   * Sets the number of navigation items that are visible.
-   */
-  visibleItemsCount: PropTypes.number,
-  // eslint-disable-next-line react/require-default-props
-  makeStyles: PropTypes.func,
-  // eslint-disable-next-line react/require-default-props
-  styles: PropTypes.object
-}, _class2.defaultProps = {
+}, _class2.displayName = "AppNav", _class2.componentId = 'AppNav', _class2.allowedProps = allowedProps, _class2.propTypes = propTypes, _class2.defaultProps = {
   children: null,
   debounce: 300,
   margin: '0',
-  renderBeforeItems: void 0,
-  renderAfterItems: void 0,
   elementRef: el => {},
   renderTruncateLabel: () => 'More',
   onUpdate: () => {},

package/es/AppNav/props.js

@@ -0,0 +1,87 @@
+/*
+ * 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 { Children as ChildrenPropTypes } from '@instructure/ui-prop-types';
+import { ThemeablePropTypes } from '@instructure/emotion';
+import { Item } from './Item';
+const propTypes = {
+  /**
+   * Screenreader label for the overall navigation
+   */
+  screenReaderLabel: PropTypes.string.isRequired,
+
+  /**
+   * Only accepts `AppNav.Item` as children
+   */
+  children: ChildrenPropTypes.oneOf([Item]),
+
+  /**
+   * The rate (in ms) the component responds to container resizing or
+   * an update to one of its child items
+   */
+  debounce: PropTypes.number,
+
+  /**
+   * Content to display before the navigation items, such as a logo
+   */
+  renderBeforeItems: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
+
+  /**
+   * Content to display after the navigation items, aligned to the far end
+   * of the navigation
+   */
+  renderAfterItems: PropTypes.oneOfType([PropTypes.node, PropTypes.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: ThemeablePropTypes.spacing,
+
+  /**
+   * Provides a reference to the underlying nav element
+   */
+  elementRef: PropTypes.func,
+
+  /**
+   * Customize the text displayed in the menu trigger when links overflow
+   * the overall nav width.
+   */
+  renderTruncateLabel: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
+
+  /**
+   * Called whenever the navigation items are updated or the size of
+   * the navigation changes. Passes in the `visibleItemsCount` as
+   * a parameter.
+   */
+  onUpdate: PropTypes.func,
+
+  /**
+   * Sets the number of navigation items that are visible.
+   */
+  visibleItemsCount: PropTypes.number
+};
+const allowedProps = ['screenReaderLabel', 'children', 'debounce', 'renderBeforeItems', 'renderAfterItems', 'margin', 'elementRef', 'renderTruncateLabel', 'onUpdate', 'visibleItemsCount'];
+export { propTypes, allowedProps };