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