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