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