@instructure/ui-menu 8.13.1-snapshot.26 → 8.13.1-snapshot.36

package/types/Menu/props.d.ts

@@ -1,40 +1,118 @@
-/// <reference types="react" />
-import type { PropValidators, MenuTheme } from '@instructure/shared-types';
+import type { Menu } from './index';
+import type { PropValidators, MenuTheme, OtherHTMLAttributes } from '@instructure/shared-types';
 import type { WithStyleProps, ComponentStyle } from '@instructure/emotion';
 import type { PlacementPropValues, PositionConstraint, PositionMountNode } from '@instructure/ui-position';
+import type { OnMenuItemSelect } from './MenuItem/props';
+import type { Popover } from '@instructure/ui-popover';
+import React from 'react';
 declare type MenuOwnProps = {
+    /**
+     * Children of type `Menu.Item`, `Menu.Group`, `Menu.Separator`, or `Menu`
+     */
     children?: React.ReactNode;
+    /**
+     * Description of the `<Menu />`
+     */
     label?: string;
+    /**
+     * Is the `<Menu />` disabled
+     */
     disabled?: boolean;
+    /**
+     * The trigger element, if the `<Menu />` is to render as a popover
+     */
     trigger?: React.ReactNode;
+    /**
+     * If a trigger is supplied, where should the `<Menu />` be placed (relative to the trigger)
+     */
     placement?: PlacementPropValues;
+    /**
+     * Should the `<Menu />` be open for the initial render
+     */
     defaultShow?: boolean;
-    show?: any;
-    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;
+    /**
+     * Is the `<Menu />` open (should be accompanied by `onToggle`)
+     */
+    show?: boolean;
+    /**
+     * Callback fired when the `<Menu />` is toggled open/closed. When used with `show`,
+     * the component will not control its own state.
+     */
+    onToggle?: (show: boolean, menu: Menu) => void;
+    /**
+     * Callback fired when an item within the `<Menu />` is selected
+     */
+    onSelect?: OnMenuItemSelect;
+    /**
+     * If a trigger is supplied, callback fired when the `<Menu />` is closed
+     */
+    onDismiss?: (event: Event, documentClick: boolean) => void;
+    /**
+     * If a trigger is supplied, callback fired when the `<Menu />` trigger is focused
+     */
+    onFocus?: (event: Event) => void;
+    /**
+     * If a trigger is supplied, callback fired onMouseOver for the `<Menu />` trigger
+     */
+    onMouseOver?: (event: Event) => void;
+    /**
+     * Callback fired on the onKeyDown of the `<Menu />`
+     */
+    onKeyDown?: (event: React.KeyboardEvent) => void;
+    /**
+     * Callback fired on the onKeyUp of the `<Menu />`
+     */
+    onKeyUp?: (event: React.KeyboardEvent<HTMLUListElement>) => void;
+    /**
+     * A function that returns a reference to the `<Menu />`
+     */
+    menuRef?: (el: HTMLUListElement | null) => void;
+    /**
+     * A function that returns a reference to the `<Popover />`
+     */
+    popoverRef?: (el: Popover | null) => void;
+    /**
+     * 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?: PositionMountNode;
+    /**
+     * The parent in which to constrain the menu.
+     * One of: 'window', 'scroll-parent', 'parent', 'none', an element,
+     * or a function returning an element
+     */
     constrain?: PositionConstraint;
-    liveRegion?: // TODO check whether this is used
-    React.ReactElement[] | React.ReactElement | ((...args: any[]) => any);
+    /**
+     * If a trigger is supplied, should the `<Menu />` hide when an item is selected
+     */
     shouldHideOnSelect?: boolean;
+    /**
+     * If a trigger is supplied, should the `<Menu />` focus the trigger on after closing
+     */
     shouldFocusTriggerOnClose?: boolean;
+    /**
+     * The type of `<Menu />`
+     */
     type?: 'flyout';
     id?: string;
+    /**
+     * Whether or not an arrow pointing to the trigger should be rendered
+     */
     withArrow?: boolean;
+    /**
+     * The horizontal offset for the positioned content.
+     * Works only if `trigger` is provided.
+     */
     offsetX?: string | number;
+    /**
+     * The vertical offset for the positioned content.
+     * Works only if `trigger` is provided.
+     */
     offsetY?: string | number;
 };
 declare type PropKeys = keyof MenuOwnProps;
 declare type AllowedPropKeys = Readonly<Array<PropKeys>>;
-declare type MenuProps = MenuOwnProps & WithStyleProps<MenuTheme, MenuStyle>;
+declare type MenuProps = MenuOwnProps & WithStyleProps<MenuTheme, MenuStyle> & OtherHTMLAttributes<MenuOwnProps>;
 declare type MenuStyle = ComponentStyle<'menu'>;
 declare const propTypes: PropValidators<PropKeys>;
 declare const allowedProps: AllowedPropKeys;

