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