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, Collapse, 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 * as 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
  26 const styles: StyleRulesCallback<CssRules> = (theme: ArvadosTheme) => ({
  27     list: {
  28         padding: '3px 0px'
  29     },
  30     listItem: {
  31         padding: '3px 0px',
  32     },
  33     loader: {
  34         position: 'absolute',
  35         transform: 'translate(0px)',
  36         top: '3px'
  37     },
  38     toggableIconContainer: {
  39         color: theme.palette.grey["700"],
  40         height: '14px',
  41         width: '14px',
  42     },
  43     toggableIcon: {
  44         fontSize: '14px'
  45     },
  46     renderContainer: {
  47         flex: 1
  48     },
  49     active: {
  50         color: theme.palette.primary.main,
  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 });
  67
  68 export enum TreeItemStatus {
  69     INITIAL = 'initial',
  70     PENDING = 'pending',
  71     LOADED = 'loaded'
  72 }
  73
  74 export interface TreeItem<T> {
  75     data: T;
  76     id: string;
  77     open: boolean;
  78     active: boolean;
  79     selected?: boolean;
  80     status: TreeItemStatus;
  81     items?: Array<TreeItem<T>>;
  82     itemCount?: number;
  83     level?: number;
  84 }
  85
  86 export interface TreeProps<T> {
  87     disableRipple?: boolean;
  88     currentItemUuid?: string;
  89     items?: Array<TreeItem<T>>;
  90     level?: number;
  91     onContextMenu: (event: React.MouseEvent<HTMLElement>, item: TreeItem<T>) => void;
  92     render: (item: TreeItem<T>, level?: number) => ReactElement<{}>;
  93     showSelection?: boolean | ((item: TreeItem<T>) => boolean);
  94     levelIndentation?: number;
  95     itemRightPadding?: number;
  96     toggleItemActive: (event: React.MouseEvent<HTMLElement>, item: TreeItem<T>) => void;
  97     toggleItemOpen: (event: React.MouseEvent<HTMLElement>, item: TreeItem<T>) => void;
  98     toggleItemSelection?: (event: React.MouseEvent<HTMLElement>, item: TreeItem<T>) => void;
  99
 100     /**
 101      * When set to true use radio buttons instead of checkboxes for item selection.
 102      * This does not guarantee radio group behavior (i.e item mutual exclusivity).
 103      * Any item selection logic must be done in the toggleItemActive callback prop.
 104      */
 105     useRadioButtons?: boolean;
 106 }
 107
 108 export const Tree = withStyles(styles)(
 109     class Component<T> extends React.Component<TreeProps<T> & WithStyles<CssRules>, {}> {
 110         render(): ReactElement<any> {
 111             const level = this.props.level ? this.props.level : 0;
 112             const { classes, render, toggleItemOpen, items, toggleItemActive, onContextMenu, disableRipple, currentItemUuid, useRadioButtons } = this.props;
 113             const { list, listItem, loader, toggableIconContainer, renderContainer } = classes;
 114             const showSelection = typeof this.props.showSelection === 'function'
 115                 ? this.props.showSelection
 116                 : () => this.props.showSelection ? true : false;
 117
 118             const { levelIndentation = 20, itemRightPadding = 20 } = this.props;
 119
 120             return <List className={list}>
 121                 {items && items.map((it: TreeItem<T>, idx: number) =>
 122                     <div key={`item/${level}/${idx}`}>
 123                         <ListItem button className={listItem}
 124                             style={{
 125                                 paddingLeft: (level + 1) * levelIndentation,
 126                                 paddingRight: itemRightPadding,
 127                             }}
 128                             disableRipple={disableRipple}
 129                             onClick={event => toggleItemActive(event, it)}
 130                             selected={showSelection(it) && it.id === currentItemUuid}
 131                             onContextMenu={this.handleRowContextMenu(it)}>
 132                             {it.status === TreeItemStatus.PENDING ?
 133                                 <CircularProgress size={10} className={loader} /> : null}
 134                             <i onClick={this.handleToggleItemOpen(it)}
 135                                 className={toggableIconContainer}>
 136                                 <ListItemIcon className={this.getToggableIconClassNames(it.open, it.active)}>
 137                                     {this.getProperArrowAnimation(it.status, it.items!)}
 138                                 </ListItemIcon>
 139                             </i>
 140                             {showSelection(it) && !useRadioButtons &&
 141                                 <Checkbox
 142                                     checked={it.selected}
 143                                     className={classes.checkbox}
 144                                     color="primary"
 145                                     onClick={this.handleCheckboxChange(it)} />}
 146                             {showSelection(it) && useRadioButtons &&
 147                                 <Radio
 148                                     checked={it.selected}
 149                                     className={classes.checkbox}
 150                                     color="primary" />}
 151                             <div className={renderContainer}>
 152                                 {render(it, level)}
 153                             </div>
 154                         </ListItem>
 155                         {it.items && it.items.length > 0 &&
 156                             <Collapse in={it.open} timeout="auto" unmountOnExit>
 157                                 <Tree
 158                                     showSelection={this.props.showSelection}
 159                                     items={it.items}
 160                                     render={render}
 161                                     disableRipple={disableRipple}
 162                                     toggleItemOpen={toggleItemOpen}
 163                                     toggleItemActive={toggleItemActive}
 164                                     level={level + 1}
 165                                     onContextMenu={onContextMenu}
 166                                     toggleItemSelection={this.props.toggleItemSelection} />
 167                             </Collapse>}
 168                     </div>)}
 169             </List>;
 170         }
 171
 172         getProperArrowAnimation = (status: string, items: Array<TreeItem<T>>) => {
 173             return this.isSidePanelIconNotNeeded(status, items) ? <span /> : <SidePanelRightArrowIcon style={{ fontSize: '14px' }} />;
 174         }
 175
 176         isSidePanelIconNotNeeded = (status: string, items: Array<TreeItem<T>>) => {
 177             return status === TreeItemStatus.PENDING ||
 178                 (status === TreeItemStatus.LOADED && !items) ||
 179                 (status === TreeItemStatus.LOADED && items && items.length === 0);
 180         }
 181
 182         getToggableIconClassNames = (isOpen?: boolean, isActive?: boolean) => {
 183             const { iconOpen, iconClose, active, toggableIcon } = this.props.classes;
 184             return classnames(toggableIcon, {
 185                 [iconOpen]: isOpen,
 186                 [iconClose]: !isOpen,
 187                 [active]: isActive
 188             });
 189         }
 190
 191         handleRowContextMenu = (item: TreeItem<T>) =>
 192             (event: React.MouseEvent<HTMLElement>) =>
 193                 this.props.onContextMenu(event, item)
 194
 195         handleCheckboxChange = (item: TreeItem<T>) => {
 196             const { toggleItemSelection } = this.props;
 197             return toggleItemSelection
 198                 ? (event: React.MouseEvent<HTMLElement>) => {
 199                     event.stopPropagation();
 200                     toggleItemSelection(event, item);
 201                 }
 202                 : undefined;
 203         }
 204
 205         handleToggleItemOpen = (item: TreeItem<T>) => (event: React.MouseEvent<HTMLElement>) => {
 206             event.stopPropagation();
 207             this.props.toggleItemOpen(event, item);
 208         }
 209     }
 210 );