@instructure/ui-menu 8.13.1-snapshot.9 → 8.14.0

package/types/Menu/MenuItemGroup/index.d.ts

@@ -1,26 +1,28 @@
 /** @jsx jsx */
 import { Component } from 'react';
 import { jsx } from '@instructure/emotion';
-import type { MenuGroupProps } from './props';
+import { MenuItem } from '../MenuItem';
+import type { MenuGroupProps, MenuGroupState } from './props';
+import type { OnMenuItemSelect, MenuItemProps } from '../MenuItem/props';
 /**
 ---
 parent: Menu
 id: Menu.Group
 ---
+@tsProps
 **/
-declare class MenuItemGroup extends Component<MenuGroupProps> {
+declare class MenuItemGroup extends Component<MenuGroupProps, MenuGroupState> {
     static readonly componentId = "Menu.Group";
     static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<keyof {
         label: import("react").ReactNode;
         allowMultiple?: boolean | undefined;
         children?: import("react").ReactNode;
-        selected?: any;
-        defaultSelected?: any[] | undefined;
-        onSelect?: ((...args: any[]) => any) | undefined;
-        onMouseOver?: ((...args: any[]) => any) | undefined;
-        onKeyDown?: ((...args: any[]) => any) | undefined;
+        selected?: (string | number)[] | undefined;
+        defaultSelected?: (string | number)[] | undefined;
+        onSelect?: ((e: import("react").MouseEvent<Element, MouseEvent>, updated: (string | number | undefined)[], selected: boolean | undefined, item: MenuItem) => void) | undefined;
+        onMouseOver?: ((e: import("react").MouseEvent<Element, MouseEvent>, args: MenuItem) => void) | undefined;
         controls?: string | undefined;
-        itemRef?: ((...args: any[]) => any) | undefined;
+        itemRef?: ((element: Element | null) => void) | undefined;
         disabled?: boolean | undefined;
         isTabbable?: boolean | undefined;
     }>;
@@ -28,13 +30,12 @@ declare class MenuItemGroup extends Component<MenuGroupProps> {
         label: import("react").ReactNode;
         allowMultiple?: boolean | undefined;
         children?: import("react").ReactNode;
-        selected?: any;
-        defaultSelected?: any[] | undefined;
-        onSelect?: ((...args: any[]) => any) | undefined;
-        onMouseOver?: ((...args: any[]) => any) | undefined;
-        onKeyDown?: ((...args: any[]) => any) | undefined;
+        selected?: (string | number)[] | undefined;
+        defaultSelected?: (string | number)[] | undefined;
+        onSelect?: ((e: import("react").MouseEvent<Element, MouseEvent>, updated: (string | number | undefined)[], selected: boolean | undefined, item: MenuItem) => void) | undefined;
+        onMouseOver?: ((e: import("react").MouseEvent<Element, MouseEvent>, args: MenuItem) => void) | undefined;
         controls?: string | undefined;
-        itemRef?: ((...args: any[]) => any) | undefined;
+        itemRef?: ((element: Element | null) => void) | undefined;
         disabled?: boolean | undefined;
         isTabbable?: boolean | undefined;
     })[];
@@ -44,20 +45,19 @@ declare class MenuItemGroup extends Component<MenuGroupProps> {
         isTabbable: boolean;
         allowMultiple: boolean;
         defaultSelected: never[];
-        itemRef: (item: any) => void;
-        onSelect: (e: any, value: any, selected: any, item: any) => void;
     };
-    constructor(props: any);
+    constructor(props: MenuGroupProps);
+    private _labelId;
     ref: Element | null;
     handleRef: (el: Element | null) => void;
     componentDidMount(): void;
     componentDidUpdate(): void;
-    handleSelect: (e: any, value: any, selected: any, item: any) => void;
-    updateSelected: (e: any, value: any, items: any, selected: any, item: any) => any[];
-    selectedFromChildren(props: any): any[] | null;
-    get selected(): any[];
+    handleSelect: OnMenuItemSelect;
+    updateSelected: (e: React.MouseEvent, value: MenuItemProps['value'], items: MenuGroupState['selected'], selected: MenuItemProps['selected'], item: MenuItem) => (string | number)[];
+    selectedFromChildren(props: MenuGroupProps): (string | number)[] | null;
+    get selected(): (string | number)[];
     renderLabel(): import("react").ReactNode;
-    renderChildren(): {}[] | null | undefined;
+    renderChildren(): jsx.JSX.Element[];
     render(): jsx.JSX.Element;
 }
 export default MenuItemGroup;

