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

package/src/AppNav/Item/props.ts

@@ -0,0 +1,107 @@
+/*
+ * 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 type { AsElementType, PropValidators } from '@instructure/shared-types'
+import type { WithStyleProps } from '@instructure/emotion'
+
+type AppNavItemOwnProps = {
+  renderLabel: React.ReactNode | ((...args: any[]) => any)
+  renderAfter?: React.ReactNode | ((...args: any[]) => any)
+  renderIcon?: React.ReactNode | ((...args: any[]) => any)
+  href?: string
+  onClick?: (...args: any[]) => any
+  isSelected?: boolean
+  elementRef?: (...args: any[]) => any
+  as?: AsElementType
+  cursor?: string
+  isDisabled?: boolean
+}
+
+type PropKeys = keyof AppNavItemOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type AppNavItemProps = AppNavItemOwnProps & WithStyleProps
+
+const propTypes: PropValidators<PropKeys> = {
+  /**
+   * 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: AllowedPropKeys = [
+  'renderLabel',
+  'renderAfter',
+  'renderIcon',
+  'href',
+  'onClick',
+  'isSelected',
+  'elementRef',
+  'as',
+  'cursor',
+  'isDisabled'
+]
+
+export type { AppNavItemProps }
+export { propTypes, allowedProps }

package/src/AppNav/Item/styles.ts

@@ -23,7 +23,7 @@
  */
 
 import { AppNavItemTheme } from '@instructure/shared-types'
-import { AppNavItemProps } from './types'
+import { AppNavItemProps } from './props'
 
 /**
  * ---

package/src/AppNav/index.tsx

@@ -24,10 +24,8 @@
 
 /** @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'
@@ -41,7 +39,8 @@ import { Item } from './Item'
 
 import generateStyle from './styles'
 import generateComponentTheme from './theme'
-import { AppNavProps } from './types'
+import type { AppNavProps } from './props'
+import { allowedProps, propTypes } from './props'
 
 /**
 ---
@@ -53,66 +52,13 @@ category: components
 class AppNav extends Component<AppNavProps> {
   static readonly componentId = 'AppNav'
 
-  static 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
-  }
+  static allowedProps = allowedProps
+  static propTypes = propTypes
 
   static defaultProps = {
     children: null,
     debounce: 300,
     margin: '0',
-    renderBeforeItems: undefined,
-    renderAfterItems: undefined,
     // @ts-expect-error ts-migrate(6133) FIXME: 'el' is declared but its value is never read.
     elementRef: (el) => {},
     renderTruncateLabel: () => 'More',
@@ -129,8 +75,7 @@ class AppNav extends Component<AppNavProps> {
   _list = null
 
   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?.()
     const { width: origWidth } = getBoundingClientRect(this._list)
 
     // @ts-expect-error ts-migrate(2339) FIXME: Property '_debounced' does not exist on type 'AppN... Remove this comment to see the full error message
@@ -157,8 +102,7 @@ class AppNav extends Component<AppNavProps> {
   }
 
   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?.()
   }
 
   componentWillUnmount() {
@@ -176,7 +120,7 @@ class AppNav extends Component<AppNavProps> {
   }
 
   measureItems = () => {
-    const menuTriggerWidth = px(this.props.styles.menuTriggerWidth)
+    const menuTriggerWidth = px(this.props.styles?.menuTriggerWidth as number)
     let visibleItemsCount = 0
 
     if (this._list) {
@@ -224,8 +168,8 @@ class AppNav extends Component<AppNavProps> {
         key={key}
         css={
           isMenuTrigger
-            ? this.props.styles.listItemWithMenuTrigger
-            : this.props.styles.listItem
+            ? this.props.styles?.listItemWithMenuTrigger
+            : this.props.styles?.listItem
         }
       >
         {item}
@@ -296,8 +240,8 @@ class AppNav extends Component<AppNavProps> {
         {...passthroughProps}
         as="nav"
         css={[
-          this.props.styles.appNav,
-          hasRenderedContent ? this.props.styles.alignCenter : ''
+          this.props.styles?.appNav,
+          hasRenderedContent ? this.props.styles?.alignCenter : ''
         ]}
         margin={margin}
         display={hasRenderedContent ? 'flex' : 'block'}
@@ -307,7 +251,7 @@ class AppNav extends Component<AppNavProps> {
         <ul
           // @ts-expect-error ts-migrate(2322) FIXME: Type 'HTMLUListElement | null' is not assignable t... Remove this comment to see the full error message
           ref={(el) => (this._list = el)}
-          css={this.props.styles.list}
+          css={this.props.styles?.list}
           aria-label={callRenderProp(screenReaderLabel)}
         >
           {visibleChildren.map((child, index) => {

package/src/AppNav/props.ts

@@ -0,0 +1,118 @@
+/*
+ * 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 React from 'react'
+import PropTypes from 'prop-types'
+
+import { Children as ChildrenPropTypes } from '@instructure/ui-prop-types'
+import { ThemeablePropTypes } from '@instructure/emotion'
+
+import { Item } from './Item'
+
+import type { Spacing, WithStyleProps } from '@instructure/emotion'
+import type { PropValidators } from '@instructure/shared-types'
+
+type AppNavOwnProps = {
+  screenReaderLabel: string
+  debounce?: number
+  renderBeforeItems?: React.ReactNode | ((...args: any[]) => any)
+  renderAfterItems?: React.ReactNode | ((...args: any[]) => any)
+  margin?: Spacing
+  elementRef?: (...args: any[]) => any
+  renderTruncateLabel?: React.ReactNode | ((...args: any[]) => any)
+  onUpdate?: (...args: any[]) => any
+  visibleItemsCount?: number
+  children?: React.ReactNode
+}
+
+type PropKeys = keyof AppNavOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type AppNavProps = AppNavOwnProps & WithStyleProps
+
+const propTypes: PropValidators<PropKeys> = {
+  /**
+   * 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: AllowedPropKeys = [
+  'screenReaderLabel',
+  'children',
+  'debounce',
+  'renderBeforeItems',
+  'renderAfterItems',
+  'margin',
+  'elementRef',
+  'renderTruncateLabel',
+  'onUpdate',
+  'visibleItemsCount'
+]
+
+export type { AppNavProps }
+export { propTypes, allowedProps }

package/src/Navigation/NavigationItem/index.tsx

@@ -23,7 +23,6 @@
  */
 /** @jsx jsx */
 import { Component } from 'react'
