# All files / tree TreeItem.tsx

100% Statements 307/307
100% Branches 18/18
100% Functions 2/2
100% Lines 307/307

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
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    3081x
    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
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    1x
    1x
    1x
    1x
    1x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    113x
    113x
    113x
    113x
    113x
    113x
    113x
    113x
    113x
    113x
    113x
    113x
    567x
    567x
    567x
    567x
    567x
    567x
    16x
    16x
    16x
    6x
    6x
    16x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
    567x
     "use client";
    import {
      useEffect,
      type HTMLAttributes,
      type ReactElement,
      type ReactNode,
      type Ref,
    } from "react";
    import { useElementInteraction } from "../interaction/useElementInteraction.js";
    import { useHigherContrastChildren } from "../interaction/useHigherContrastChildren.js";
    import { ListItemChildren } from "../list/ListItemChildren.js";
    import { useKeyboardMovementContext } from "../movement/useKeyboardMovementProvider.js";
    import { type PropsWithRef } from "../types.js";
    import { useEnsuredId } from "../useEnsuredId.js";
    import { TreeGroup, type OverridableTreeGroupProps } from "./TreeGroup.js";
    import { TreeItemExpander } from "./TreeItemExpander.js";
    import { useTreeContext } from "./TreeProvider.js";
    import { treeItem, treeItemContent, treeItemMedia } from "./styles.js";
    import { type DefaultTreeItemNode } from "./types.js";

    /**
     * @remarks \@since 6.0.0  Added the `groupProps` prop.
     */
    export interface TreeItemProps
      extends Omit<DefaultTreeItemNode, "parentId">,
        HTMLAttributes<HTMLLIElement> {
      /**
       * @defaultValue `"tree-item-" + useId()`
       */
      id?: string;

      /**
       * This is used to set the `--rmd-tree-depth` CSS variable which allows the
       * padding to increase for each nested tree.
       */
      depth: number;

      /**
       * Any additional props that should be passed to the surrounding `<li>`
       * element. The top-level props are passed to the `<span>` or `<a>` element
       * instead.
       */
      liProps?: PropsWithRef<HTMLAttributes<HTMLLIElement>, HTMLLIElement>;

      /**
       * Any additional props to pass to the `TreeGroup` component.
       */
      groupProps?: PropsWithRef<OverridableTreeGroupProps, HTMLUListElement>;

      /**
       * This should normally be the text/content to display within the tree item
       * and should **not** include nested trees.
       */
      children?: ReactNode;

      /**
       * The nested tree items to render within a `TreeGroup`.
       */
      childItems?: ReactNode;

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

      /**
       * This ref is applied to the `<span>` or `<a>` element and can be used to
       * implement drag and drop behavior.
       */
      contentRef?: Ref<HTMLElement>;

      /**
       * Set this to `true` if the {@link childItems} should not be rendered while
       * collapsed.
       *
       * @defaultValue `false`
       */
      temporaryChildItems?: boolean;
    }

    /**
     * **Client Component**
     *
     * @see {@link https://www.w3.org/WAI/ARIA/apg/patterns/treeview/}
     * @remarks
     * \@since 6.0.0 The wrapping `<li>` element will always be `role="none"` and
     * the `<span>` or `<a>` will gain the `role="treeitem"` instead. This makes it
     * easier to pass event handlers because of the nested behavior of tree items.
     * \@since 6.0.0 No longer provides the `aria-level`, `aria-setsize` and
     * `aria-posinset` attributes and allows the browser to compute them instead.
     */
    export function TreeItem(props: TreeItemProps): ReactElement {
      const {
        id: propId,
        depth,
        liProps,
        disabled = false,
        disabledOpacity = false,
        groupProps,
        children: propChildren,
        className,
        itemId,
        leftAddon,
        leftAddonType: propLeftAddonType,
        leftAddonPosition,
        leftAddonClassName,
        leftAddonForceWrap,
        rightAddon,
        rightAddonType,
        rightAddonPosition,
        rightAddonClassName,
        rightAddonForceWrap,
        disableTextChildren,
        disableLeftAddonCenteredMedia: propDisableLeftAddonCenteredMedia,
        disableRightAddonCenteredMedia,
        textProps,
        textClassName,
        primaryText,
        secondaryText,
        secondaryTextProps,
        secondaryTextClassName,
        multiline,
        childItems,
        contentClassName,
        temporaryChildItems,
        disableTransition: propDisableTransition,
        onBlur,
        onClick,
        onKeyDown,
        onKeyUp,
        onMouseDown,
        onMouseUp,
        onMouseLeave,
        onDragStart,
        onTouchStart,
        onTouchEnd,
        onTouchMove,
        contentRef,
        ...remaining
      } = props;

      const id = useEnsuredId(propId, "tree-item");
      const children = useHigherContrastChildren(propChildren);
      if (disabled) {
        // you can't really disable a link other than removing the href, so
        // unset these props
        remaining.to = undefined;
        remaining.href = undefined;
      }

      const {
        expandedIds,
        selectedIds,
        expanderLeft,
        expansionMode,
        metadataLookup,
        linkComponent: Link,
        toggleTreeItemSelection,
        toggleTreeItemExpansion,
        disableTransition: contextDisableTransition,
      } = useTreeContext();
      const { activeDescendantId } = useKeyboardMovementContext();

      const isLeafNode = !childItems;
      const focused = activeDescendantId === id;
      const expanded = expandedIds.has(itemId);
      const selected = selectedIds.has(itemId);
      const disableTransition = propDisableTransition ?? contextDisableTransition;

      useEffect(() => {
        const lookup = metadataLookup.current;
        lookup.expandable[itemId] = !isLeafNode;
        lookup.disabledItems[itemId] = disabled;
        lookup.elementToItem[id] = itemId;
        lookup.itemToElement[itemId] = id;

        return () => {
          delete lookup.disabledItems[itemId];
          delete lookup.expandable[itemId];
          delete lookup.elementToItem[id];
          delete lookup.itemToElement[itemId];
        };
      }, [id, metadataLookup, itemId, isLeafNode, disabled, depth]);

      const { pressedClassName, ripples, handlers } =
        useElementInteraction<HTMLLIElement>({
          onBlur,
          onClick(event) {
            onClick?.(event);
            toggleTreeItemSelection(itemId);
            if (!isLeafNode && expansionMode !== "manual") {
              toggleTreeItemExpansion(itemId);
            }
          },
          onKeyDown,
          onKeyUp,
          onMouseDown,
          onMouseUp,
          onMouseLeave,
          onDragStart,
          onTouchStart,
          onTouchEnd,
          onTouchMove,
          disabled,
        });

      const isLink = !!(remaining.to || remaining.href);

      // cheating a bit so there are type errors around the event handlers
      const ContentComponent = (isLink ? Link : "span") as "span";
      const leftAddonType =
        propLeftAddonType ?? (expanderLeft && leftAddon) ? "media" : undefined;
      const isMediaLeftAddon =
        typeof propLeftAddonType === "undefined" && leftAddonType === "media";
      const disableLeftAddonCenteredMedia =
        propDisableLeftAddonCenteredMedia ?? isMediaLeftAddon;

      return (
        <li
          {...liProps}
          role="none"
          className={treeItem({
            className,
            expander: !!childItems,
            expanderLeft,
          })}
        >
          <ContentComponent
            {...remaining}
            // nodes with children should always apply the `aria-expanded` to show
            // that it is expandable while leaf nodes should remain omitted
            aria-expanded={isLeafNode ? undefined : expanded}
            aria-selected={selected}
            aria-disabled={disabled || undefined}
            id={id}
            ref={contentRef}
            role="treeitem"
            tabIndex={-1}
            {...handlers}
            className={treeItemContent({
              link: isLink,
              focused,
              selected,
              disabled,
              disabledOpacity,
              className: contentClassName,
              pressedClassName,
            })}
          >
            <ListItemChildren
              multiline={multiline}
              textClassName={textClassName}
              secondaryTextClassName={secondaryTextClassName}
              disableTextChildren={disableTextChildren}
              primaryText={primaryText}
              textProps={textProps}
              secondaryText={secondaryText}
              secondaryTextProps={secondaryTextProps}
              leftAddon={
                <TreeItemExpander
                  isLeft
                  itemId={itemId}
                  addon={leftAddon}
                  expanded={expanded}
                  disabled={disabled}
                  isLeafNode={isLeafNode}
                />
              }
              leftAddonType={leftAddonType}
              leftAddonPosition={leftAddonPosition}
              leftAddonClassName={treeItemMedia({
                isLeafNode,
                isMediaLeftAddon,
                className: leftAddonClassName,
              })}
              leftAddonForceWrap={leftAddonForceWrap}
              rightAddon={
                <TreeItemExpander
                  itemId={itemId}
                  addon={rightAddon}
                  expanded={expanded}
                  disabled={disabled}
                  isLeafNode={isLeafNode}
                />
              }
              rightAddonType={rightAddonType}
              rightAddonPosition={rightAddonPosition}
              rightAddonClassName={rightAddonClassName}
              rightAddonForceWrap={rightAddonForceWrap}
              disableLeftAddonCenteredMedia={disableLeftAddonCenteredMedia}
              disableRightAddonCenteredMedia={disableRightAddonCenteredMedia}
            >
              {children}
            </ListItemChildren>
            {ripples}
          </ContentComponent>
          <TreeGroup
            id={`${id}-group`}
            temporary={temporaryChildItems}
            disableTransition={disableTransition}
            {...groupProps}
            depth={depth + 1}
            collapsed={isLeafNode || !expanded}
          >
            {childItems}
          </TreeGroup>
        </li>
      );
    }