package/types/Menu/MenuItemGroup/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Menu/MenuItemGroup/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,EAAY,SAAS,EAAgB,MAAM,OAAO,CAAA;AAEzD,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAgBrD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAE7C;;;;;GAKG;AACH,cAEM,aAAc,SAAQ,SAAS,CAAC,cAAc,CAAC;IACnD,MAAM,CAAC,QAAQ,CAAC,WAAW,gBAAe;IAE1C,MAAM,CAAC,SAAS;;;;;;;;;;;;;OAAY;IAC5B,MAAM,CAAC,YAAY;;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,YAAY;;;;;;;;MAUlB;gBAGW,KAAK,KAAA;IAcjB,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAE9B;IAED,iBAAiB;IAKjB,kBAAkB;IAMlB,YAAY,yDAsBX;IAGD,cAAc,sEAmBb;IAGD,oBAAoB,CAAC,KAAK,KAAA;IAwB1B,IAAI,QAAQ,UAaX;IAED,WAAW;IAUX,cAAc;IAyCd,MAAM;CAuBP;AAED,eAAe,aAAa,CAAA;AAC5B,OAAO,EAAE,aAAa,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Menu/MenuItemGroup/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,EAAY,SAAS,EAAgB,MAAM,OAAO,CAAA;AAEzD,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAUrD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAMtC,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAC7D,OAAO,KAAK,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AAExE;;;;;;GAMG;AACH,cAEM,aAAc,SAAQ,SAAS,CAAC,cAAc,EAAE,cAAc,CAAC;IACnE,MAAM,CAAC,QAAQ,CAAC,WAAW,gBAAe;IAE1C,MAAM,CAAC,SAAS;;;;;;;;;;;;OAAY;IAC5B,MAAM,CAAC,YAAY;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,YAAY;;;;;;MAMlB;gBAEW,KAAK,EAAE,cAAc;IAYjC,OAAO,CAAC,QAAQ,CAAQ;IACxB,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAE9B;IAED,iBAAiB;IAIjB,kBAAkB;IAIlB,YAAY,EAAE,gBAAgB,CAqB7B;IAED,cAAc,MACT,gBAAgB,SACZ,aAAa,CAAC,OAAO,CAAC,SACtB,cAAc,CAAC,UAAU,CAAC,YACvB,aAAa,CAAC,UAAU,CAAC,QAC7B,QAAQ,yBAoBf;IAED,oBAAoB,CAAC,KAAK,EAAE,cAAc;IAoB1C,IAAI,QAAQ,wBAWX;IAED,WAAW;IAUX,cAAc;IAiCd,MAAM;CAqBP;AAED,eAAe,aAAa,CAAA;AAC5B,OAAO,EAAE,aAAa,EAAE,CAAA"}

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

@@ -1,18 +1,40 @@
-/// <reference types="react" />
+import { MenuItem } from '../MenuItem';
 import type { PropValidators, MenuGroupTheme, OtherHTMLAttributes } from '@instructure/shared-types';
 import type { WithStyleProps, ComponentStyle } from '@instructure/emotion';
+import type { MenuItemProps } from '../MenuItem/props';
+import React from 'react';
 declare type MenuGroupOwnProps = {
     label: React.ReactNode;
     allowMultiple?: boolean;
+    /**
+     * children of type `Menu.Item`, `Menu.Separator`
+     */
     children?: React.ReactNode;
-    selected?: any;
-    defaultSelected?: any[];
-    onSelect?: (...args: any[]) => any;
-    onMouseOver?: (...args: any[]) => any;
-    onKeyDown?: (...args: any[]) => any;
+    /**
+     * an array of the values (or indices by default) for the selected items
+     */
+    selected?: (string | number)[];
+    /**
+     * an array of the values (or indices by default) for the selected items on initial render
+     */
+    defaultSelected?: (string | number)[];
+    /**
+     * call this function when a menu item is selected
+     */
+    onSelect?: (e: React.MouseEvent, updated: MenuItemProps['value'][], selected: MenuItemProps['selected'], item: MenuItem) => void;
+    onMouseOver?: (e: React.MouseEvent, args: MenuItem) => void;
+    /**
+     * the id of the element that the menu items will act upon
+     */
     controls?: string;
-    itemRef?: (...args: any[]) => any;
+    /**
+     * returns a reference to the `MenuItem`
+     */
+    itemRef?: (element: Element | null) => void;
     disabled?: boolean;
+    /**
+     * should the group appear in the tab order (the first item will have a tabIndex of 0)
+     */
     isTabbable?: boolean;
 };
 declare type PropKeys = keyof MenuGroupOwnProps;
@@ -21,6 +43,9 @@ declare type MenuGroupProps = MenuGroupOwnProps & WithStyleProps<MenuGroupTheme,
 declare type MenuGroupStyle = ComponentStyle<'menuItemGroup' | 'label' | 'items'>;
 declare const propTypes: PropValidators<PropKeys>;
 declare const allowedProps: AllowedPropKeys;
