@sproutsocial/seeds-react-menu 1.2.1 → 1.2.3

package/src/NestedMenu/NestedMenu.feature

@@ -30,7 +30,7 @@ Feature: NestedMenu
 
     Scenario: User can select a child menu without closing the menu
         Given the NestedMenu is open
-        When an menu item that triggers a child menu is clicked
+        When a menu item that triggers a child menu is clicked
         Then the menu will stay open
         And the menu will not use its default open/close behavior
 
@@ -75,7 +75,7 @@ Feature: NestedMenu
 
     Scenario: A Menu stays open when a menu item with a childMenuId is clicked
       Given the NestedMenu is open
-      When an menu item that triggers a child menu is clicked
+      When a menu item that triggers a child menu is clicked
       Then the menu will stay open
       And the menu will not use its default open/close behavior
 

package/src/NestedMenu/NestedMenuTypes.ts

@@ -27,13 +27,16 @@ export interface TypeNestedMenuHeaderProps extends TypeMenuHeaderProps {
 }
 
 export interface TypeNestedMenuItemProps extends TypeMenuItemProps {
+  /** The id of the menu to be displayed when this item is selected. */
   childMenuId?: string;
 }
 
 export interface TypeNestedMenuProps<
   I extends TypeMenuItemProps = TypeNestedMenuItemProps
 > extends Omit<TypeActionMenuBaseProps, "MenuRootComponent"> {
+  /** The id of the menu to display when the NestedMenu is opened. */
   initialMenuId: string;
+  /** An optional callback to fire when the back button is clicked.*/
   onBackButtonClick?: (menuId: string) => void;
   /** Sets the default localized label for the back arrow in all child menus.
    *  This label can be overridden by including backArrowLabel in a menu's menuHeaderProps. */

package/src/SingleSelectMenu/SingleSelectMenu.tsx

@@ -9,12 +9,13 @@ import { MenuRoot, type TypeMenuRootProps } from "../MenuRoot";
 import type { TypeSingleSelectMenuProps } from "./SingleSelectMenuTypes";
 
 /**
- * @link https://seeds.sproutsocial.com/components/singleselect-menu/
+ * @link https://seeds.sproutsocial.com/components/single-select-menu/
  *
- * @description A SingleSelectMenu allows a single selection of a {@link https://github.com/sproutsocial/seeds/tree/dev/seeds-react/seeds-react-menu/src/MenuItem | MenuItem} from a list or groups or lists.
+ * @description A SingleSelectMenu allows a single selection of a {@link https://seeds.sproutsocial.com/components/seeds-react-menu/#menuitem MenuItem} from a list or groups or lists.
  *
- * **To trigger actions from a menu:**
- * @see {@link https://github.com/sproutsocial/seeds/tree/dev/seeds-react/seeds-react-menu/src/ActionMenu | ActionMenu}
+ * @see {@link https://seeds.sproutsocial.com/components/action-menu/ ActionMenu} for triggering actions from a menu
+ * @see {@link https://seeds.sproutsocial.com/components/multi-select-menu/ MultiSelectMenu} for selecting multiple items
+ * @see {@link https://seeds.sproutsocial.com/components/seeds-react-menu/#menugroup MenuGroup}'s isSingleSelect prop to create a single select group within a MultiSelectMenu
  */
 
 export const SingleSelectMenu = <

package/src/hooks/useItemFiltering.tsx

@@ -3,8 +3,9 @@ import type { TypeMenuContext } from "../MenuContext";
 import type { TypeInternalItemProps } from "../types";
 import { itemToString as defaultItemToString } from "../utils/downshiftDefaults";
 
+/* Receives the internal Downshift version of the item, which is different from TypeMenuItemProps*/
 export type TypeGetIsItemVisibleFn = (
-  item: TypeMenuContext["items"][number],
+  item: TypeInternalItemProps,
   inputValue: string
 ) => boolean;
 

package/src/hooks/useMenuChildren.tsx

@@ -262,7 +262,7 @@ export const useMenuChildren = <
     const menuItemsMap: TypeMenuContext["itemsMap"] = {};
     const allMenuItems: TypeMenuContext["items"] = [];
 
-    // If an menuItems prop was passed to the Menu, we can bypass the children traversal.
+    // If a menuItems prop was passed to the Menu, we can bypass the children traversal.
     if (menuItems && menuItems.length) {
       menuItems.forEach((menuItem) => {
         addMenuItem({ itemProps: menuItem, allMenuItems, menuItemsMap });

package/src/types.ts

@@ -3,7 +3,7 @@ import type { TypeMenuItemProps } from "./MenuItem";
 import type { TypeMenuGroupBaseProps } from "./MenuGroup";
 import type { TypeMenuRootOwnProps, TypeMenuRootProps } from "./MenuRoot";
 
-// The items object used internally for Menu functionality
+// The item object used internally for Menu functionality
 export interface TypeInternalItemProps<Item = TypeMenuItemProps> {
   id: string;
   index: number;
@@ -13,25 +13,38 @@ export interface TypeInternalItemProps<Item = TypeMenuItemProps> {
 }
 
 export interface TypeHigherOrderComponentProps extends TypeMenuRootOwnProps {
+  /** Overrides the default MenuRoot component. Only necessary for specialized use cases.*/
   MenuRootComponent?: React.ComponentType<TypeMenuRootProps>;
 }
 
+// Partial type, for react-docgen. Refined to the two valid configurations below.
+type TypeBaseChildrenOrItems<I extends TypeMenuItemProps = TypeMenuItemProps> =
+  {
+    /** Allows menu items to be passed in as children. Cannot be used with the menuItems prop.*/
+    children?: TypeNotEmptyChildren;
+    /** Allows menu items to be passed in as objects. Cannot be used with the children prop.
+     *  The type of each menu item, I, must be or extend TypeMenuItemProps. */
+    menuItems?: I[];
+    /** Allows a custom MenuItem component to be used when rendering using the menuItems prop.
+     *  MenuItemComponent's prop type must match the type of the menuItems, I. */
+    MenuItemComponent?: React.ComponentType<I>;
+  };
+
 export type TypeChildrenOrItems<
   I extends TypeMenuItemProps = TypeMenuItemProps
-> =
-  | {
-      /** Allows menu items to be passed in as children. Cannot be used with the items prop.*/
-      children: TypeMenuRootProps["children"];
-      menuItems?: never;
-      MenuItemComponent?: never;
-    }
-  | {
-      children?: never;
-      /** Allows menu items to be passed in as objects. Cannot be used with the children prop.*/
-      menuItems: I[];
-      /** Allows a custom MenuItem component to be used when rendering using the items prop.*/
-      MenuItemComponent?: React.ComponentType<I>;
-    };
+> = TypeBaseChildrenOrItems<I> &
+  (
+    | {
+        children: TypeNotEmptyChildren;
+        menuItems?: never;
+        MenuItemComponent?: never;
+      }
+    | {
+        children?: never;
+        menuItems: I[];
+        MenuItemComponent?: React.ComponentType<I>;
+      }
+  );
 
 export type TypeNotEmptyChildren =
   | React.ReactChild