src/components/tree/tree.tsx

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 import React, { useCallback, useState } from 'react';
   6 import { List, ListItem, ListItemIcon, Checkbox, Radio, Collapse } from "@material-ui/core";
   7 import { StyleRulesCallback, withStyles, WithStyles } from '@material-ui/core/styles';
   8 import { CollectionIcon, DefaultIcon, DirectoryIcon, FileIcon, ProjectIcon, FilterGroupIcon, FreezeIcon } from 'components/icon/icon';
   9 import { ReactElement } from "react";
  10 import CircularProgress from '@material-ui/core/CircularProgress';
  11 import classnames from "classnames";
  12
  13 import { ArvadosTheme } from 'common/custom-theme';
  14 import { SidePanelRightArrowIcon } from '../icon/icon';
  15 import { ResourceKind } from 'models/resource';
  16 import { GroupClass } from 'models/group';
  17
  18 type CssRules = 'list'
  19     | 'listItem'
  20     | 'active'
  21     | 'loader'
  22     | 'toggableIconContainer'
  23     | 'iconClose'
  24     | 'renderContainer'
  25     | 'iconOpen'
  26     | 'toggableIcon'
  27     | 'checkbox'
  28     | 'childItem'
  29     | 'childItemIcon'
  30     | 'frozenIcon';
  31
  32 const styles: StyleRulesCallback<CssRules> = (theme: ArvadosTheme) => ({
  33     list: {
  34         padding: '3px 0px'
  35     },
  36     listItem: {
  37         padding: '3px 0px',
  38     },
  39     loader: {
  40         position: 'absolute',
  41         transform: 'translate(0px)',
  42         top: '3px'
  43     },
  44     toggableIconContainer: {
  45         color: theme.palette.grey["700"],
  46         height: '14px',
  47         width: '14px',
  48     },
  49     toggableIcon: {
  50         fontSize: '14px'
  51     },
  52     renderContainer: {
  53         flex: 1
  54     },
  55     iconClose: {
  56         transition: 'all 0.1s ease',
  57     },
  58     iconOpen: {
  59         transition: 'all 0.1s ease',
  60         transform: 'rotate(90deg)',
  61     },
  62     checkbox: {
  63         width: theme.spacing.unit * 3,
  64         height: theme.spacing.unit * 3,
  65         margin: `0 ${theme.spacing.unit}px`,
  66         padding: 0,
  67         color: theme.palette.grey["500"],
  68     },
  69     childItem: {
  70         cursor: 'pointer',
  71         display: 'flex',
  72         padding: '3px 20px',
  73         fontSize: '0.875rem',
  74         alignItems: 'center',
  75         '&:hover': {
  76             backgroundColor: 'rgba(0, 0, 0, 0.08)',
  77         }
  78     },
  79     childItemIcon: {
  80         marginLeft: '8px',
  81         marginRight: '16px',
  82         color: 'rgba(0, 0, 0, 0.54)',
  83     },
  84     active: {
  85         color: theme.palette.primary.main,
  86     },
  87     frozenIcon: {
  88         fontSize: 20,
  89         color: theme.palette.grey["600"],
  90         marginLeft: '10px',
  91     },
  92 });
  93
  94 export enum TreeItemStatus {
  95     INITIAL = 'initial',
  96     PENDING = 'pending',
  97     LOADED = 'loaded'
  98 }
  99
 100 export interface TreeItem<T> {
 101     data: T;
 102     id: string;
 103     open: boolean;
 104     active: boolean;
 105     selected?: boolean;
 106     initialState?: boolean;
 107     indeterminate?: boolean;
 108     flatTree?: boolean;
 109     status: TreeItemStatus;
 110     items?: Array<TreeItem<T>>;
 111     isFrozen?: boolean;
 112 }
 113
 114 export interface TreeProps<T> {
 115     disableRipple?: boolean;
 116     currentItemUuid?: string;
 117     items?: Array<TreeItem<T>>;
 118     level?: number;
 119     itemsMap?: Map<string, TreeItem<T>>;
 120     onContextMenu: (event: React.MouseEvent<HTMLElement>, item: TreeItem<T>) => void;
 121     render: (item: TreeItem<T>, level?: number) => ReactElement<{}>;
 122     showSelection?: boolean | ((item: TreeItem<T>) => boolean);
 123     levelIndentation?: number;
 124     itemRightPadding?: number;
 125     toggleItemActive: (event: React.MouseEvent<HTMLElement>, item: TreeItem<T>) => void;
 126     toggleItemOpen: (event: React.MouseEvent<HTMLElement>, item: TreeItem<T>) => void;
 127     toggleItemSelection?: (event: React.MouseEvent<HTMLElement>, item: TreeItem<T>) => void;
 128     selectedRef?: (node: HTMLDivElement | null) => void;
 129
 130     /**
 131      * When set to true use radio buttons instead of checkboxes for item selection.
 132      * This does not guarantee radio group behavior (i.e item mutual exclusivity).
 133      * Any item selection logic must be done in the toggleItemActive callback prop.
 134      */
 135     useRadioButtons?: boolean;
 136 }
 137
 138 const getActionAndId = (event: any, initAction: string | undefined = undefined) => {
 139     const { nativeEvent: { target } } = event;
 140     let currentTarget: HTMLElement = target as HTMLElement;
 141     let action: string | undefined = initAction || currentTarget.dataset.action;
 142     let id: string | undefined = currentTarget.dataset.id;
 143
 144     while (action === undefined || id === undefined) {
 145         currentTarget = currentTarget.parentElement as HTMLElement;
 146
 147         if (!currentTarget) {
 148             break;
 149         }
 150
 151         action = action || currentTarget.dataset.action;
 152         id = id || currentTarget.dataset.id;
 153     }
 154
 155     return [action, id];
 156 };
 157
 158 interface FlatTreeProps {
 159     it: TreeItem<any>;
 160     levelIndentation: number;
 161     onContextMenu: Function;
 162     handleToggleItemOpen: Function;
 163     toggleItemActive: Function;
 164     getToggableIconClassNames: Function;
 165     getProperArrowAnimation: Function;
 166     itemsMap?: Map<string, TreeItem<any>>;
 167     classes: any;
 168     showSelection: any;
 169     useRadioButtons?: boolean;
 170     handleCheckboxChange: Function;
 171     selectedRef?: (node: HTMLDivElement | null) => void;
 172 }
 173
 174 const FLAT_TREE_ACTIONS = {
 175     toggleOpen: 'TOGGLE_OPEN',
 176     contextMenu: 'CONTEXT_MENU',
 177     toggleActive: 'TOGGLE_ACTIVE',
 178 };
 179
 180 const ItemIcon = React.memo(({ type, kind, active, groupClass, classes }: any) => {
 181     let Icon = ProjectIcon;
 182
 183     if (groupClass === GroupClass.FILTER) {
 184         Icon = FilterGroupIcon;
 185     }
 186
 187     if (type) {
 188         switch (type) {
 189             case 'directory':
 190                 Icon = DirectoryIcon;
 191                 break;
 192             case 'file':
 193                 Icon = FileIcon;
 194                 break;
 195             default:
 196                 Icon = DefaultIcon;
 197         }
 198     }
 199
 200     if (kind) {
 201         switch (kind) {
 202             case ResourceKind.COLLECTION:
 203                 Icon = CollectionIcon;
 204                 break;
 205             default:
 206                 break;
 207         }
 208     }
 209
 210     return <Icon className={classnames({ [classes.active]: active }, classes.childItemIcon)} />;
 211 });
 212
 213 const FlatTree = (props: FlatTreeProps) =>
 214     <div
 215         onContextMenu={(event) => {
 216             const id = getActionAndId(event, FLAT_TREE_ACTIONS.contextMenu)[1];
 217             props.onContextMenu(event, { id } as any);
 218         }}
 219         onClick={(event) => {
 220             const [action, id] = getActionAndId(event);
 221
 222             if (action && id) {
 223                 const item = props.itemsMap ? props.itemsMap[id] : { id };
 224
 225                 switch (action) {
 226                     case FLAT_TREE_ACTIONS.toggleOpen:
 227                         props.handleToggleItemOpen(item as any, event);
 228                         break;
 229                     case FLAT_TREE_ACTIONS.toggleActive:
 230                         props.toggleItemActive(event, item as any);
 231                         break;
 232                     default:
 233                         break;
 234                 }
 235             }
 236         }}
 237     >
 238         {
 239             (props.it.items || [])
 240                 .map((item: any) => <div key={item.id} data-id={item.id}
 241                     className={classnames(props.classes.childItem, { [props.classes.active]: item.active })}
 242                     style={{ paddingLeft: `${item.depth * props.levelIndentation}px` }}>
 243                     <i data-action={FLAT_TREE_ACTIONS.toggleOpen} className={props.classes.toggableIconContainer}>
 244                         <ListItemIcon className={props.getToggableIconClassNames(item.open, item.active)}>
 245                             {props.getProperArrowAnimation(item.status, item.items!)}
 246                         </ListItemIcon>
 247                     </i>
 248                     {props.showSelection(item) && !props.useRadioButtons &&
 249                         <Checkbox
 250                             checked={item.selected}
 251                             className={props.classes.checkbox}
 252                             color="primary"
 253                             onClick={props.handleCheckboxChange(item)} />}
 254                     {props.showSelection(item) && props.useRadioButtons &&
 255                         <Radio
 256                             checked={item.selected}
 257                             className={props.classes.checkbox}
 258                             color="primary" />}
 259                     <div data-action={FLAT_TREE_ACTIONS.toggleActive} className={props.classes.renderContainer} ref={item.active ? props.selectedRef : undefined}>
 260                         <span style={{ display: 'flex', alignItems: 'center' }}>
 261                             <ItemIcon type={item.data.type} active={item.active} kind={item.data.kind} groupClass={item.data.kind === ResourceKind.GROUP ? item.data.groupClass : ''} classes={props.classes} />
 262                             <span style={{ fontSize: '0.875rem' }}>
 263                                 {item.data.name}
 264                             </span>
 265                             {
 266                                 !!item.data.frozenByUuid ? <FreezeIcon className={props.classes.frozenIcon} /> : null
 267                             }
 268                         </span>
 269                     </div>
 270                 </div>)
 271         }
 272     </div>;
 273
 274 export const Tree = withStyles(styles)(
 275     function<T>(props: TreeProps<T> & WithStyles<CssRules>) {
 276         const level = props.level ? props.level : 0;
 277         const { classes, render, items, toggleItemActive, toggleItemOpen, disableRipple, currentItemUuid, useRadioButtons, itemsMap } = props;
 278         const { list, listItem, loader, toggableIconContainer, renderContainer } = classes;
 279         const showSelection = typeof props.showSelection === 'function'
 280             ? props.showSelection
 281             : () => props.showSelection ? true : false;
 282
 283         const getProperArrowAnimation = (status: string, items: Array<TreeItem<T>>) => {
 284             return isSidePanelIconNotNeeded(status, items) ? <span /> : <SidePanelRightArrowIcon style={{ fontSize: '14px' }} />;
 285         }
 286
 287         const isSidePanelIconNotNeeded = (status: string, items: Array<TreeItem<T>>) => {
 288             return status === TreeItemStatus.PENDING ||
 289                 (status === TreeItemStatus.LOADED && !items) ||
 290                 (status === TreeItemStatus.LOADED && items && items.length === 0);
 291         }
 292
 293         const getToggableIconClassNames = (isOpen?: boolean, isActive?: boolean) => {
 294             const { iconOpen, iconClose, active, toggableIcon } = props.classes;
 295             return classnames(toggableIcon, {
 296                 [iconOpen]: isOpen,
 297                 [iconClose]: !isOpen,
 298                 [active]: isActive
 299             });
 300         }
 301
 302         const handleCheckboxChange = (item: TreeItem<T>) => {
 303             const { toggleItemSelection } = props;
 304             return toggleItemSelection
 305                 ? (event: React.MouseEvent<HTMLElement>) => {
 306                     event.stopPropagation();
 307                     toggleItemSelection(event, item);
 308                 }
 309                 : undefined;
 310         }
 311
 312         const handleToggleItemOpen = (item: TreeItem<T>, event: React.MouseEvent<HTMLElement>) => {
 313             event.stopPropagation();
 314             props.toggleItemOpen(event, item);
 315         }
 316
 317         // Scroll to selected item whenever it changes, accepts selectedRef from props for recursive trees
 318         const [cachedSelectedRef, setCachedRef] = useState<HTMLDivElement | null>(null)
 319         const selectedRef = props.selectedRef || useCallback((node: HTMLDivElement | null) => {
 320             if (node && node.scrollIntoView && node !== cachedSelectedRef) {
 321                 node.scrollIntoView({ behavior: "smooth", block: "center" });
 322             }
 323             setCachedRef(node);
 324         }, [cachedSelectedRef]);
 325
 326         const { levelIndentation = 20, itemRightPadding = 20 } = props;
 327         return <List className={list}>
 328             {items && items.map((it: TreeItem<T>, idx: number) => {
 329                 return <div key={`item/${level}/${it.id}`}>
 330                     <ListItem button className={listItem}
 331                         style={{
 332                             paddingLeft: (level + 1) * levelIndentation,
 333                             paddingRight: itemRightPadding,
 334                         }}
 335                         disableRipple={disableRipple}
 336                         onClick={event => toggleItemActive(event, it)}
 337                         selected={showSelection(it) && it.id === currentItemUuid}
 338                         onContextMenu={(event) => props.onContextMenu(event, it)}>
 339                         {it.status === TreeItemStatus.PENDING ?
 340                             <CircularProgress size={10} className={loader} /> : null}
 341                         <i onClick={(e) => handleToggleItemOpen(it, e)}
 342                             className={toggableIconContainer}>
 343                             <ListItemIcon className={getToggableIconClassNames(it.open, it.active)}>
 344                                 {getProperArrowAnimation(it.status, it.items!)}
 345                             </ListItemIcon>
 346                         </i>
 347                         {showSelection(it) && !useRadioButtons &&
 348                             <Checkbox
 349                                 checked={it.selected}
 350                                 indeterminate={!it.selected && it.indeterminate}
 351                                 className={classes.checkbox}
 352                                 color="primary"
 353                                 onClick={handleCheckboxChange(it)} />}
 354                         {showSelection(it) && useRadioButtons &&
 355                             <Radio
 356                                 checked={it.selected}
 357                                 className={classes.checkbox}
 358                                 color="primary" />}
 359                         <div className={renderContainer} ref={!!it.active ? selectedRef : undefined}>
 360                             {render(it, level)}
 361                         </div>
 362                     </ListItem>
 363                     {
 364                         it.open && it.items && it.items.length > 0 &&
 365                             it.flatTree ?
 366                             <FlatTree
 367                                 it={it}
 368                                 itemsMap={itemsMap}
 369                                 showSelection={showSelection}
 370                                 classes={props.classes}
 371                                 useRadioButtons={useRadioButtons}
 372                                 levelIndentation={levelIndentation}
 373                                 handleCheckboxChange={handleCheckboxChange}
 374                                 onContextMenu={props.onContextMenu}
 375                                 handleToggleItemOpen={handleToggleItemOpen}
 376                                 toggleItemActive={props.toggleItemActive}
 377                                 getToggableIconClassNames={getToggableIconClassNames}
 378                                 getProperArrowAnimation={getProperArrowAnimation}
 379                                 selectedRef={selectedRef}
 380                             /> :
 381                             <Collapse in={it.open} timeout="auto" unmountOnExit>
 382                                 <Tree
 383                                     showSelection={props.showSelection}
 384                                     items={it.items}
 385                                     render={render}
 386                                     disableRipple={disableRipple}
 387                                     toggleItemOpen={toggleItemOpen}
 388                                     toggleItemActive={toggleItemActive}
 389                                     level={level + 1}
 390                                     onContextMenu={props.onContextMenu}
 391                                     toggleItemSelection={props.toggleItemSelection}
 392                                     selectedRef={selectedRef}
 393                                 />
 394                             </Collapse>
 395                     }
 396                 </div>;
 397             })}
 398         </List>;
 399     }
 400 );