@instructure/ui-menu 8.56.1 → 8.56.2-snapshot-2

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [8.56.2-snapshot-2](https://github.com/instructure/instructure-ui/compare/v8.56.1...v8.56.2-snapshot-2) (2024-08-06)
+
+
+### Bug Fixes
+
+* **ui-menu:** menuItem's onSelect type did not expose its value and selected types ([98ca20e](https://github.com/instructure/instructure-ui/commit/98ca20e215808283b891b13a47b2bb54e12967e2))
+
+
+
+
+
 ## [8.56.1](https://github.com/instructure/instructure-ui/compare/v8.56.0...v8.56.1) (2024-06-13)
 
 **Note:** Version bump only for package @instructure/ui-menu

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-menu",
-  "version": "8.56.1",
+  "version": "8.56.2-snapshot-2",
   "description": "A dropdown menu component",
   "author": "Instructure, Inc. Engineering and Product Design",
   "module": "./es/index.js",
@@ -23,29 +23,29 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@instructure/ui-axe-check": "8.56.1",
-    "@instructure/ui-babel-preset": "8.56.1",
-    "@instructure/ui-color-utils": "8.56.1",
-    "@instructure/ui-test-utils": "8.56.1",
-    "@instructure/ui-themes": "8.56.1",
+    "@instructure/ui-axe-check": "8.56.2-snapshot-2",
+    "@instructure/ui-babel-preset": "8.56.2-snapshot-2",
+    "@instructure/ui-color-utils": "8.56.2-snapshot-2",
+    "@instructure/ui-test-utils": "8.56.2-snapshot-2",
+    "@instructure/ui-themes": "8.56.2-snapshot-2",
     "@testing-library/jest-dom": "^6.1.4",
     "@testing-library/react": "^14.0.0",
     "@testing-library/user-event": "^14.5.1"
   },
   "dependencies": {
     "@babel/runtime": "^7.23.2",
-    "@instructure/console": "8.56.1",
-    "@instructure/emotion": "8.56.1",
-    "@instructure/shared-types": "8.56.1",
-    "@instructure/ui-a11y-utils": "8.56.1",
-    "@instructure/ui-dom-utils": "8.56.1",
-    "@instructure/ui-icons": "8.56.1",
-    "@instructure/ui-popover": "8.56.1",
-    "@instructure/ui-position": "8.56.1",
-    "@instructure/ui-prop-types": "8.56.1",
-    "@instructure/ui-react-utils": "8.56.1",
-    "@instructure/ui-testable": "8.56.1",
-    "@instructure/ui-utils": "8.56.1",
+    "@instructure/console": "8.56.2-snapshot-2",
+    "@instructure/emotion": "8.56.2-snapshot-2",
+    "@instructure/shared-types": "8.56.2-snapshot-2",
+    "@instructure/ui-a11y-utils": "8.56.2-snapshot-2",
+    "@instructure/ui-dom-utils": "8.56.2-snapshot-2",
+    "@instructure/ui-icons": "8.56.2-snapshot-2",
+    "@instructure/ui-popover": "8.56.2-snapshot-2",
+    "@instructure/ui-position": "8.56.2-snapshot-2",
+    "@instructure/ui-prop-types": "8.56.2-snapshot-2",
+    "@instructure/ui-react-utils": "8.56.2-snapshot-2",
+    "@instructure/ui-testable": "8.56.2-snapshot-2",
+    "@instructure/ui-utils": "8.56.2-snapshot-2",
     "keycode": "^2.2.1",
     "prop-types": "^15.8.1"
   },

package/src/Menu/MenuItem/index.tsx

@@ -22,7 +22,7 @@
  * SOFTWARE.
  */
 /** @jsx jsx */
-import React, { Component, MouseEventHandler } from 'react'
+import React, { Component } from 'react'
 import keycode from 'keycode'
 
 import { IconCheckSolid, IconArrowOpenEndSolid } from '@instructure/ui-icons'
@@ -253,7 +253,7 @@ class MenuItem extends Component<MenuItemProps, MenuItemState> {
               : 'false'
             : undefined
         }
-        onClick={this.handleClick as MouseEventHandler}
+        onClick={this.handleClick}
         onKeyUp={createChainedFunction(onKeyUp, this.handleKeyUp)}
         onKeyDown={createChainedFunction(onKeyDown, this.handleKeyDown)}
         ref={this.handleRef}

package/src/Menu/MenuItem/props.ts

@@ -39,8 +39,8 @@ import type { ViewOwnProps } from '@instructure/ui-view'
 
 type OnMenuItemSelect = (
   e: React.MouseEvent<ViewOwnProps>,
-  value: MenuItemOwnProps['value'],
-  selected: MenuItemOwnProps['selected'],
+  value: MenuItemProps['value'],
+  selected: MenuItemProps['selected'],
   args: MenuItem
 ) => void
 
@@ -74,8 +74,20 @@ type MenuItemOwnProps = {
    * the element type to render as (will default to `<a>` if href is provided)
    */
   as?: AsElementType
+  /**
+   * How this component should be rendered. If it's `checkbox` or `radio` it will
+   * display a checkmark based on its own 'selected' state, if it's `flyout` it will
+   * render an arrow after the label.
+   */
   type?: 'button' | 'checkbox' | 'radio' | 'flyout'
+  /**
+   * Arbitrary value that you can store in this component. Is sent out by the
+   * `onSelect` event
+   */
   value?: string | number
+  /**
+   * Value of the `href` prop that will be put on the underlying DOM element.
+   */
   href?: string
 }