@sproutsocial/seeds-react-menu 1.2.0 → 1.2.2

package/dist/index.d.mts

@@ -6,7 +6,7 @@ import * as _sproutsocial_seeds_react_box from '@sproutsocial/seeds-react-box';
 import { TypeBoxProps } from '@sproutsocial/seeds-react-box';
 export { TypeBoxProps as TypeMenuFooterProps } from '@sproutsocial/seeds-react-box';
 import * as React$1 from 'react';
-import React__default, { ReactNode } from 'react';
+import React__default from 'react';
 import { TypePopoutProps } from '@sproutsocial/seeds-react-popout';
 import { TypeTokenInputProps, TypeTokenSpec } from '@sproutsocial/seeds-react-token-input';
 import * as _sproutsocial_seeds_react_text from '@sproutsocial/seeds-react-text';
@@ -34,9 +34,9 @@ interface TypeMenuGroupBaseProps extends TypeMenuGroupStyledProps, Omit<React.Co
 type TypeMenuGroupProps<I extends TypeMenuItemProps = TypeMenuItemProps> = TypeMenuGroupBaseProps & TypeChildrenOrItems<I>;
 
 /**
- * @link https://seeds.sproutsocial.com/components/menu-group/
+ * @link https://seeds.sproutsocial.com/components/seeds-react-menu/#menugroup
  *
- * @description MenuGroup is used to group lists of {@link https://github.com/sproutsocial/seeds/tree/dev/seeds-react/seeds-react-menu/src/MenuItem | MenuItems}.
+ * @description MenuGroup is used to group lists of {@link https://seeds.sproutsocial.com/components/seeds-react-menu/#menuitem MenuItems}.
  *
  * @example
  * <ActionMenu>
@@ -50,7 +50,8 @@ type TypeMenuGroupProps<I extends TypeMenuItemProps = TypeMenuItemProps> = TypeM
  *   </MenuContent>
  * </ActionMenu>
  *
- * @see {@link https://seeds.sproutsocial.com/components/menu-item/ | MenuItem}
+ * @see {@link https://seeds.sproutsocial.com/components/seeds-react-menu/#menuitem MenuItem}
+ * @see {@link https://seeds.sproutsocial.com/components/seeds-react-menu/#menucontent MenuContent}
  */
 declare const MenuGroup: {
     <I extends TypeMenuItemProps = TypeMenuItemProps>({ titleAs, children: childrenProp, title, color, isSingleSelect, id, menuItems, MenuItemComponent, ...rest }: TypeMenuGroupProps<I>): react_jsx_runtime.JSX.Element | null;
@@ -66,8 +67,11 @@ interface TypeDownshiftComboboxProps extends Partial<UseComboboxProps<TypeIntern
 interface TypeDownshiftSelectProps extends Partial<UseSelectProps<TypeInternalItemProps>> {
 }
 interface TypeDownshiftMultiSelectProps extends Partial<Omit<UseMultipleSelectionProps<TypeInternalItemProps>, "stateReducer" | "onStateChange" | "getA11yStatusMessage">> {
+    /** Optional override to the built-in getA11yStatusMessage function for multiple selection*/
     getA11yMultiStatusMessage?: UseMultipleSelectionProps<TypeInternalItemProps>["getA11yStatusMessage"];
+    /** Optional override to the built-in onStateChange function for multiple selection*/
     onMultiSelectStateChange?: UseMultipleSelectionProps<TypeInternalItemProps>["onStateChange"];
+    /** Optional override to the built-in stateReducer function for multiple selection*/
     multiSelectStateReducer?: UseMultipleSelectionProps<TypeInternalItemProps>["stateReducer"];
 }
 interface TypeDownshiftComboboxReturnValue extends Partial<UseComboboxReturnValue<TypeInternalItemProps>> {
@@ -122,7 +126,7 @@ interface TypeMenuProviderProps {
     menuContext: TypeMenuContext;
 }
 interface TypeMenuToggleContext extends TypeMenuContext {
-    ref?: (arg0: React__default.ElementRef<any> | HTMLElement) => void;
+    ref?: React__default.RefObject<any> | ((arg0: React__default.ElementRef<any> | HTMLElement) => void);
     toggle?: () => void;
     show?: () => void;
     hide?: () => void;
@@ -175,8 +179,14 @@ declare const MenuContentProvider: ({ children, menuContext, }: TypeMenuProvider
 declare const useMenuContentContext: () => TypeMenuContext;
 
 interface TypeMenuRootOwnProps {
+    /** The element that is or contains an element that will toggle the menu when clicked.
+     *  May contain labels, buttons, inputs or other content as needed. */
     menuToggleElement: React__default.ReactElement<any>;
+    /** Props to pass through to the underlying Popout.
+     *  Any Popout prop is valid except those explicitly omitted. */
     popoutProps?: Partial<Omit<TypePopoutProps, "isOpen" | "setIsOpen" | "content" | "children">>;
+    /** The width of the Popout content.
+     *  Defaults to 200px or the width of the toggle element, whichever is greater.*/
     width?: TypePopoutProps["width"];
 }
 interface TypeMenuRootProps extends Partial<TypeMenuContextProps>, Pick<TypeMenuProviderProps, "children">, TypeMenuRootOwnProps {
@@ -189,12 +199,9 @@ interface TypeMenuPopoutProps extends Pick<Partial<TypeMenuContextProps>, "openM
 }
 declare const MenuPopout: ({ content, width, isOpen, openMenu, closeMenu, focusLockProps, ...popoutProps }: TypeMenuPopoutProps) => 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.
+ * @description MenuRoot is a utility component used to handle React Context for our Menus. This component should rarely, if ever, be used directly unless building a custom menu type.
  */
 declare const MenuRoot: ({ children, menuToggleElement, popoutProps: { placement, focusLockProps, ...popoutProps }, width, ...contextProps }: TypeMenuRootProps) => react_jsx_runtime.JSX.Element;
-declare const MenuRootNoPopout: ({ children, menuToggleElement, ...contextProps }: TypeMenuRootProps) => react_jsx_runtime.JSX.Element;
 
 interface TypeInternalItemProps<Item = TypeMenuItemProps> {
     id: string;
@@ -204,20 +211,28 @@ interface TypeInternalItemProps<Item = TypeMenuItemProps> {
     menuGroupProps?: TypeMenuGroupBaseProps;
 }
 interface TypeHigherOrderComponentProps extends TypeMenuRootOwnProps {
+    /** Overrides the default MenuRoot component. Only necessary for specialized use cases.*/
     MenuRootComponent?: React.ComponentType<TypeMenuRootProps>;
 }
-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"];
+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>;
+};
+type TypeChildrenOrItems<I extends TypeMenuItemProps = TypeMenuItemProps> = TypeBaseChildrenOrItems<I> & ({
+    children: TypeNotEmptyChildren;
     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>;
-};
+});
 type TypeNotEmptyChildren = React.ReactChild | React.ReactFragment | React.ReactPortal;
 type TypeInputEventListeners = "onKeyDown" | "onChange" | "onInput" | "onBlur" | "onClick" | "refKey";
 type TypeDownshiftMergedInputProps<B> = Pick<UseComboboxGetInputPropsOptions, TypeInputEventListeners> & Omit<Partial<B>, TypeInputEventListeners>;
@@ -265,11 +280,13 @@ interface TypeMenuHeaderProps extends Omit<React$1.ComponentPropsWithoutRef<"div
 }
 
 /**
- * @link https://seeds.sproutsocial.com/components/menu-header/
+ * @link https://seeds.sproutsocial.com/components/seeds-react-menu/#menuheader
  *
  * @description MenuHeader is a container used to hold header content within a Menu.
  *
- * @see {@link https://seeds.sproutsocial.com/components/menu-footer/ | MenuFooter}
+ * @see {@link https://seeds.sproutsocial.com/components/seeds-react-menu/#menufooter MenuFooter}
+ * @see {@link https://seeds.sproutsocial.com/components/seeds-react-menu/#menusearchinput MenuSearchInput}
+ * @see {@link https://seeds.sproutsocial.com/components/seeds-react-menu/#menusearchtokeninput MenuSearchTokenInput}
  */
 declare const MenuHeader: ({ children, title, leftAction, rightAction, ...rest }: TypeMenuHeaderProps) => react_jsx_runtime.JSX.Element;
 
@@ -278,9 +295,9 @@ type TypeMenuContentProps<I extends TypeMenuItemProps = TypeMenuItemProps> = Omi
 } & TypeChildrenOrItems<I>;
 
 /**
- * @link https://seeds.sproutsocial.com/components/menu-content/
+ * @link https://seeds.sproutsocial.com/components/seeds-react-menu/#menucontent
  *
- * @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}.
+ * @description MenuContent is used to contain lists or grouped lists of {@link https://seeds.sproutsocial.com/components/seeds-react-menu/#menuitem MenuItems}.
  *
  * @example
  * <ActionMenu>
@@ -296,8 +313,8 @@ type TypeMenuContentProps<I extends TypeMenuItemProps = TypeMenuItemProps> = Omi
  *   <MenuFooter>Footer</MenuFooter>
  * </ActionMenu>
  *
- * @see {@link https://seeds.sproutsocial.com/components/menu-item/ | MenuItem}
- * @see {@link https://seeds.sproutsocial.com/components/menu-group/ | MenuGroup}
+ * @see {@link https://seeds.sproutsocial.com/components/seeds-react-menu/#menuitem MenuItem}
+ * @see {@link https://seeds.sproutsocial.com/components/seeds-react-menu/#menugroup MenuGroup}
  */
 declare const MenuContent: {
     <I extends TypeMenuItemProps = TypeMenuItemProps>({ id, children: childrenProp, menuItems, MenuItemComponent, onKeyDown, innerRef, ...rest }: TypeMenuContentProps<I>): react_jsx_runtime.JSX.Element | null;
@@ -305,54 +322,87 @@ declare const MenuContent: {
 };
 
 /**
- * @link https://seeds.sproutsocial.com/components/menu-footer/
+ * @link https://seeds.sproutsocial.com/components/seeds-react-menu/#menufooter
  *
  * @description MenuFooter is a container used to hold footer content within a Menu.
  *
- * @see {@link https://seeds.sproutsocial.com/components/menu-header/ | MenuHeader}
+ * @see {@link https://seeds.sproutsocial.com/components/seeds-react-menu/#menuheader MenuHeader}
  */
 declare const MenuFooter: ({ children, ...rest }: TypeBoxProps) => react_jsx_runtime.JSX.Element;
 
-declare const MenuLabel: ({ children, ...rest }: Partial<TypeLabelProps>) => react_jsx_runtime.JSX.Element;
+interface TypeMenuLabelProps extends Omit<TypeLabelProps, "htmlFor"> {
+    children: React__default.ReactNode;
+    /** Whether making a selection in the associated menu is required. */
+    required?: boolean;
+    /** ID of the associated form element. This prop is never valid to pass into MenuLabel
+     *  because MenuLabel passes its own htmlFor prop to the underlying Label component.*/
+    htmlFor?: never;
+}
+/**
+ * @link https://seeds.sproutsocial.com/components/seeds-react-menu/#menulabel
+ *
+ * @description MenuLabel extends Label to create an accessible label for a Menu's toggle element.
+ * A MenuLabel will automatically be associated with the corresponding menuToggleElement,
+ * so an `htmlFor` prop is not necessary or allowed.
+ *
+ * @see {@link https://seeds.sproutsocial.com/components/seeds-react-menu/#menutogglebutton MenuToggleButton}
+ * @see {@link https://seeds.sproutsocial.com/components/label/ Label}
+ */
+declare const MenuLabel: ({ children, required, ...rest }: TypeMenuLabelProps) => react_jsx_runtime.JSX.Element;
 
-interface TypeMenuToggleButtonProps extends Partial<TypeButtonProps> {
-    children: ReactNode;
+interface TypeMenuToggleButtonProps extends TypeButtonProps {
 }
-declare const MenuToggleButton: ({ children, ...rest }: TypeMenuToggleButtonProps) => react_jsx_runtime.JSX.Element;
+/**
+ * @link https://seeds.sproutsocial.com/components/seeds-react-menu/#menutogglebutton
+ * @param props - MenuToggleButton accepts all the same props as Button.
+ * @description MenuToggleButton extends the Button component to create a toggle for a menu.
+ * @see {@link https://seeds.sproutsocial.com/components/button/ Button}
+ * @see {@link https://seeds.sproutsocial.com/components/seeds-react-menu/#menulabel MenuLabel}
+ */
+declare const MenuToggleButton: (props: TypeMenuToggleButtonProps) => react_jsx_runtime.JSX.Element;
 
-type TypeGetIsItemVisibleFn = (item: TypeMenuContext["items"][number], inputValue: string) => boolean;
+type TypeGetIsItemVisibleFn = (item: TypeInternalItemProps, inputValue: string) => boolean;
 
 interface TypeMenuSearchInputProps extends TypeInputProps {
+    /** A function that can be passed to override the default filtering logic */
     getIsItemVisible?: TypeGetIsItemVisibleFn;
 }
 /**
- * <input
- *  aria-activedescendant=""
- *  aria-autocomplete="list"
- *  aria-controls="downshift-:r1:-menu"
- *  aria-expanded="true"
- * />
- */
-/**
- * @link https://seeds.sproutsocial.com/components/menu-header/
+ * @link https://seeds.sproutsocial.com/components/seeds-react-menu/#menusearchinput
  *
  * @description MenuSearchInput is search input that can be added to the MenuHeader to filter the items.
+ *
+ * @see {@link https://seeds.sproutsocial.com/components/seeds-react-menu/#menuheader MenuHeader}
+ * @see {@link https://seeds.sproutsocial.com/components/seeds-react-menu/#menusearchtokeninput MenuSearchTokenInput}
  */
 declare const MenuSearchInput: ({ getIsItemVisible, inputProps, ...restInputProps }: TypeMenuSearchInputProps) => react_jsx_runtime.JSX.Element;
 
 interface TypeMenuTokenInputProps extends TypeTokenInputProps {
-    getTokenProps?: (itemId: TypeInternalItemProps["id"]) => Partial<TypeTokenSpec>;
+    /** A function that can be passed to override the default token props */
+    getTokenProps?: (itemId: string) => Partial<TypeTokenSpec>;
+    /** Specify the menu context to use. MenuToggleContext is the default.
+     *  This prop is only needed for specialized use cases. */
     MenuContext?: typeof MenuToggleContext | typeof MenuContentContext;
 }
+/**
+ * @description MenuTokenInput is the basis of the MenuSearchTokenInput and AutocompleteTokenInput components
+ *
+ * @see {@link https://seeds.sproutsocial.com/components/seeds-react-menu/#menusearchinput MenuSearchInput}
+ * @see {@link https://seeds.sproutsocial.com/components/seeds-react-menu/#menusearchtokeninput MenuSearchTokenInput}
+ */
 declare const MenuTokenInput: ({ inputProps, getTokenProps, onKeyDown, MenuContext, ...tokenInputProps }: TypeMenuTokenInputProps) => react_jsx_runtime.JSX.Element;
 
 interface TypeMenuSearchTokenInputProps extends TypeMenuTokenInputProps {
+    /** A function that can be passed to override the default filtering logic */
     getIsItemVisible?: TypeGetIsItemVisibleFn;
 }
 /**
- * @link https://seeds.sproutsocial.com/components/menu-search-token-input/
+ * @link https://seeds.sproutsocial.com/components/seeds-react-menu/#menusearchtokeninput
+ *
+ * @description MenuSearchTokenInput is a token input that can be added to the MenuHeader to filter the items.
  *
- * @description MenuSearchTokenInput is search token input that can be added to the MenuHeader to filter the items.
+ * @see {@link https://seeds.sproutsocial.com/components/seeds-react-menu/#menuheader MenuHeader}
+ * @see {@link https://seeds.sproutsocial.com/components/seeds-react-menu/#menusearchinput MenuSearchInput}
  */
 declare const MenuSearchTokenInput: ({ getIsItemVisible, getTokenProps, onChange, inputProps: { value: inputPropsValue, ...inputProps }, value, ...tokenInputProps }: TypeMenuSearchTokenInputProps) => react_jsx_runtime.JSX.Element;
 
@@ -367,8 +417,8 @@ type TypeActionMenuProps<I extends TypeMenuItemProps = TypeMenuItemProps> = Type
  * @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}
+ * @see {@link https://seeds.sproutsocial.com/components/single-select-menu SingleSelectMenu}
+ * @see {@link https://seeds.sproutsocial.com/components/multi-select-menu MultiSelectMenu}
  */
 declare const ActionMenu: <I extends TypeMenuItemProps = TypeMenuItemProps>({ children: childrenProp, menuItems, MenuItemComponent, stateReducer: externalStateReducer, MenuRootComponent, ...useSelectProps }: TypeActionMenuProps<I>) => react_jsx_runtime.JSX.Element;
 
@@ -377,12 +427,13 @@ interface TypeSingleSelectMenuBaseProps extends TypeHigherOrderComponentProps, T
 type TypeSingleSelectMenuProps<I extends TypeMenuItemProps = TypeMenuItemProps> = TypeSingleSelectMenuBaseProps & TypeChildrenOrItems<I>;
 
 /**
- * @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
  */
 declare const SingleSelectMenu: <I extends TypeMenuItemProps = TypeMenuItemProps>({ children: childrenProp, stateReducer: externalStateReducer, menuItems, MenuItemComponent, MenuRootComponent, ...useSelectProps }: TypeSingleSelectMenuProps<I>) => react_jsx_runtime.JSX.Element;
 
@@ -391,11 +442,12 @@ interface TypeMultiSelectMenuBaseProps extends TypeHigherOrderComponentProps, Ty
 type TypeMultiSelectMenuProps<I extends TypeMenuItemProps = TypeMenuItemProps> = TypeMultiSelectMenuBaseProps & TypeChildrenOrItems<I>;
 
 /**
- * @link https://seeds.sproutsocial.com/components/multiselect-menu/
+ * @link https://seeds.sproutsocial.com/components/multi-select-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.
+ * @description A MultiSelectMenu allows multiple {@link https://seeds.sproutsocial.com/components/seeds-react-menu/#menuitem MenuItems} to be selected from a list or groups of lists.
  *
- * @see {@link https://seeds.sproutsocial.com/components/menu-group/ | MenuGroup}
+ * @see {@link https://seeds.sproutsocial.com/components/single-select-menu/ SingleSelectMenu}
+ * @see {@link https://seeds.sproutsocial.com/components/seeds-react-menu/#menugroup MenuGroup}
  */
 declare const MultiSelectMenu: <I extends TypeMenuItemProps = TypeMenuItemProps>({ children: childrenProp, menuItems, MenuItemComponent, onSelectedItemChange: externalOnSelectedItemChange, stateReducer: externalStateReducer, MenuRootComponent, getA11yMultiStatusMessage, onMultiSelectStateChange, multiSelectStateReducer, ...useSelectProps }: TypeMultiSelectMenuProps<I>) => react_jsx_runtime.JSX.Element;
 
@@ -415,29 +467,34 @@ declare const SubmenuItem: {
 interface TypeListboxToggleButtonProps extends TypeMenuToggleButtonProps {
     invalid?: boolean;
 }
-declare const StyledListboxToggleButton: styled_components.StyledComponent<({ children, ...rest }: TypeMenuToggleButtonProps) => react_jsx_runtime.JSX.Element, styled_components.DefaultTheme, TypeListboxToggleButtonProps, never>;
+declare const StyledListboxToggleButton: styled_components.StyledComponent<(props: TypeMenuToggleButtonProps) => react_jsx_runtime.JSX.Element, styled_components.DefaultTheme, TypeListboxToggleButtonProps, never>;
 interface TypeStyledChevronProps {
     $isOpen?: boolean;
     invalid?: boolean;
 }
 declare const ListboxToggleButton: ({ children, ...buttonProps }: TypeListboxToggleButtonProps) => react_jsx_runtime.JSX.Element;
 
-type TypeSingleAutocompleteProps<I extends TypeMenuItemProps = TypeMenuItemProps> = TypeHigherOrderComponentProps & TypeChildrenOrItems<I> & TypeDownshiftComboboxProps & {
+type TypeBaseAutocompleteProps = TypeHigherOrderComponentProps & TypeDownshiftComboboxProps & {
+    /** A function that can be passed to override the default filtering logic */
     getIsItemVisible?: TypeGetIsItemVisibleFn;
+    /** Set multiSelect to true to allow multiple selections.
+     *  Default: false*/
+    multiSelect?: boolean;
 };
-type TypeMultiAutocompleteProps<I extends TypeMenuItemProps = TypeMenuItemProps> = TypeSingleAutocompleteProps<I> & TypeDownshiftMultiSelectProps & {
-    showSelectedItemsInDropdown?: boolean;
-};
-type TypeAutocompleteProps<I extends TypeMenuItemProps = TypeMenuItemProps> = (TypeSingleAutocompleteProps<I> & {
+type TypeSingleAutocompleteProps<I extends TypeMenuItemProps = TypeMenuItemProps> = TypeBaseAutocompleteProps & {
     multiSelect?: false;
-}) | (TypeMultiAutocompleteProps<I> & {
-    multiSelect: true;
-});
+} & TypeChildrenOrItems<I>;
+type TypeMultiAutocompleteProps<I extends TypeMenuItemProps = TypeMenuItemProps> = TypeBaseAutocompleteProps & TypeDownshiftMultiSelectProps & {
+    multiSelect?: true;
+    /** Determines whether a multiselect autocomplete will display selected items in the dropdown */
+    showSelectedItemsInDropdown?: boolean;
+} & TypeChildrenOrItems<I>;
+type TypeAutocompleteProps<I extends TypeMenuItemProps = TypeMenuItemProps> = TypeSingleAutocompleteProps<I> | TypeMultiAutocompleteProps<I>;
 
 /**
  * @link https://seeds.sproutsocial.com/components/autocomplete/
  *
- * @description A Autocomplete allows selecting a {@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 to populate an input.
+ * @description A Autocomplete allows selecting {@link https://seeds.sproutsocial.com/components/seeds-react-menu/#menuitem MenuItems} from a list or groups of lists to populate an input.
  *
  */
 declare const Autocomplete: <I extends TypeMenuItemProps = TypeMenuItemProps>({ multiSelect, ...rest }: TypeAutocompleteProps<I>) => react_jsx_runtime.JSX.Element;
@@ -466,10 +523,13 @@ interface TypeNestedMenuHeaderProps extends TypeMenuHeaderProps {
     backArrowLabel?: string;
 }
 interface TypeNestedMenuItemProps extends TypeMenuItemProps {
+    /** The id of the menu to be displayed when this item is selected. */
     childMenuId?: string;
 }
 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. */
@@ -553,4 +613,4 @@ declare const useMenuChildren: <I extends TypeMenuItemProps = TypeMenuItemProps>
 declare const useSelectStateReducer: Required<UseSelectProps<TypeInternalItemProps>>["stateReducer"];
 declare const useSelectStateReducerForMulti: Required<UseSelectProps<TypeInternalItemProps>>["stateReducer"];
 
-export { ActionMenu, Autocomplete, AutocompleteInput, AutocompleteSelect, AutocompleteTokenInput, CustomPopoutContent, INPUT_TYPES, type InputType, ListboxToggleButton, MenuContent, MenuContentContext, MenuContentProvider, MenuFooter, MenuGroup, MenuHeader, MenuItem, MenuItemAction, MenuItemActionLeft, MenuItemActionRight, MenuItemContainer, MenuItemRow, MenuItemText, MenuLabel, MenuPopout, MenuRoot, MenuRootNoPopout, MenuSearchInput, MenuSearchTokenInput, MenuToggleButton, MenuToggleContext, MenuToggleProvider, MenuTokenInput, MultiSelectMenu, NestedMenu, NestedMenuContent, NestedMenuContext, NestedMenuHeader, NestedMenuItem, NestedMenuProvider, SingleSelectMenu, StyledListboxToggleButton, StyledMenuGroup, StyledMenuGroupUl, StyledMenuItem, StyledTitle, SubmenuItem, type TypeActionMenuBaseProps, type TypeActionMenuProps, type TypeAutocompleteInputProps, type TypeAutocompleteProps, type TypeAutocompleteTokenInputProps, type TypeChildrenOrItems, type TypeDownshiftComboboxProps, type TypeDownshiftComboboxReturnValue, type TypeDownshiftMergedInputProps, type TypeDownshiftMultiSelectProps, type TypeDownshiftMultiSelectReturnValue, type TypeDownshiftSelectProps, type TypeDownshiftSelectReturnValue, type TypeHigherOrderComponentProps, type TypeInternalItemProps, type TypeItemElement, type TypeListboxToggleButtonProps, type TypeMapMenuItemsProps, type TypeMenuChildren, type TypeMenuContentElement, type TypeMenuContentProps, type TypeMenuContext, type TypeMenuContextBaseProps, type TypeMenuContextProps, type TypeMenuGroupBaseProps, type TypeMenuGroupElement, type TypeMenuGroupProps, type TypeMenuGroupStyledProps, type TypeMenuHeaderProps, type TypeMenuItemProps, type TypeMenuItemStyledProps, type TypeMenuPopoutProps, type TypeMenuProviderProps, type TypeMenuRootOwnProps, type TypeMenuRootProps, type TypeMenuSearchInputProps, type TypeMenuSearchTokenInputProps, type TypeMenuToggleButtonProps, type TypeMenuToggleContext, type TypeMenuToggleProviderProps, type TypeMenuTokenInputProps, type TypeMultiAutocompleteProps, type TypeMultiSelectMenuBaseProps, type TypeMultiSelectMenuProps, type TypeNestedMenuContext, type TypeNestedMenuHeaderProps, type TypeNestedMenuItemProps, type TypeNestedMenuMapProps, type TypeNestedMenuProps, type TypeNestedMenuProviderProps, type TypeNotEmptyChildren, type TypeSingleAutocompleteProps, type TypeSingleSelectMenuBaseProps, type TypeSingleSelectMenuProps, type TypeStyledChevronProps, type TypeSubmenuItemProps, type TypeSubmenuValidMenuComponentProps, checkIfItemSelected, defaultMenuContext, getChildrenFromMenuItems, getSelectedItemIds, mapMenuItems, useMenu, useMenuChildren, useMenuContentContext, useMenuToggleContext, useNestedMenuContext, useSelectStateReducer, useSelectStateReducerForMulti };
+export { ActionMenu, Autocomplete, AutocompleteInput, AutocompleteSelect, AutocompleteTokenInput, CustomPopoutContent, INPUT_TYPES, type InputType, ListboxToggleButton, MenuContent, MenuContentContext, MenuContentProvider, MenuFooter, MenuGroup, MenuHeader, MenuItem, MenuItemAction, MenuItemActionLeft, MenuItemActionRight, MenuItemContainer, MenuItemRow, MenuItemText, MenuLabel, MenuPopout, MenuRoot, MenuSearchInput, MenuSearchTokenInput, MenuToggleButton, MenuToggleContext, MenuToggleProvider, MenuTokenInput, MultiSelectMenu, NestedMenu, NestedMenuContent, NestedMenuContext, NestedMenuHeader, NestedMenuItem, NestedMenuProvider, SingleSelectMenu, StyledListboxToggleButton, StyledMenuGroup, StyledMenuGroupUl, StyledMenuItem, StyledTitle, SubmenuItem, type TypeActionMenuBaseProps, type TypeActionMenuProps, type TypeAutocompleteInputProps, type TypeAutocompleteProps, type TypeAutocompleteTokenInputProps, type TypeBaseAutocompleteProps, type TypeChildrenOrItems, type TypeDownshiftComboboxProps, type TypeDownshiftComboboxReturnValue, type TypeDownshiftMergedInputProps, type TypeDownshiftMultiSelectProps, type TypeDownshiftMultiSelectReturnValue, type TypeDownshiftSelectProps, type TypeDownshiftSelectReturnValue, type TypeHigherOrderComponentProps, type TypeInternalItemProps, type TypeItemElement, type TypeListboxToggleButtonProps, type TypeMapMenuItemsProps, type TypeMenuChildren, type TypeMenuContentElement, type TypeMenuContentProps, type TypeMenuContext, type TypeMenuContextBaseProps, type TypeMenuContextProps, type TypeMenuGroupBaseProps, type TypeMenuGroupElement, type TypeMenuGroupProps, type TypeMenuGroupStyledProps, type TypeMenuHeaderProps, type TypeMenuItemProps, type TypeMenuItemStyledProps, type TypeMenuLabelProps, type TypeMenuPopoutProps, type TypeMenuProviderProps, type TypeMenuRootOwnProps, type TypeMenuRootProps, type TypeMenuSearchInputProps, type TypeMenuSearchTokenInputProps, type TypeMenuToggleButtonProps, type TypeMenuToggleContext, type TypeMenuToggleProviderProps, type TypeMenuTokenInputProps, type TypeMultiAutocompleteProps, type TypeMultiSelectMenuBaseProps, type TypeMultiSelectMenuProps, type TypeNestedMenuContext, type TypeNestedMenuHeaderProps, type TypeNestedMenuItemProps, type TypeNestedMenuMapProps, type TypeNestedMenuProps, type TypeNestedMenuProviderProps, type TypeNotEmptyChildren, type TypeSingleAutocompleteProps, type TypeSingleSelectMenuBaseProps, type TypeSingleSelectMenuProps, type TypeStyledChevronProps, type TypeSubmenuItemProps, type TypeSubmenuValidMenuComponentProps, checkIfItemSelected, defaultMenuContext, getChildrenFromMenuItems, getSelectedItemIds, mapMenuItems, useMenu, useMenuChildren, useMenuContentContext, useMenuToggleContext, useNestedMenuContext, useSelectStateReducer, useSelectStateReducerForMulti };