-export type { MenuGroupProps, MenuGroupStyle };
+declare type MenuGroupState = {
+    selected: (string | number)[];
+};
+export type { MenuGroupProps, MenuGroupStyle, MenuGroupState };
 export { propTypes, allowedProps };
 //# sourceMappingURL=props.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../../src/Menu/MenuItemGroup/props.ts"],"names":[],"mappings":";AAkCA,OAAO,KAAK,EACV,cAAc,EACd,cAAc,EACd,mBAAmB,EACpB,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1E,aAAK,iBAAiB,GAAG;IACvB,KAAK,EAAE,KAAK,CAAC,SAAS,CAAA;IACtB,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IAC1B,QAAQ,CAAC,EAAE,GAAG,CAAA;IACd,eAAe,CAAC,EAAE,GAAG,EAAE,CAAA;IACvB,QAAQ,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IAClC,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,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACjC,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,iBAAiB,CAAA;AAEvC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,cAAc,GAAG,iBAAiB,GACrC,cAAc,CAAC,cAAc,EAAE,cAAc,CAAC,GAC9C,mBAAmB,CAAC,iBAAiB,CAAC,CAAA;AAExC,aAAK,cAAc,GAAG,cAAc,CAAC,eAAe,GAAG,OAAO,GAAG,OAAO,CAAC,CAAA;AAEzE,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAkCvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAanB,CAAA;AAED,YAAY,EAAE,cAAc,EAAE,cAAc,EAAE,CAAA;AAC9C,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../../src/Menu/MenuItemGroup/props.ts"],"names":[],"mappings":"AA+BA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAGtC,OAAO,KAAK,EACV,cAAc,EACd,cAAc,EACd,mBAAmB,EACpB,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACtD,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,aAAK,iBAAiB,GAAG;IACvB,KAAK,EAAE,KAAK,CAAC,SAAS,CAAA;IACtB,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAA;IAC9B;;OAEG;IACH,eAAe,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAA;IACrC;;OAEG;IACH,QAAQ,CAAC,EAAE,CACT,CAAC,EAAE,KAAK,CAAC,UAAU,EACnB,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC,EAAE,EACjC,QAAQ,EAAE,aAAa,CAAC,UAAU,CAAC,EACnC,IAAI,EAAE,QAAQ,KACX,IAAI,CAAA;IACT,WAAW,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,UAAU,EAAE,IAAI,EAAE,QAAQ,KAAK,IAAI,CAAA;IAC3D;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IAC3C,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,iBAAiB,CAAA;AAEvC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,cAAc,GAAG,iBAAiB,GACrC,cAAc,CAAC,cAAc,EAAE,cAAc,CAAC,GAC9C,mBAAmB,CAAC,iBAAiB,CAAC,CAAA;AAExC,aAAK,cAAc,GAAG,cAAc,CAAC,eAAe,GAAG,OAAO,GAAG,OAAO,CAAC,CAAA;AAEzE,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAYvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAYnB,CAAA;AAED,aAAK,cAAc,GAAG;IACpB,QAAQ,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAA;CAC9B,CAAA;AACD,YAAY,EAAE,cAAc,EAAE,cAAc,EAAE,cAAc,EAAE,CAAA;AAC9D,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}

package/types/Menu/MenuItemSeparator/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Menu/MenuItemSeparator/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAEjC,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAQrD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAEjD;;;;;;GAMG;AACH,cAEM,iBAAkB,SAAQ,SAAS,CAAC,kBAAkB,CAAC;IAC3D,MAAM,CAAC,QAAQ,CAAC,WAAW,oBAAmB;IAE9C,MAAM,CAAC,SAAS,+EAAY;IAC5B,MAAM,CAAC,YAAY,mBAAe;IAElC,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAE9B;IAED,iBAAiB;IAKjB,kBAAkB;IAKlB,MAAM;CAWP;AAED,eAAe,iBAAiB,CAAA;AAChC,OAAO,EAAE,iBAAiB,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Menu/MenuItemSeparator/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAEjC,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAQrD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAEjD;;;;;;GAMG;AACH,cAEM,iBAAkB,SAAQ,SAAS,CAAC,kBAAkB,CAAC;IAC3D,MAAM,CAAC,QAAQ,CAAC,WAAW,oBAAmB;IAE9C,MAAM,CAAC,SAAS,+EAAY;IAC5B,MAAM,CAAC,YAAY,mBAAe;IAElC,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAE9B;IAED,iBAAiB;IAIjB,kBAAkB;IAIlB,MAAM;CAWP;AAED,eAAe,iBAAiB,CAAA;AAChC,OAAO,EAAE,iBAAiB,EAAE,CAAA"}