@sproutsocial/seeds-react-menu 0.1.0 → 0.2.0

package/dist/index.d.mts

@@ -5,6 +5,7 @@ import { TypeBorderSystemProps, TypeColorSystemProps, TypeFlexboxSystemProps, Ty
 import * as styled_components from 'styled-components';
 import * as React$1 from 'react';
 import React__default, { ReactNode } from 'react';
+import { HTMLMotionProps } from 'motion/react';
 import { TypeBoxProps } from '@sproutsocial/seeds-react-box';
 export { TypeBoxProps as TypeMenuFooterProps } from '@sproutsocial/seeds-react-box';
 import * as _sproutsocial_seeds_react_text from '@sproutsocial/seeds-react-text';
@@ -34,20 +35,6 @@ type TypeNotEmptyChildren = React.ReactChild | React.ReactFragment | React.React
 
 interface TypeMenuItemStyledProps extends TypeBorderSystemProps, TypeColorSystemProps, TypeFlexboxSystemProps, TypeGridSystemProps, TypeLayoutSystemProps, TypePositionSystemProps, TypeSpaceSystemProps, TypeTypographySystemProps {
 }
-interface TypeMenuItemProps extends TypeMenuItemStyledProps, Omit<GetItemPropsOptions<TypeDefaultItemProps>, "as" | "item" | keyof TypeMenuItemStyledProps | keyof TypeDefaultItemProps>, Omit<TypeDefaultItemProps, "index"> {
-    label?: string;
-    children: React.ReactNode;
-    disabled?: boolean;
-    role?: TypeMenuItemRoles;
-    $highlighted?: boolean;
-}
-
-declare const MenuItem: ({ id, children, role, label, onClick, onKeyDown, disabled, ref, color, ...props }: TypeMenuItemProps) => react_jsx_runtime.JSX.Element;
-
-declare const MenuItemContainer: styled_components.StyledComponent<"li", styled_components.DefaultTheme, {
-    $highlighted: boolean;
-}, never>;
-
 declare const INPUT_TYPES: {
     readonly CHECKBOX: "checkbox";
     readonly RADIO: "radio";
@@ -55,30 +42,25 @@ declare const INPUT_TYPES: {
     readonly ICON: "icon";
 };
 type InputType = (typeof INPUT_TYPES)[keyof typeof INPUT_TYPES];
-interface TypeMenuItemSelectableProps extends TypeMenuItemProps {
+interface TypeMenuItemProps extends TypeMenuItemStyledProps, Omit<GetItemPropsOptions<TypeDefaultItemProps>, "as" | "item" | keyof TypeMenuItemStyledProps | keyof TypeDefaultItemProps>, Omit<TypeDefaultItemProps, "index"> {
+    children: React.ReactNode;
+    disabled?: boolean;
+    role?: TypeMenuItemRoles;
+    $highlighted?: boolean;
     active?: boolean;
     inputType?: InputType;
-    inputLabel?: string;
+    inputLabelId?: string;
 }
 
-/**
- * SelectionIndicator - handles logic for appropriate rendering of inputs
- * @returns Checkbox | Icon | Radio | Switch
- */
-declare const SelectionIndicator: ({ id, inputType, "aria-labelledby": labeledBy, selected, }: {
-    id: string;
-    "aria-labelledby": string;
-    selected: boolean;
-    inputType: InputType;
-}) => react_jsx_runtime.JSX.Element | null;
-/**
- * MenuItemSelectable - primitive with controlled input states
- */
-declare const MenuItemSelectable: ({ id, children, inputType, inputLabel, ...props }: TypeMenuItemSelectableProps) => react_jsx_runtime.JSX.Element;
+declare const MenuItem: ({ id, children, onClick, onKeyDown, disabled, ref, href, color, ...props }: TypeMenuItemProps) => react_jsx_runtime.JSX.Element;
 
-declare const MenuItemSelectableRow: styled_components.StyledComponent<"div", styled_components.DefaultTheme, {}, never>;
-declare const MenuItemSelectableAction: styled_components.StyledComponent<"div", styled_components.DefaultTheme, {}, never>;
-declare const MenuItemSelectableText: styled_components.StyledComponent<"div", styled_components.DefaultTheme, {}, never>;
+declare const MenuItemContainer: styled_components.StyledComponent<"li", styled_components.DefaultTheme, {}, never>;
+declare const StyledMenuItem: styled_components.StyledComponent<"div", styled_components.DefaultTheme, {
+    $highlighted: boolean;
+}, never>;
+declare const MenuItemRow: styled_components.StyledComponent<"div", styled_components.DefaultTheme, {}, never>;
+declare const MenuItemAction: styled_components.StyledComponent<"div", styled_components.DefaultTheme, {}, never>;
+declare const MenuItemText: styled_components.StyledComponent<"div", styled_components.DefaultTheme, {}, never>;
 
 interface TypeMenuHeaderProps extends Omit<React$1.ComponentPropsWithoutRef<"div">, "color">, TypeStyledComponentsCommonProps, TypeBorderSystemProps, TypeColorSystemProps, TypeFlexboxSystemProps, TypeGridSystemProps, TypeLayoutSystemProps, TypeSpaceSystemProps, TypePositionSystemProps {
     title?: string;
@@ -86,14 +68,50 @@ interface TypeMenuHeaderProps extends Omit<React$1.ComponentPropsWithoutRef<"div
     rightAction?: React$1.ReactNode;
 }
 
+/**
+ * @link https://seeds.sproutsocial.com/components/menu-header/
+ *
+ * @description MenuHeader is a container used to hold header content within a Menu.
+ *
+ * @see {@link https://seeds.sproutsocial.com/components/menu-footer/ | MenuFooter}
+ */
 declare const MenuHeader: ({ children, title, leftAction, rightAction, ...rest }: TypeMenuHeaderProps) => react_jsx_runtime.JSX.Element;
 
-interface TypeMenuContentProps extends React__default.ButtonHTMLAttributes<HTMLUListElement> {
+interface TypeMenuContentProps extends HTMLMotionProps<"ul"> {
     children: ReactNode;
 }
 
+/**
+ * @link https://seeds.sproutsocial.com/components/menu-content/
+ *
+ * @description MenuContent is used to contain lists or grouped lists of {@link https://github.com/sproutsocial/seeds/tree/dev/seeds-react/seeds-react-menu/src/MenuItem | MenuItems}.
+ *
+ * @example
+ * <ActionMenu>
+ *   <MenuHeader>Header</MenuHeader>
+ *   <MenuContent>
+ *     <MenuGroup>
+ *       <MenuItem>Item 1</MenuItem>
+ *     </MenuGroup>
+ *     <MenuGroup>
+ *       <MenuItem>Item 2</MenuItem>
+ *     </MenuGroup>
+ *   </MenuContent>
+ *   <MenuFooter>Footer</MenuFooter>
+ * </ActionMenu>
+ *
+ * @see {@link https://seeds.sproutsocial.com/components/menu-item/ | MenuItem}
+ * @see {@link https://seeds.sproutsocial.com/components/menu-group/ | MenuGroup}
+ */
 declare const MenuContent: ({ id, children, ...rest }: TypeMenuContentProps) => react_jsx_runtime.JSX.Element;
 
+/**
+ * @link https://seeds.sproutsocial.com/components/menu-footer/
+ *
+ * @description MenuFooter is a container used to hold footer content within a Menu.
+ *
+ * @see {@link https://seeds.sproutsocial.com/components/menu-header/ | MenuHeader}
+ */
 declare const MenuFooter: ({ children, ...rest }: TypeBoxProps) => react_jsx_runtime.JSX.Element;
 
 interface TypeMenuGroupStyledProps extends TypeBorderSystemProps, TypeColorSystemProps, TypeFlexboxSystemProps, TypeGridSystemProps, TypeLayoutSystemProps, TypePositionSystemProps, TypeSpaceSystemProps, TypeTypographySystemProps {
@@ -104,6 +122,25 @@ interface TypeMenuGroupProps extends TypeMenuGroupStyledProps, Omit<React.Compon
     titleAs?: string | React.ComponentType<any>;
 }
 
+/**
+ * @link https://seeds.sproutsocial.com/components/menu-group/
+ *
+ * @description MenuGroup is used to group lists of {@link https://github.com/sproutsocial/seeds/tree/dev/seeds-react/seeds-react-menu/src/MenuItem | MenuItems}.
+ *
+ * @example
+ * <ActionMenu>
+ *   <MenuContent>
+ *     <MenuGroup title="Group 1">
+ *       <MenuItem>Item 1</MenuItem>
+ *     </MenuGroup>
+ *     <MenuGroup title="Group 1">
+ *       <MenuItem>Item 2</MenuItem>
+ *     </MenuGroup>
+ *   </MenuContent>
+ * </ActionMenu>
+ *
+ * @see {@link https://seeds.sproutsocial.com/components/menu-item/ | MenuItem}
+ */
 declare const MenuGroup: ({ titleAs, children, title, color, ...rest }: TypeMenuGroupProps) => react_jsx_runtime.JSX.Element;
 
 declare const StyledMenuGroup: styled_components.StyledComponent<"li", styled_components.DefaultTheme, TypeMenuGroupProps, never>;
@@ -145,13 +182,18 @@ declare const MenuProvider: ({ children, ...overrides }: TypeMenuProviderProps)
 declare const useMenuContext: () => TypeMenuContext;
 
 interface TypeMenuRootOwnProps {
-    triggerElement: React__default.ReactElement<any>;
+    menuToggleElement: React__default.ReactElement<any>;
     popoutProps?: Partial<Omit<TypePopoutProps, "isOpen" | "setIsOpen" | "content" | "children">>;
     width?: TypePopoutProps["width"];
 }
 interface TypeMenuRootProps extends Partial<TypeMenuProviderProps>, TypeMenuRootOwnProps {
 }
-declare const MenuRoot: ({ children, triggerElement, popoutProps, width, ...contextProps }: TypeMenuRootProps) => react_jsx_runtime.JSX.Element;
+/**
+ * @link https://seeds.sproutsocial.com/components/menu-root/
+ *
+ * @description MenuRoot is a utility component used to handle {@link https://github.com/sproutsocial/seeds/blob/dev/seeds-react/seeds-react-menu/src/MenuContext.tsx | MenuContext}. This component should rarely, if ever, be used directly unless building a custom menu type.
+ */
+declare const MenuRoot: ({ children, menuToggleElement, popoutProps, width, ...contextProps }: TypeMenuRootProps) => react_jsx_runtime.JSX.Element;
 
 declare const MenuLabel: ({ children, ...rest }: TypeTextProps) => react_jsx_runtime.JSX.Element;
 
@@ -164,18 +206,42 @@ type TypeInvalidMenuProps = "initialSelectedItem" | "defaultSelectedItem" | "sel
 interface TypeActionMenuProps extends TypeMenuRootOwnProps, Partial<Omit<UseSelectProps<TypeDefaultItemProps>, TypeInvalidMenuProps>> {
     children: TypeMenuRootProps["children"];
 }
+/**
+ * @link https://seeds.sproutsocial.com/components/action-menu/
+ *
+ * @description An ActionMenu contains a list of clickable items like buttons or links. ActionMenus do not hold a selection.
+ *
+ * **To select menu items:**
+ * @see {@link https://github.com/sproutsocial/seeds/tree/dev/seeds-react/seeds-react-menu/src/SingleSelectMenu | SingleSelectMenu}
+ * @see {@link https://github.com/sproutsocial/seeds/tree/dev/seeds-react/seeds-react-menu/src/MultiSelectMenu | MultiSelectMenu}
+ */
 declare const ActionMenu: ({ children, stateReducer: externalStateReducer, ...useSelectProps }: TypeActionMenuProps) => react_jsx_runtime.JSX.Element;
 
 interface TypeSingleSelectMenuProps extends TypeMenuRootOwnProps, Partial<UseSelectProps<TypeDefaultItemProps>> {
     children: TypeMenuRootProps["children"];
 }
 
+/**
+ * @link https://seeds.sproutsocial.com/components/singleselect-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.
+ *
+ * **To trigger actions from a menu:**
+ * @see {@link https://github.com/sproutsocial/seeds/tree/dev/seeds-react/seeds-react-menu/src/ActionMenu | ActionMenu}
+ */
 declare const SingleSelectMenu: ({ children, stateReducer: externalStateReducer, ...useSelectProps }: TypeSingleSelectMenuProps) => react_jsx_runtime.JSX.Element;
 
 interface TypeMultiSelectMenuProps extends TypeMenuRootOwnProps, TypeDownshiftMultiSelectProps {
     children: TypeMenuRootProps["children"];
 }
 
+/**
+ * @link https://seeds.sproutsocial.com/components/multiselect-menu/
+ *
+ * @description A MultiSelectMenu allows multiple {@link https://github.com/sproutsocial/seeds/tree/dev/seeds-react/seeds-react-menu/src/MenuItem | MenuItems} to be selected from a list or groups of lists.
+ *
+ * @see {@link https://seeds.sproutsocial.com/components/menu-group/ | MenuGroup}
+ */
 declare const MultiSelectMenu: ({ children, stateReducer: externalStateReducer, getA11yMultiStatusMessage, onMultiSelectStateChange, multiSelectStateReducer, ...useSelectProps }: TypeMultiSelectMenuProps) => react_jsx_runtime.JSX.Element;
 
 interface TypeUseItemsFromChildrenProps {
@@ -194,4 +260,4 @@ declare const defaultUseSelectProps: {
     isItemDisabled: (item: any) => boolean;
 };
 
-export { ActionMenu, INPUT_TYPES, type InputType, MenuContent, MenuContext, MenuFooter, MenuGroup, MenuHeader, MenuItem, MenuItemContainer, MenuItemSelectable, MenuItemSelectableAction, MenuItemSelectableRow, MenuItemSelectableText, MenuLabel, MenuProvider, MenuRoot, MenuToggleButton, MultiSelectMenu, SelectionIndicator, SingleSelectMenu, StyledMenuGroup, StyledMenuGroupUl, StyledTitle, type TypeActionMenuProps, type TypeDownshiftMultiSelectProps, type TypeMenuContentProps, type TypeMenuContext, type TypeMenuContextProps, type TypeMenuGroupProps, type TypeMenuGroupStyledProps, type TypeMenuHeaderProps, type TypeMenuItemProps, type TypeMenuItemSelectableProps, type TypeMenuItemStyledProps, type TypeMenuProviderProps, type TypeMenuRootOwnProps, type TypeMenuRootProps, type TypeMenuToggleButtonProps, type TypeSingleSelectMenuProps, type TypeUseItemsFromChildrenProps, defaultUseSelectProps, useItemsFromChildren, useMenu, useMenuContext, useSelectStateReducer };
+export { ActionMenu, INPUT_TYPES, type InputType, MenuContent, MenuContext, MenuFooter, MenuGroup, MenuHeader, MenuItem, MenuItemAction, MenuItemContainer, MenuItemRow, MenuItemText, MenuLabel, MenuProvider, MenuRoot, MenuToggleButton, MultiSelectMenu, SingleSelectMenu, StyledMenuGroup, StyledMenuGroupUl, StyledMenuItem, StyledTitle, type TypeActionMenuProps, type TypeDownshiftMultiSelectProps, type TypeMenuContentProps, type TypeMenuContext, type TypeMenuContextProps, type TypeMenuGroupProps, type TypeMenuGroupStyledProps, type TypeMenuHeaderProps, type TypeMenuItemProps, type TypeMenuItemStyledProps, type TypeMenuProviderProps, type TypeMenuRootOwnProps, type TypeMenuRootProps, type TypeMenuToggleButtonProps, type TypeSingleSelectMenuProps, type TypeUseItemsFromChildrenProps, defaultUseSelectProps, useItemsFromChildren, useMenu, useMenuContext, useSelectStateReducer };

package/dist/index.d.ts

@@ -5,6 +5,7 @@ import { TypeBorderSystemProps, TypeColorSystemProps, TypeFlexboxSystemProps, Ty
 import * as styled_components from 'styled-components';
 import * as React$1 from 'react';
 import React__default, { ReactNode } from 'react';
+import { HTMLMotionProps } from 'motion/react';
 import { TypeBoxProps } from '@sproutsocial/seeds-react-box';
 export { TypeBoxProps as TypeMenuFooterProps } from '@sproutsocial/seeds-react-box';
 import * as _sproutsocial_seeds_react_text from '@sproutsocial/seeds-react-text';
@@ -34,20 +35,6 @@ type TypeNotEmptyChildren = React.ReactChild | React.ReactFragment | React.React
 
 interface TypeMenuItemStyledProps extends TypeBorderSystemProps, TypeColorSystemProps, TypeFlexboxSystemProps, TypeGridSystemProps, TypeLayoutSystemProps, TypePositionSystemProps, TypeSpaceSystemProps, TypeTypographySystemProps {
 }
-interface TypeMenuItemProps extends TypeMenuItemStyledProps, Omit<GetItemPropsOptions<TypeDefaultItemProps>, "as" | "item" | keyof TypeMenuItemStyledProps | keyof TypeDefaultItemProps>, Omit<TypeDefaultItemProps, "index"> {
-    label?: string;
-    children: React.ReactNode;
-    disabled?: boolean;
-    role?: TypeMenuItemRoles;
-    $highlighted?: boolean;
-}
-
-declare const MenuItem: ({ id, children, role, label, onClick, onKeyDown, disabled, ref, color, ...props }: TypeMenuItemProps) => react_jsx_runtime.JSX.Element;
-
-declare const MenuItemContainer: styled_components.StyledComponent<"li", styled_components.DefaultTheme, {
-    $highlighted: boolean;
-}, never>;
-
 declare const INPUT_TYPES: {
     readonly CHECKBOX: "checkbox";
     readonly RADIO: "radio";
@@ -55,30 +42,25 @@ declare const INPUT_TYPES: {
     readonly ICON: "icon";
 };
 type InputType = (typeof INPUT_TYPES)[keyof typeof INPUT_TYPES];
-interface TypeMenuItemSelectableProps extends TypeMenuItemProps {
+interface TypeMenuItemProps extends TypeMenuItemStyledProps, Omit<GetItemPropsOptions<TypeDefaultItemProps>, "as" | "item" | keyof TypeMenuItemStyledProps | keyof TypeDefaultItemProps>, Omit<TypeDefaultItemProps, "index"> {
+    children: React.ReactNode;
+    disabled?: boolean;
+    role?: TypeMenuItemRoles;
+    $highlighted?: boolean;
     active?: boolean;
     inputType?: InputType;
-    inputLabel?: string;
+    inputLabelId?: string;
 }
 
-/**
- * SelectionIndicator - handles logic for appropriate rendering of inputs
- * @returns Checkbox | Icon | Radio | Switch
- */
-declare const SelectionIndicator: ({ id, inputType, "aria-labelledby": labeledBy, selected, }: {
-    id: string;
-    "aria-labelledby": string;
-    selected: boolean;
-    inputType: InputType;
-}) => react_jsx_runtime.JSX.Element | null;
-/**
- * MenuItemSelectable - primitive with controlled input states
- */
-declare const MenuItemSelectable: ({ id, children, inputType, inputLabel, ...props }: TypeMenuItemSelectableProps) => react_jsx_runtime.JSX.Element;
+declare const MenuItem: ({ id, children, onClick, onKeyDown, disabled, ref, href, color, ...props }: TypeMenuItemProps) => react_jsx_runtime.JSX.Element;
 
-declare const MenuItemSelectableRow: styled_components.StyledComponent<"div", styled_components.DefaultTheme, {}, never>;
-declare const MenuItemSelectableAction: styled_components.StyledComponent<"div", styled_components.DefaultTheme, {}, never>;
-declare const MenuItemSelectableText: styled_components.StyledComponent<"div", styled_components.DefaultTheme, {}, never>;
+declare const MenuItemContainer: styled_components.StyledComponent<"li", styled_components.DefaultTheme, {}, never>;
+declare const StyledMenuItem: styled_components.StyledComponent<"div", styled_components.DefaultTheme, {
+    $highlighted: boolean;
+}, never>;
+declare const MenuItemRow: styled_components.StyledComponent<"div", styled_components.DefaultTheme, {}, never>;
+declare const MenuItemAction: styled_components.StyledComponent<"div", styled_components.DefaultTheme, {}, never>;
+declare const MenuItemText: styled_components.StyledComponent<"div", styled_components.DefaultTheme, {}, never>;
 
 interface TypeMenuHeaderProps extends Omit<React$1.ComponentPropsWithoutRef<"div">, "color">, TypeStyledComponentsCommonProps, TypeBorderSystemProps, TypeColorSystemProps, TypeFlexboxSystemProps, TypeGridSystemProps, TypeLayoutSystemProps, TypeSpaceSystemProps, TypePositionSystemProps {
     title?: string;
@@ -86,14 +68,50 @@ interface TypeMenuHeaderProps extends Omit<React$1.ComponentPropsWithoutRef<"div
     rightAction?: React$1.ReactNode;
 }
 
+/**
+ * @link https://seeds.sproutsocial.com/components/menu-header/
+ *
+ * @description MenuHeader is a container used to hold header content within a Menu.
+ *
+ * @see {@link https://seeds.sproutsocial.com/components/menu-footer/ | MenuFooter}
+ */
 declare const MenuHeader: ({ children, title, leftAction, rightAction, ...rest }: TypeMenuHeaderProps) => react_jsx_runtime.JSX.Element;
 
-interface TypeMenuContentProps extends React__default.ButtonHTMLAttributes<HTMLUListElement> {
+interface TypeMenuContentProps extends HTMLMotionProps<"ul"> {
     children: ReactNode;
 }
 
+/**
+ * @link https://seeds.sproutsocial.com/components/menu-content/
+ *
+ * @description MenuContent is used to contain lists or grouped lists of {@link https://github.com/sproutsocial/seeds/tree/dev/seeds-react/seeds-react-menu/src/MenuItem | MenuItems}.
+ *
+ * @example
+ * <ActionMenu>
+ *   <MenuHeader>Header</MenuHeader>
+ *   <MenuContent>
+ *     <MenuGroup>
+ *       <MenuItem>Item 1</MenuItem>
+ *     </MenuGroup>
+ *     <MenuGroup>
+ *       <MenuItem>Item 2</MenuItem>
+ *     </MenuGroup>
+ *   </MenuContent>
+ *   <MenuFooter>Footer</MenuFooter>
+ * </ActionMenu>
+ *
+ * @see {@link https://seeds.sproutsocial.com/components/menu-item/ | MenuItem}
+ * @see {@link https://seeds.sproutsocial.com/components/menu-group/ | MenuGroup}
+ */
 declare const MenuContent: ({ id, children, ...rest }: TypeMenuContentProps) => react_jsx_runtime.JSX.Element;
 
+/**
+ * @link https://seeds.sproutsocial.com/components/menu-footer/
+ *
+ * @description MenuFooter is a container used to hold footer content within a Menu.
+ *
+ * @see {@link https://seeds.sproutsocial.com/components/menu-header/ | MenuHeader}
+ */
 declare const MenuFooter: ({ children, ...rest }: TypeBoxProps) => react_jsx_runtime.JSX.Element;
 
 interface TypeMenuGroupStyledProps extends TypeBorderSystemProps, TypeColorSystemProps, TypeFlexboxSystemProps, TypeGridSystemProps, TypeLayoutSystemProps, TypePositionSystemProps, TypeSpaceSystemProps, TypeTypographySystemProps {
@@ -104,6 +122,25 @@ interface TypeMenuGroupProps extends TypeMenuGroupStyledProps, Omit<React.Compon
     titleAs?: string | React.ComponentType<any>;
 }
 
+/**
+ * @link https://seeds.sproutsocial.com/components/menu-group/
+ *
+ * @description MenuGroup is used to group lists of {@link https://github.com/sproutsocial/seeds/tree/dev/seeds-react/seeds-react-menu/src/MenuItem | MenuItems}.
+ *
+ * @example
+ * <ActionMenu>
+ *   <MenuContent>
+ *     <MenuGroup title="Group 1">
+ *       <MenuItem>Item 1</MenuItem>
+ *     </MenuGroup>
+ *     <MenuGroup title="Group 1">
+ *       <MenuItem>Item 2</MenuItem>
+ *     </MenuGroup>
+ *   </MenuContent>
+ * </ActionMenu>
+ *
+ * @see {@link https://seeds.sproutsocial.com/components/menu-item/ | MenuItem}
+ */
 declare const MenuGroup: ({ titleAs, children, title, color, ...rest }: TypeMenuGroupProps) => react_jsx_runtime.JSX.Element;
 
 declare const StyledMenuGroup: styled_components.StyledComponent<"li", styled_components.DefaultTheme, TypeMenuGroupProps, never>;
@@ -145,13 +182,18 @@ declare const MenuProvider: ({ children, ...overrides }: TypeMenuProviderProps)
 declare const useMenuContext: () => TypeMenuContext;
 
 interface TypeMenuRootOwnProps {
-    triggerElement: React__default.ReactElement<any>;
+    menuToggleElement: React__default.ReactElement<any>;
     popoutProps?: Partial<Omit<TypePopoutProps, "isOpen" | "setIsOpen" | "content" | "children">>;
     width?: TypePopoutProps["width"];
 }
 interface TypeMenuRootProps extends Partial<TypeMenuProviderProps>, TypeMenuRootOwnProps {
 }
-declare const MenuRoot: ({ children, triggerElement, popoutProps, width, ...contextProps }: TypeMenuRootProps) => react_jsx_runtime.JSX.Element;
+/**
+ * @link https://seeds.sproutsocial.com/components/menu-root/
+ *
+ * @description MenuRoot is a utility component used to handle {@link https://github.com/sproutsocial/seeds/blob/dev/seeds-react/seeds-react-menu/src/MenuContext.tsx | MenuContext}. This component should rarely, if ever, be used directly unless building a custom menu type.
+ */
+declare const MenuRoot: ({ children, menuToggleElement, popoutProps, width, ...contextProps }: TypeMenuRootProps) => react_jsx_runtime.JSX.Element;
 
 declare const MenuLabel: ({ children, ...rest }: TypeTextProps) => react_jsx_runtime.JSX.Element;
 
@@ -164,18 +206,42 @@ type TypeInvalidMenuProps = "initialSelectedItem" | "defaultSelectedItem" | "sel
 interface TypeActionMenuProps extends TypeMenuRootOwnProps, Partial<Omit<UseSelectProps<TypeDefaultItemProps>, TypeInvalidMenuProps>> {
     children: TypeMenuRootProps["children"];
 }
+/**
+ * @link https://seeds.sproutsocial.com/components/action-menu/
+ *
+ * @description An ActionMenu contains a list of clickable items like buttons or links. ActionMenus do not hold a selection.
+ *
+ * **To select menu items:**
+ * @see {@link https://github.com/sproutsocial/seeds/tree/dev/seeds-react/seeds-react-menu/src/SingleSelectMenu | SingleSelectMenu}
+ * @see {@link https://github.com/sproutsocial/seeds/tree/dev/seeds-react/seeds-react-menu/src/MultiSelectMenu | MultiSelectMenu}
+ */
 declare const ActionMenu: ({ children, stateReducer: externalStateReducer, ...useSelectProps }: TypeActionMenuProps) => react_jsx_runtime.JSX.Element;
 
 interface TypeSingleSelectMenuProps extends TypeMenuRootOwnProps, Partial<UseSelectProps<TypeDefaultItemProps>> {
     children: TypeMenuRootProps["children"];
 }
 
+/**
+ * @link https://seeds.sproutsocial.com/components/singleselect-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.
+ *
+ * **To trigger actions from a menu:**
+ * @see {@link https://github.com/sproutsocial/seeds/tree/dev/seeds-react/seeds-react-menu/src/ActionMenu | ActionMenu}
+ */
 declare const SingleSelectMenu: ({ children, stateReducer: externalStateReducer, ...useSelectProps }: TypeSingleSelectMenuProps) => react_jsx_runtime.JSX.Element;
 
 interface TypeMultiSelectMenuProps extends TypeMenuRootOwnProps, TypeDownshiftMultiSelectProps {
     children: TypeMenuRootProps["children"];
 }
 
+/**
+ * @link https://seeds.sproutsocial.com/components/multiselect-menu/
+ *
+ * @description A MultiSelectMenu allows multiple {@link https://github.com/sproutsocial/seeds/tree/dev/seeds-react/seeds-react-menu/src/MenuItem | MenuItems} to be selected from a list or groups of lists.
+ *
+ * @see {@link https://seeds.sproutsocial.com/components/menu-group/ | MenuGroup}
+ */
 declare const MultiSelectMenu: ({ children, stateReducer: externalStateReducer, getA11yMultiStatusMessage, onMultiSelectStateChange, multiSelectStateReducer, ...useSelectProps }: TypeMultiSelectMenuProps) => react_jsx_runtime.JSX.Element;
 
 interface TypeUseItemsFromChildrenProps {
@@ -194,4 +260,4 @@ declare const defaultUseSelectProps: {
     isItemDisabled: (item: any) => boolean;
 };
 
-export { ActionMenu, INPUT_TYPES, type InputType, MenuContent, MenuContext, MenuFooter, MenuGroup, MenuHeader, MenuItem, MenuItemContainer, MenuItemSelectable, MenuItemSelectableAction, MenuItemSelectableRow, MenuItemSelectableText, MenuLabel, MenuProvider, MenuRoot, MenuToggleButton, MultiSelectMenu, SelectionIndicator, SingleSelectMenu, StyledMenuGroup, StyledMenuGroupUl, StyledTitle, type TypeActionMenuProps, type TypeDownshiftMultiSelectProps, type TypeMenuContentProps, type TypeMenuContext, type TypeMenuContextProps, type TypeMenuGroupProps, type TypeMenuGroupStyledProps, type TypeMenuHeaderProps, type TypeMenuItemProps, type TypeMenuItemSelectableProps, type TypeMenuItemStyledProps, type TypeMenuProviderProps, type TypeMenuRootOwnProps, type TypeMenuRootProps, type TypeMenuToggleButtonProps, type TypeSingleSelectMenuProps, type TypeUseItemsFromChildrenProps, defaultUseSelectProps, useItemsFromChildren, useMenu, useMenuContext, useSelectStateReducer };
+export { ActionMenu, INPUT_TYPES, type InputType, MenuContent, MenuContext, MenuFooter, MenuGroup, MenuHeader, MenuItem, MenuItemAction, MenuItemContainer, MenuItemRow, MenuItemText, MenuLabel, MenuProvider, MenuRoot, MenuToggleButton, MultiSelectMenu, SingleSelectMenu, StyledMenuGroup, StyledMenuGroupUl, StyledMenuItem, StyledTitle, type TypeActionMenuProps, type TypeDownshiftMultiSelectProps, type TypeMenuContentProps, type TypeMenuContext, type TypeMenuContextProps, type TypeMenuGroupProps, type TypeMenuGroupStyledProps, type TypeMenuHeaderProps, type TypeMenuItemProps, type TypeMenuItemStyledProps, type TypeMenuProviderProps, type TypeMenuRootOwnProps, type TypeMenuRootProps, type TypeMenuToggleButtonProps, type TypeSingleSelectMenuProps, type TypeUseItemsFromChildrenProps, defaultUseSelectProps, useItemsFromChildren, useMenu, useMenuContext, useSelectStateReducer };