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