# All files / menu DropdownMenu.tsx

99.32% Statements 295/297
78.94% Branches 15/19
100% Functions 3/3
99.32% Lines 295/297

Press n or j to go to the next uncovered block, b, p or k for the previous block.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    2981x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    78x
    204x
    204x
    204x
    204x
    8x
    204x
    204x
    204x
    204x
    69x
    69x
    69x
    69x
    69x
    204x
    204x
    204x
    191x
    191x
    191x
    191x
    191x
    191x
    191x
    191x
    191x
    191x
    204x
    13x
    13x
    13x
    13x
    13x
    13x
    13x
    13x
    13x
    13x
    13x
    13x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    204x
    8x
    8x

    8x
    8x
    8x
    204x
    204x
    19x
    19x
    19x
    10x
    10x
    9x
    9x
    9x
    204x
    204x
    204x
    204x
    204x
    204x
     "use client";
    import {
      useCallback,
      useRef,
      type ReactElement,
      type ReactNode,
      type RefObject,
    } from "react";
    import { useUserInteractionMode } from "../interaction/UserInteractionModeProvider.js";
    import { getLastFocusableIndex } from "../movement/utils.js";
    import { type UseStateSetter } from "../types.js";
    import { useEnsuredId } from "../useEnsuredId.js";
    import { useEnsuredState } from "../useEnsuredState.js";
    import {
      Menu,
      type MenuConvenienceProps,
      type MenuListConvenienceProps,
    } from "./Menu.js";
    import { MenuButton, type MenuButtonProps } from "./MenuButton.js";
    import {
      MenuConfigurationProvider,
      type MenuConfiguration,
    } from "./MenuConfigurationProvider.js";
    import { MenuItemButton, type MenuItemButtonProps } from "./MenuItemButton.js";
    import { type MenuSheetConvenienceProps } from "./MenuSheet.js";
    import { MenuVisibilityProvider } from "./MenuVisibilityProvider.js";
    import { useMenuBarContext } from "./useMenuBarProvider.js";

    export interface BaseDropdownMenuProps
      extends MenuConfiguration,
        MenuListConvenienceProps,
        MenuSheetConvenienceProps,
        MenuConvenienceProps {
      buttonChildren: ReactNode;
    }

    export interface DropdownMenuButtonProps
      extends MenuButtonProps,
        BaseDropdownMenuProps {}

    export interface DropdownMenuItemButtonProps
      extends MenuItemButtonProps,
        BaseDropdownMenuProps {}

    /**
     * @remarks \@since 6.0.0
     */
    export interface DropdownMenuStateProps {
      visible: boolean;
      setVisible: UseStateSetter<boolean>;
    }

    /**
     * @remarks
     * \@since 5.0.0
     * \@since 6.0.0 Updated to use an `&` instead of `|` to allow autocompletion to
     * work better by default. It's up to the user to make sure they don't provide
     * incorrect props.
     */
    export type DropdownMenuProps = DropdownMenuButtonProps &
      DropdownMenuItemButtonProps &
      (DropdownMenuStateProps | { visible?: never; setVisible?: never });

    /**
     * **Client Component**
     *
     * @example
     * Simple Example
     * ```tsx
     * import type { ReactElement } from "react";
     * import { DropdownMenu, MenuItem } from "@react-md/core";
     *
     * function Example() {
     *   return (
     *     <DropdownMenu buttonChildren="Dropdown">
     *       <MenuItem onClick={() => console.log('Clicked Item 1')}>
     *         Item 1
     *       </MenuItem>
     *       <MenuItem onClick={() => console.log('Clicked Item 2')}>
     *         Item 2
     *       </MenuItem>
     *     </DropdownMenu>
     *   );
     * }
     * ```
     *
     * @example
     * Nested Dropdown Menus
     * ```tsx
     * import type { ReactElement } from "react";
     * import { DropdownMenu, MenuItem } from "@react-md/core";
     *
     * function Example() {
     *   return (
     *     <DropdownMenu buttonChildren="Dropdown">
     *       <MenuItem onClick={() => console.log('Clicked Item 1')}>
     *         Item 1
     *       </MenuItem>
     *       <MenuItem onClick={() => console.log('Clicked Item 2')}>
     *         Item 2
     *       </MenuItem>
     *       <DropdownMenu buttonChildren="Nested Dropdown">
     *         <MenuItem onClick={() => console.log('Clicked Item 1')}>
     *           Nested Item 1
     *         </MenuItem>
     *         <MenuItem onClick={() => console.log('Clicked Item 2')}>
     *           Nested Item 2
     *         </MenuItem>
     *       </DropdownMenu>
     *     </DropdownMenu>
     *   );
     * }
     * ```
     *
     * @remarks
     * \@since 5.0.0
     * \@since 6.0.0 Updated to use the latest menu API.
     */
    export function DropdownMenu(props: DropdownMenuProps): ReactElement {
      const {
        id: propId,
        horizontal,
        sheetHeader,
        sheetFooter,
        renderAsSheet,
        sheetPosition,
        sheetVerticalSize,
        buttonChildren,
        iconRotatorProps: propIconRotatorProps,
        disableTransition: propDisableTransition,
        floating,
        anchor,
        vwMargin,
        vhMargin,
        xMargin,
        yMargin,
        initialX,
        initialY,
        width,
        transformOrigin,
        preventOverlap,
        disableSwapping,
        disableVHBounds,
        preventScroll,
        closeOnResize,
        closeOnScroll,
        getFixedPositionOptions,
        children,
        temporary,
        disablePortal,
        disableElevation,
        menuProps,
        menuStyle,
        menuClassName,
        sheetProps,
        sheetStyle,
        sheetClassName,
        visible: propVisible,
        setVisible: propSetVisible,
        ...remaining
      } = props;

      const fixedTo = useRef<HTMLElement | HTMLButtonElement>(null);
      const defaultFocusIndex = useRef(0);
      const [visible, setVisible] = useEnsuredState({
        value: propVisible,
        setValue: propSetVisible,
        defaultValue: false,
      });
      const { menubar, menuitem, activeIdRef, animatedOnceRef } =
        useMenuBarContext();
      const id = useEnsuredId(propId, `menu${menuitem ? "item" : "button"}`);
      const mode = useUserInteractionMode();
      const mouse = mode === "mouse";
      const keyboard = mode === "keyboard";
      const disableTransition =
        propDisableTransition ??
        (animatedOnceRef.current &&
          menubar &&
          !!activeIdRef.current &&
          (mouse || keyboard));

      const onRequestClose = useCallback(() => {
        setVisible(false);
      }, [setVisible]);

      let iconRotatorProps = propIconRotatorProps;
      if (disableTransition) {
        iconRotatorProps = {
          disableTransition,
          ...propIconRotatorProps,
        };
      }

      let toggle: ReactElement;
      if (menuitem) {
        toggle = (
          <MenuItemButton
            {...(remaining as DropdownMenuItemButtonProps)}
            id={id}
            ref={fixedTo as RefObject<HTMLLIElement>}
            iconRotatorProps={iconRotatorProps}
          >
            {buttonChildren}
          </MenuItemButton>
        );
      } else {
        toggle = (
          <MenuButton
            {...(remaining as DropdownMenuButtonProps)}
            id={id}
            ref={fixedTo as RefObject<HTMLButtonElement>}
            floating={floating}
            iconRotatorProps={iconRotatorProps}
          >
            {buttonChildren}
          </MenuButton>
        );
      }

      return (
        <MenuVisibilityProvider
          visible={visible}
          setVisible={setVisible}
          defaultFocusIndex={defaultFocusIndex}
        >
          <MenuConfigurationProvider
            horizontal={horizontal}
            renderAsSheet={renderAsSheet}
            sheetFooter={sheetFooter}
            sheetHeader={sheetHeader}
            sheetPosition={sheetPosition}
            sheetVerticalSize={sheetVerticalSize}
          >
            {toggle}
          </MenuConfigurationProvider>
          <Menu
            aria-labelledby={(menuProps?.["aria-label"] ? undefined : id) as string}
            style={menuStyle}
            className={menuClassName}
            sheetProps={sheetProps}
            sheetStyle={sheetStyle}
            sheetClassName={sheetClassName}
            temporary={temporary}
            disablePortal={disablePortal}
            disableElevation={disableElevation}
            disableTransition={disableTransition}
            floating={floating}
            anchor={anchor}
            vwMargin={vwMargin}
            vhMargin={vhMargin}
            xMargin={xMargin}
            yMargin={yMargin}
            initialX={initialX}
            initialY={initialY}
            width={width}
            transformOrigin={transformOrigin}
            preventOverlap={preventOverlap}
            disableSwapping={disableSwapping}
            disableVHBounds={disableVHBounds}
            preventScroll={preventScroll}
            closeOnResize={closeOnResize}
            closeOnScroll={closeOnScroll}
            getFixedPositionOptions={getFixedPositionOptions}
            horizontal={horizontal}
            sheetHeader={sheetHeader}
            sheetFooter={sheetFooter}
            renderAsSheet={renderAsSheet}
            sheetPosition={sheetPosition}
            sheetVerticalSize={sheetVerticalSize}
            {...menuProps}
            fixedTo={fixedTo}
            visible={visible}
            getDefaultFocusedIndex={(options) => {
              const defaultIndex = defaultFocusIndex.current;
              if (defaultIndex < 0) {
                return getLastFocusableIndex(options);
              }

              return defaultIndex;
            }}
            onRequestClose={onRequestClose}
            onEntered={(appearing) => {
              menuProps?.onEntered?.(appearing);
              // this will be called before `getDefaultFocusedIndex`
              if (disableTransition) {
                return;
              }

              defaultFocusIndex.current = 0;
            }}
          >
            {children}
          </Menu>
        </MenuVisibilityProvider>
      );
    }