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