-import PropTypes from 'prop-types'
 
 import { testable } from '@instructure/ui-testable'
 import { omitProps, getElementType } from '@instructure/ui-react-utils'
@@ -33,7 +32,8 @@ import { withStyle, jsx } from '@instructure/emotion'
 
 import generateStyle from './styles'
 import generateComponentTheme from './theme'
-import { NavigationItemProps } from './types'
+import type { NavigationItemProps } from './props'
+import { allowedProps, propTypes } from './props'
 
 /**
 ---
@@ -46,58 +46,23 @@ id: Navigation.Item
 class NavigationItem extends Component<NavigationItemProps> {
   static readonly componentId = 'Navigation.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 visual to display (ex. an Image, Logo, Avatar, or Icon)
-     */
-    icon: PropTypes.node.isRequired,
-    /**
-     * The text to display  for the Navigation Link
-     */
-    label: PropTypes.node.isRequired,
-    /**
-     * The element type to render as (will default to `<a>` if href is provided)
-     */
-    as: PropTypes.elementType,
-    /**
-     * If the NavigationItem goes to a new page, pass an href
-     */
-    href: PropTypes.string,
-    /**
-     * If the NavigationItem does not go to a new page pass an onClick
-     */
-    onClick: PropTypes.func,
-    /**
-     * Denotes which NavigationItem is currently selected
-     */
-    selected: PropTypes.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.bool
-  } as const
+  static allowedProps = allowedProps
+  static propTypes = propTypes
 
   static defaultProps = {
     as: 'a',
     // @ts-expect-error ts-migrate(6133) FIXME: 'e' is declared but its value is never read.
     onClick: function (e, selected) {},
     selected: false,
-    minimized: false,
-    href: undefined
+    minimized: false
   } as const
 
   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({ minimized: this.minimized })
+    this.props.makeStyles?.({ minimized: this.props.minimized })
   }
 
   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({ minimized: this.minimized })
+    this.props.makeStyles?.({ minimized: this.props.minimized })
   }
 
   renderLink() {
@@ -112,15 +77,15 @@ class NavigationItem extends Component<NavigationItemProps> {
         {...props}
         href={href}
         onClick={onClick}
-        css={this.props.styles.navigationItem}
+        css={this.props.styles?.navigationItem}
         //@ts-expect-error TODO: INSTUI-3245
         aria-label={this.props.minimized ? label : undefined}
       >
-        <div css={this.props.styles.icon} aria-hidden="true">
+        <div css={this.props.styles?.icon} aria-hidden="true">
           {icon}
         </div>
         {!this.props.minimized ? (
-          <div css={this.props.styles.label}>{label}</div>
+          <div css={this.props.styles?.label}>{label}</div>
         ) : null}
       </ElementType>
     )