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

package/src/Menu/MenuItemSeparator/index.tsx

@@ -24,7 +24,6 @@
 
 /** @jsx jsx */
 import { Component } from 'react'
-import PropTypes from 'prop-types'
 
 import { withStyle, jsx } from '@instructure/emotion'
 import { testable } from '@instructure/ui-testable'
@@ -32,7 +31,9 @@ import { omitProps } from '@instructure/ui-react-utils'
 
 import generateStyle from './styles'
 import generateComponentTheme from './theme'
-import { MenuSeparatorProps } from './types'
+
+import { propTypes, allowedProps } from './props'
+import type { MenuSeparatorProps } from './props'
 
 /**
 ---
@@ -46,12 +47,8 @@ id: Menu.Separator
 class MenuItemSeparator extends Component<MenuSeparatorProps> {
   static readonly componentId = 'Menu.Separator'
 
-  static propTypes = {
-    // eslint-disable-next-line react/require-default-props
-    makeStyles: PropTypes.func,
-    // eslint-disable-next-line react/require-default-props
-    styles: PropTypes.object
-  }
+  static propTypes = propTypes
+  static allowedProps = allowedProps
 
   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
@@ -69,7 +66,7 @@ class MenuItemSeparator extends Component<MenuSeparatorProps> {
       <div
         {...props}
         role="presentation"
-        css={this.props.styles.menuItemSeparator}
+        css={this.props.styles?.menuItemSeparator}
       />
     )
   }

package/src/Menu/{MenuItem/types.ts → MenuItemSeparator/props.ts}

@@ -22,22 +22,22 @@
  * SOFTWARE.
  */
 
-import { AsElementType } from '@instructure/shared-types'
-
-export type MenuItemProps = {
-  makeStyles?: (...args: any[]) => any
-  styles?: any
-  defaultSelected?: boolean
-  selected?: any // TODO: controllable(PropTypes.bool, 'onSelect', 'defaultSelected')
-  onSelect?: (...args: any[]) => any
-  onClick?: (...args: any[]) => any
-  onKeyDown?: (...args: any[]) => any
-  onKeyUp?: (...args: any[]) => any
-  onMouseOver?: (...args: any[]) => any
-  controls?: string
-  disabled?: boolean
-  as?: AsElementType
-  type?: 'button' | 'checkbox' | 'radio' | 'flyout'
-  value?: string | number
-  href?: string
-}
+import type { WithStyleProps } from '@instructure/emotion'
+import type { PropValidators } from '@instructure/shared-types'
+
+// keeping here to keep the structure of props.ts
+// eslint-disable-next-line
+type MenuSeparatorOwnProps = {}
+
+type PropKeys = keyof MenuSeparatorOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type MenuSeparatorProps = MenuSeparatorOwnProps & WithStyleProps
+
+const propTypes: PropValidators<PropKeys> = {}
+
+const allowedProps: AllowedPropKeys = []
+
+export type { MenuSeparatorProps }
+export { propTypes, allowedProps }

package/src/Menu/index.tsx

@@ -23,16 +23,10 @@
  */
 /** @jsx jsx */
 import { Children, Component, ReactElement } from 'react'
-import PropTypes from 'prop-types'
 import keycode from 'keycode'
 
 import { Popover } from '@instructure/ui-popover'
 import { uid } from '@instructure/uid'
