# All files MenuItemInputToggle.tsx

93.92% Statements 263/280
76.92% Branches 10/13
100% Functions 3/3
93.92% Lines 263/280

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
    2811x
    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
    4x
    4x
    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
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x

    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    4x
    4x
    4x
    4x
    4x
    4x
    28x
    28x
    28x
    28x
    28x
    28x
    28x
    28x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    4x
    4x
    4x
    4x

    4x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
    32x
     "use client";
    import { cnb } from "cnbuilder";
    import {
      forwardRef,
      type CSSProperties,
      type HTMLAttributes,
      type MouseEvent,
      type ReactNode,
    } from "react";
    import { ListItem } from "../list/ListItem.js";
    import {
      type ListItemAddonPosition,
      type ListItemAddonType,
      type ListItemChildrenTextProps,
      type ListItemHeight,
    } from "../list/types.js";
    import { type PropsWithRef } from "../types.js";
    import { useEnsuredId } from "../useEnsuredId.js";
    import {
      type IndeterminateCheckboxProps,
      type InputToggleIconProps,
    } from "./InputToggle.js";
    import { InputToggleIcon } from "./InputToggleIcon.js";
    import { SwitchTrack } from "./SwitchTrack.js";
    import { type InputToggleSize } from "./inputToggleStyles.js";
    import {
      menuItemInputToggle,
      menuItemInputToggleBall,
      menuItemInputToggleIcon,
      menuItemInputToggleTrack,
    } from "./menuItemInputToggleStyles.js";

    const noop = (): void => {
      // do nothing
    };

    /**
     * @remarks \@since 6.0.0
     */
    export type MenuItemInputToggleCheckedCallback = (
      checked: boolean,
      event: MouseEvent<HTMLLIElement>
    ) => void;

    /** @remarks \@since 2.8.0 */
    export interface BaseMenuItemInputToggleProps
      extends HTMLAttributes<HTMLLIElement>,
        InputToggleIconProps,
        ListItemChildrenTextProps {
      checked: boolean;
      onCheckedChange: MenuItemInputToggleCheckedCallback;

      /**
       * @defaultValue `"menu-item-" + useId()`
       */
      id?: string;

      /** @defaultValue `false` */
      disabled?: boolean;

      /**
       * Set this to `true` if the `Menu` should not close when the input toggle is
       * clicked. This can be useful when interacting with a checkbox group within a
       * menu or allowing the user to select multiple options before closing the
       * menu.
       *
       * @defaultValue `false`
       */
      preventMenuHideOnClick?: boolean;

      /**
       * This is set to `"auto"` by default so the icon shrinks back down to the
       * default icon size instead of relative to the current font size. You
       * probably don't want to change this since it'll also modify the height of
       * the menu item
       *
       * @defaultValue `"auto"`
       */
      size?: InputToggleSize;

      /** @defaultValue `"auto"` */
      height?: ListItemHeight;

      /** @defaultValue `false` */
      iconAfter?: boolean;

      addon?: ReactNode;
      addonType?: ListItemAddonType;
      addonPosition?: ListItemAddonPosition;

      /** @defaultValue `false` */
      addonForceWrap?: boolean;

      /** @defaultValue `false` */
      disableAddonCenteredMedia?: boolean;
    }

    export interface MenuItemCheckboxProps
      extends BaseMenuItemInputToggleProps,
        IndeterminateCheckboxProps {}

    export type MenuItemRadioProps = BaseMenuItemInputToggleProps;

    /**
     * @remarks
     * \@since 2.8.0
     * \@since 6.0.0 Added additional props for styling the track and ball.
     */
    export interface MenuItemSwitchProps extends BaseMenuItemInputToggleProps {
      trackProps?: PropsWithRef<HTMLAttributes<HTMLDivElement>, HTMLDivElement>;
      trackStyle?: CSSProperties;
      trackClassName?: string;
      ballProps?: PropsWithRef<HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>;
      ballStyle?: CSSProperties;
      ballClassName?: string;
    }

    /**
     * @remarks
     * \@since 2.8.0
     * \@since 6.0.0 Updated to be a union of the different props to enforce the
     * correct props based on `type`
     */
    export type MenuItemInputToggleProps =
      | (MenuItemCheckboxProps & { type: "checkbox" })
      | (MenuItemRadioProps & { type: "radio" })
      | (MenuItemSwitchProps & { type: "switch" });

    /**
     * **Client Component**
     *
     * This is a low-level component that should probably not be used externally and
     * instead the `MenuItemCheckbox`, `MenuItemRadio`, or `MenuItemSwitch` should
     * be used instead.
     *
     * @see {@link MenuItemCheckbox} for checkbox examples
     * @see {@link MenuItemRadio} for radio examples
     * @see {@link MenuItemSwitch} for switch examples
     * @remarks \@since 2.8.0
     */
    export const MenuItemInputToggle = forwardRef<
      HTMLLIElement,
      MenuItemInputToggleProps
    >(function MenuItemInputToggle(props, ref) {
      const {
        id: propId,
        type,
        disabled = false,
        checked,
        onCheckedChange,
        preventMenuHideOnClick = false,
        onClick = noop,
        className,
        tabIndex = -1,
        children,
        size = "auto",
        icon: propIcon,
        iconAfter = false,
        iconProps,
        iconStyle,
        iconClassName,
        checkedIcon,
        indeterminate,
        indeterminateIcon,
        addon,
        addonType,
        addonPosition,
        addonForceWrap,
        disableAddonCenteredMedia,
        ballProps,
        ballStyle,
        ballClassName,
        trackProps,
        trackStyle,
        trackClassName,
        ...remaining
      } = props as MenuItemSwitchProps &
        MenuItemCheckboxProps & { type: "checkbox" | "radio" | "switch" };
      const id = useEnsuredId(propId, "menu-item");

      let icon = propIcon;
      if (type === "switch") {
        icon = (
          <SwitchTrack
            style={trackStyle}
            {...trackProps}
            className={cnb(
              menuItemInputToggleTrack(),
              trackClassName,
              trackProps?.className
            )}
            active={checked}
            ballProps={ballProps}
            ballStyle={ballStyle}
            ballClassName={cnb(menuItemInputToggleBall(), ballClassName)}
          />
        );
      } else {
        icon = (
          <InputToggleIcon
            style={iconStyle}
            disableEm
            {...iconProps}
            className={cnb(
              menuItemInputToggleIcon(),
              iconClassName,
              iconProps?.className
            )}
            size={size}
            type={type}
            checked={checked}
            disabled={disabled}
            icon={propIcon}
            checkedIcon={checkedIcon}
            indeterminate={indeterminate}
            indeterminateIcon={indeterminateIcon}
          />
        );
      }

      let leftAddon: ReactNode;
      let leftAddonType: ListItemAddonType | undefined;
      let leftAddonPosition: ListItemAddonPosition | undefined;
      let leftAddonForceWrap: boolean | undefined;
      let disableLeftAddonCenteredMedia: boolean | undefined;
      let rightAddon: ReactNode;
      let rightAddonType: ListItemAddonType | undefined;
      let rightAddonPosition: ListItemAddonPosition | undefined;
      let rightAddonForceWrap: boolean | undefined;
      let disableRightAddonCenteredMedia: boolean | undefined;
      if (iconAfter) {
        leftAddon = addon;
        leftAddonType = addonType;
        leftAddonPosition = addonPosition;
        leftAddonForceWrap = addonForceWrap;
        disableLeftAddonCenteredMedia = disableAddonCenteredMedia;
        rightAddon = icon;
      } else {
        leftAddon = icon;
        rightAddon = addon;
        rightAddonType = addonType;
        rightAddonPosition = addonPosition;
        rightAddonForceWrap = addonForceWrap;
        disableRightAddonCenteredMedia = disableAddonCenteredMedia;
      }

      return (
        <ListItem
          {...remaining}
          // I'm not actually sure if this is correct
          aria-checked={indeterminate && checked ? "mixed" : checked}
          id={id}
          role={type === "radio" ? "menuitemradio" : "menuitemcheckbox"}
          onClick={(event) => {
            onClick(event);
            onCheckedChange(!checked, event);

            if (preventMenuHideOnClick) {
              event.stopPropagation();
            }
          }}
          ref={ref}
          className={menuItemInputToggle({ type, className })}
          disabled={disabled}
          tabIndex={tabIndex}
          leftAddon={leftAddon}
          leftAddonType={leftAddonType}
          leftAddonPosition={leftAddonPosition}
          leftAddonForceWrap={leftAddonForceWrap}
          disableLeftAddonCenteredMedia={disableLeftAddonCenteredMedia}
          rightAddon={rightAddon}
          rightAddonType={rightAddonType}
          rightAddonPosition={rightAddonPosition}
          rightAddonForceWrap={rightAddonForceWrap}
          disableRightAddonCenteredMedia={disableRightAddonCenteredMedia}
        >
          {children}
        </ListItem>
      );
    });