package/types/Menu/props.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Menu/props.ts"],"names":[],"mappings":";AAgCA,OAAO,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AAC1E,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1E,OAAO,KAAK,EACV,mBAAmB,EACnB,kBAAkB,EAClB,iBAAiB,EAClB,MAAM,0BAA0B,CAAA;AAEjC,aAAK,YAAY,GAAG;IAClB,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,OAAO,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IACzB,SAAS,CAAC,EAAE,mBAAmB,CAAA;IAC/B,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,IAAI,CAAC,EAAE,GAAG,CAAA;IACV,QAAQ,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IAClC,QAAQ,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IAClC,SAAS,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACnC,MAAM,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IAChC,OAAO,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACjC,WAAW,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACrC,SAAS,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACnC,OAAO,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACjC,OAAO,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACjC,UAAU,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACpC,SAAS,CAAC,EAAE,iBAAiB,CAAA;IAC7B,SAAS,CAAC,EAAE,kBAAkB,CAAA;IAC9B,UAAU,CAAC,EACX,AADa,kCAAkC;IAC/C,KAAK,CAAC,YAAY,EAAE,GAAG,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAA;IACrE,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,yBAAyB,CAAC,EAAE,OAAO,CAAA;IACnC,IAAI,CAAC,EAAE,QAAQ,CAAA;IACf,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACzB,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAC1B,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,YAAY,CAAA;AAElC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,SAAS,GAAG,YAAY,GAAG,cAAc,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;AAEpE,aAAK,SAAS,GAAG,cAAc,CAAC,MAAM,CAAC,CAAA;AAEvC,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CA0HvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eA4BnB,CAAA;AAED,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,CAAA;AACpC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Menu/props.ts"],"names":[],"mappings":"AA+BA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,SAAS,CAAA;AAEnC,OAAO,KAAK,EACV,cAAc,EACd,SAAS,EACT,mBAAmB,EACpB,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1E,OAAO,KAAK,EACV,mBAAmB,EACnB,kBAAkB,EAClB,iBAAiB,EAClB,MAAM,0BAA0B,CAAA;AACjC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AACxD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAA;AACtD,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,aAAK,YAAY,GAAG;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IAC1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE,mBAAmB,CAAA;IAC/B;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;IACd;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,KAAK,IAAI,CAAA;IAC9C;;OAEG;IACH,QAAQ,CAAC,EAAE,gBAAgB,CAAA;IAC3B;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,OAAO,KAAK,IAAI,CAAA;IAC1D;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;IAChC;;OAEG;IACH,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;IACpC;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,aAAa,KAAK,IAAI,CAAA;IAChD;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,aAAa,CAAC,gBAAgB,CAAC,KAAK,IAAI,CAAA;IAChE;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,EAAE,EAAE,gBAAgB,GAAG,IAAI,KAAK,IAAI,CAAA;IAC/C;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,EAAE,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IACzC;;;OAGG;IACH,SAAS,CAAC,EAAE,iBAAiB,CAAA;IAC7B;;;;OAIG;IACH,SAAS,CAAC,EAAE,kBAAkB,CAAA;IAC9B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAA;IACnC;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAA;IACf,EAAE,CAAC,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACzB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAC1B,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,YAAY,CAAA;AAElC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,SAAS,GAAG,YAAY,GAC3B,cAAc,CAAC,SAAS,EAAE,SAAS,CAAC,GACpC,mBAAmB,CAAC,YAAY,CAAC,CAAA;AAEnC,aAAK,SAAS,GAAG,cAAc,CAAC,MAAM,CAAC,CAAA;AAEvC,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CA+BvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eA0BnB,CAAA;AAED,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,CAAA;AACpC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}

package/types/MenuContext.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="react" />
+import { MenuItem } from './Menu/MenuItem';
 /**
 ---
 private: true
@@ -6,8 +7,8 @@ private: true
 @module MenuContext
 **/
 declare const MenuContext: import("react").Context<{
-    registerMenuItem: () => void;
-    removeMenuItem: () => void;
+    registerMenuItem: (_value: MenuItem) => void;
+    removeMenuItem: (_value: MenuItem) => void;
 }>;
 export default MenuContext;
 export { MenuContext };

package/types/MenuContext.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MenuContext.d.ts","sourceRoot":"","sources":["../src/MenuContext.ts"],"names":[],"mappings":";AA0BA;;;;;GAKG;AACH,QAAA,MAAM,WAAW;;;EAGf,CAAA;AAEF,eAAe,WAAW,CAAA;AAC1B,OAAO,EAAE,WAAW,EAAE,CAAA"}
+{"version":3,"file":"MenuContext.d.ts","sourceRoot":"","sources":["../src/MenuContext.ts"],"names":[],"mappings":";AAyBA,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAE1C;;;;;GAKG;AACH,QAAA,MAAM,WAAW;+BACY,QAAQ;6BACV,QAAQ;EACjC,CAAA;AAEF,eAAe,WAAW,CAAA;AAC1B,OAAO,EAAE,WAAW,EAAE,CAAA"}