-import {
-  controllable,
-  Children as ChildrenPropTypes
-} from '@instructure/ui-prop-types'
-import { PositionPropTypes } from '@instructure/ui-position'
 import {
   safeCloneElement,
   matchComponentTypes
@@ -49,7 +43,9 @@ import { withStyle, jsx } from '@instructure/emotion'
 
 import generateStyle from './styles'
 import generateComponentTheme from './theme'
-import { MenuProps } from './types'
+
+import { propTypes, allowedProps } from './props'
+import type { MenuProps } from './props'
 
 /**
 ---
@@ -61,134 +57,8 @@ category: components
 class Menu extends Component<MenuProps> {
   static readonly componentId = 'Menu'
 
-  static propTypes = {
-    // eslint-disable-next-line react/require-default-props
-    makeStyles: PropTypes.func,
-    // eslint-disable-next-line react/require-default-props
-    styles: PropTypes.object,
-    /**
-     * Children of type `Menu.Item`, `Menu.Group`, `Menu.Separator`, or `Menu`
-     */
-    children: ChildrenPropTypes.oneOf([
-      'MenuItem',
-      'MenuItemGroup',
-      'MenuItemSeparator',
-      'Menu'
-    ]),
-    /**
-     * Description of the `<Menu />`
-     */
-    label: PropTypes.string,
-    /**
-     * Is the `<Menu />` disabled
-     */
-    disabled: PropTypes.bool,
-    /**
-     * The trigger element, if the `<Menu />` is to render as a popover
-     */
-    trigger: PropTypes.node,
-    /**
-     * If a trigger is supplied, where should the `<Menu />` be placed (relative to the trigger)
-     */
-    placement: PositionPropTypes.placement,
-    /**
-     * Should the `<Menu />` be open for the initial render
-     */
-    defaultShow: PropTypes.bool,
-    /**
-     * Is the `<Menu />` open (should be accompanied by `onToggle`)
-     */
-    show: controllable(PropTypes.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.func,
-    /**
-     * Callback fired when an item within the `<Menu />` is selected
-     */
-    onSelect: PropTypes.func,
-    /**
-     * If a trigger is supplied, callback fired when the `<Menu />` is closed
-     */
-    onDismiss: PropTypes.func,
-    /**
-     * If a trigger is supplied, callback fired when the `<Menu />` trigger is blurred
-     */
-    onBlur: PropTypes.func,
-    /**
-     * If a trigger is supplied, callback fired when the `<Menu />` trigger is focused
-     */
-    onFocus: PropTypes.func,
-    /**
-     * If a trigger is supplied, callback fired onMouseOver for the `<Menu />` trigger
-     */
-    onMouseOver: PropTypes.func,
-    /**
-     * Callback fired on the onKeyDown of the `<Menu />`
-     */
-    onKeyDown: PropTypes.func,
-    /**
-     * Callback fired on the onKeyUp of the `<Menu />`
-     */
-    onKeyUp: PropTypes.func,
-    /*
-     * A function that returns a reference to the `<Menu />`
-     */
-    menuRef: PropTypes.func,
-    /**
-     * A function that returns a reference to the `<Popover />`
-     */
-    popoverRef: PropTypes.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.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.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.oneOfType([
-      PropTypes.arrayOf(PropTypes.element),
-      PropTypes.element,
-      PropTypes.func
-    ]),
-    /**
-     * If a trigger is supplied, should the `<Menu />` hide when an item is selected
-     */
-    shouldHideOnSelect: PropTypes.bool,
-    /**
-     * If a trigger is supplied, should the `<Menu />` focus the trigger on after closing
-     */
-    shouldFocusTriggerOnClose: PropTypes.bool,
-    /**
-     * The type of `<Menu />`
-     */
-    type: PropTypes.oneOf(['flyout']),
-    id: PropTypes.string,
-    /**
-     * Whether or not an arrow pointing to the trigger should be rendered
-     */
-    withArrow: PropTypes.bool,
-    /**
-     * The horizontal offset for the positioned content.
-     * Works only if `trigger` is provided.
-     */
-    offsetX: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
-    /**
-     * The vertical offset for the positioned content.
-     * Works only if `trigger` is provided.
-     */
-    offsetY: PropTypes.oneOfType([PropTypes.string, PropTypes.number])
-  }
-
+  static propTypes = propTypes
+  static allowedProps = allowedProps
   static defaultProps = {
     children: null,
     label: null,
@@ -221,9 +91,6 @@ class Menu extends Component<MenuProps> {
     liveRegion: null,
     shouldHideOnSelect: true,
     shouldFocusTriggerOnClose: true,
-    show: undefined,
-    id: undefined,
-    type: undefined,
     withArrow: true,
     offsetX: 0,
     offsetY: 0
@@ -595,7 +462,7 @@ class Menu extends Component<MenuProps> {
           aria-label={label}
           // @ts-expect-error ts-migrate(2322) FIXME: Type 'string' is not assignable to type 'number | ... Remove this comment to see the full error message
           tabIndex="0"
-          css={this.props.styles.menu}
+          css={this.props.styles?.menu}
           aria-labelledby={labelledBy || (trigger && this._labelId)}
           aria-controls={controls}
           // @ts-expect-error ts-migrate(2322) FIXME: Type '"true" | null' is not assignable to type 'bo... Remove this comment to see the full error message

package/src/Menu/props.ts

@@ -0,0 +1,235 @@
+/*
+ * 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 { PositionPropTypes } from '@instructure/ui-position'
+import {
+  controllable,
+  Children as ChildrenPropTypes
+} from '@instructure/ui-prop-types'
+
+import type { PropValidators } from '@instructure/shared-types'
+import type { WithStyleProps } from '@instructure/emotion'
+import type {
+  PlacementPropValues,
+  PositionConstraint,
+  PositionMountNode
+} from '@instructure/ui-position'
+
+type MenuOwnProps = {
+  children?: React.ReactNode // TODO: oneOf(['MenuItem', 'MenuItemGroup', 'MenuItemSeparator', 'Menu'])
+  label?: string
+  disabled?: boolean
+  trigger?: React.ReactNode
+  placement?: PlacementPropValues
+  defaultShow?: boolean
+  show?: any // TODO: controllable(PropTypes.bool, 'onToggle', 'defaultShow')
+  onToggle?: (...args: any[]) => any
+  onSelect?: (...args: any[]) => any
+  onDismiss?: (...args: any[]) => any
+  onBlur?: (...args: any[]) => any
+  onFocus?: (...args: any[]) => any
+  onMouseOver?: (...args: any[]) => any
+  onKeyDown?: (...args: any[]) => any
+  onKeyUp?: (...args: any[]) => any
+  menuRef?: (...args: any[]) => any
+  popoverRef?: (...args: any[]) => any
+  mountNode?: PositionMountNode
+  constrain?: PositionConstraint
+  liveRegion?:
+    | React.ReactElement[]
+    | React.ReactElement
+    | ((...args: any[]) => any)
+  shouldHideOnSelect?: boolean
+  shouldFocusTriggerOnClose?: boolean
+  type?: 'flyout'
+  id?: string
+  withArrow?: boolean
+  offsetX?: string | number
+  offsetY?: string | number
+}
+
+type PropKeys = keyof MenuOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type MenuProps = MenuOwnProps & WithStyleProps
+
+const propTypes: PropValidators<PropKeys> = {
+  /**
+   * Children of type `Menu.Item`, `Menu.Group`, `Menu.Separator`, or `Menu`
+   */
+  children: ChildrenPropTypes.oneOf([
+    'MenuItem',
+    'MenuItemGroup',
+    'MenuItemSeparator',
+    'Menu'
+  ]),
+  /**
+   * Description of the `<Menu />`
+   */
+  label: PropTypes.string,
+  /**
+   * Is the `<Menu />` disabled
+   */
+  disabled: PropTypes.bool,
+  /**
+   * The trigger element, if the `<Menu />` is to render as a popover
+   */
+  trigger: PropTypes.node,
+  /**
+   * If a trigger is supplied, where should the `<Menu />` be placed (relative to the trigger)
+   */
+  placement: PositionPropTypes.placement,
+  /**
+   * Should the `<Menu />` be open for the initial render
+   */
+  defaultShow: PropTypes.bool,
+  /**
+   * Is the `<Menu />` open (should be accompanied by `onToggle`)
+   */
+  show: controllable(PropTypes.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.func,
+  /**
+   * Callback fired when an item within the `<Menu />` is selected
+   */
+  onSelect: PropTypes.func,
+  /**
+   * If a trigger is supplied, callback fired when the `<Menu />` is closed
+   */
+  onDismiss: PropTypes.func,
+  /**
+   * If a trigger is supplied, callback fired when the `<Menu />` trigger is blurred
+   */
+  onBlur: PropTypes.func,
+  /**
+   * If a trigger is supplied, callback fired when the `<Menu />` trigger is focused
+   */
+  onFocus: PropTypes.func,
+  /**
+   * If a trigger is supplied, callback fired onMouseOver for the `<Menu />` trigger
+   */
+  onMouseOver: PropTypes.func,
+  /**
+   * Callback fired on the onKeyDown of the `<Menu />`
+   */
+  onKeyDown: PropTypes.func,
+  /**
+   * Callback fired on the onKeyUp of the `<Menu />`
+   */
+  onKeyUp: PropTypes.func,
+  /**
+   * A function that returns a reference to the `<Menu />`
+   */
+  menuRef: PropTypes.func,
+  /**
+   * A function that returns a reference to the `<Popover />`
+   */
+  popoverRef: PropTypes.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.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.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.oneOfType([
+    PropTypes.arrayOf(PropTypes.element),
+    PropTypes.element,
+    PropTypes.func
+  ]),
+  /**
+   * If a trigger is supplied, should the `<Menu />` hide when an item is selected
+   */
+  shouldHideOnSelect: PropTypes.bool,
+  /**
+   * If a trigger is supplied, should the `<Menu />` focus the trigger on after closing
+   */
+  shouldFocusTriggerOnClose: PropTypes.bool,
+  /**
+   * The type of `<Menu />`
+   */
+  type: PropTypes.oneOf(['flyout']),
+  id: PropTypes.string,
+  /**
+   * Whether or not an arrow pointing to the trigger should be rendered
+   */
+  withArrow: PropTypes.bool,
+  /**
+   * The horizontal offset for the positioned content.
+   * Works only if `trigger` is provided.
+   */
+  offsetX: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+  /**
+   * The vertical offset for the positioned content.
+   * Works only if `trigger` is provided.
+   */
+  offsetY: PropTypes.oneOfType([PropTypes.string, PropTypes.number])
+}
+
+const allowedProps: AllowedPropKeys = [
+  'children',
+  'label',
+  'disabled',
+  'trigger',
+  'placement',
+  'defaultShow',
+  'show',
+  'onToggle',
+  'onSelect',
+  'onDismiss',
+  'onBlur',
+  'onFocus',
+  'onMouseOver',
+  'onKeyDown',
+  'onKeyUp',
+  'menuRef',
+  'popoverRef',
+  'mountNode',
+  'constrain',
+  'liveRegion',
+  'shouldHideOnSelect',
+  'shouldFocusTriggerOnClose',
+  'type',
+  'id',
+  'withArrow',
+  'offsetX',
+  'offsetY'
+]
+
+export type { MenuProps }
+export { propTypes, allowedProps }