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 }
  83
  84 export interface TreeProps<T> {
  85     disableRipple?: boolean;
  86     currentItemUuid?: string;
  87     items?: Array<TreeItem<T>>;
  88     level?: number;
  89     onContextMenu: (event: React.MouseEvent<HTMLElement>, item: TreeItem<T>) => void;
  90     render: (item: TreeItem<T>, level?: number) => ReactElement<{}>;
  91     showSelection?: boolean | ((item: TreeItem<T>) => boolean);
  92     levelIndentation?: number;
  93     itemRightPadding?: number;
  94     toggleItemActive: (event: React.MouseEvent<HTMLElement>, item: TreeItem<T>) => void;
  95     toggleItemOpen: (event: React.MouseEvent<HTMLElement>, item: TreeItem<T>) => void;
  96     toggleItemSelection?: (event: React.MouseEvent<HTMLElement>, item: TreeItem<T>) => void;
  97
  98     /**
  99      * When set to true use radio buttons instead of checkboxes for item selection.
 100      * This does not guarantee radio group behavior (i.e item mutual exclusivity).
 101      * Any item selection logic must be done in the toggleItemRadioButton callback prop.
 102      */
 103     useRadioButtons?: boolean;
 104
 105     /**
 106      * Called when selection of an item in the tree is toggled via a radio button.
 107      * Use this callback prop to implement any selection logic (i.e item mutual exclusivity).
 108      */
 109     toggleItemRadioButton?: (item: TreeItem<T>) => void;
 110 }
 111
 112 export const Tree = withStyles(styles)(
 113     class Component<T> extends React.Component<TreeProps<T> & WithStyles<CssRules>, {}> {
 114         render(): ReactElement<any> {
 115             const level = this.props.level ? this.props.level : 0;
 116             const { classes, render, toggleItemOpen, items, toggleItemActive, onContextMenu, disableRipple, currentItemUuid, useRadioButtons } = this.props;
 117             const { list, listItem, loader, toggableIconContainer, renderContainer } = classes;
 118             const showSelection = typeof this.props.showSelection === 'function'
 119                 ? this.props.showSelection
 120                 : () => this.props.showSelection ? true : false;
 121
 122             const { levelIndentation = 20, itemRightPadding = 20 } = this.props;
 123
 124             return <List className={list}>
 125                 {items && items.map((it: TreeItem<T>, idx: number) =>
 126                     <div key={`item/${level}/${idx}`}>
 127                         <ListItem button className={listItem}
 128                             style={{
 129                                 paddingLeft: (level + 1) * levelIndentation,
 130                                 paddingRight: itemRightPadding,
 131                             }}
 132                             disableRipple={disableRipple}
 133                             onClick={event => toggleItemActive(event, it)}
 134                             selected={showSelection(it) && it.id === currentItemUuid}
 135                             onContextMenu={this.handleRowContextMenu(it)}>
 136                             {it.status === TreeItemStatus.PENDING ?
 137                                 <CircularProgress size={10} className={loader} /> : null}
 138                             <i onClick={this.handleToggleItemOpen(it)}
 139                                 className={toggableIconContainer}>
 140                                 <ListItemIcon className={this.getToggableIconClassNames(it.open, it.active)}>
 141                                     {this.getProperArrowAnimation(it.status, it.items!)}
 142                                 </ListItemIcon>
 143                             </i>
 144                             {showSelection(it) && !useRadioButtons &&
 145                                 <Checkbox
 146                                     checked={it.selected}
 147                                     className={classes.checkbox}
 148                                     color="primary"
 149                                     onClick={this.handleCheckboxChange(it)} />}
 150                             {showSelection(it) && useRadioButtons &&
 151                                 <Radio
 152                                     checked={it.selected}
 153                                     className={classes.checkbox}
 154                                     color="primary"
 155                                     onChange={this.handleRadioButtonChange(it)} />}
 156                             <div className={renderContainer}>
 157                                 {render(it, level)}
 158                             </div>
 159                         </ListItem>
 160                         {it.items && it.items.length > 0 &&
 161                             <Collapse in={it.open} timeout="auto" unmountOnExit>
 162                                 <Tree
 163                                     showSelection={this.props.showSelection}
 164                                     items={it.items}
 165                                     render={render}
 166                                     disableRipple={disableRipple}
 167                                     toggleItemOpen={toggleItemOpen}
 168                                     toggleItemActive={toggleItemActive}
 169                                     level={level + 1}
 170                                     onContextMenu={onContextMenu}
 171                                     toggleItemSelection={this.props.toggleItemSelection} />
 172                             </Collapse>}
 173                     </div>)}
 174             </List>;
 175         }
 176
 177         getProperArrowAnimation = (status: string, items: Array<TreeItem<T>>) => {
 178             return this.isSidePanelIconNotNeeded(status, items) ? <span /> : <SidePanelRightArrowIcon style={{ fontSize: '14px' }} />;
 179         }
 180
 181         isSidePanelIconNotNeeded = (status: string, items: Array<TreeItem<T>>) => {
 182             return status === TreeItemStatus.PENDING ||
 183                 (status === TreeItemStatus.LOADED && !items) ||
 184                 (status === TreeItemStatus.LOADED && items && items.length === 0);
 185         }
 186
 187         getToggableIconClassNames = (isOpen?: boolean, isActive?: boolean) => {
 188             const { iconOpen, iconClose, active, toggableIcon } = this.props.classes;
 189             return classnames(toggableIcon, {
 190                 [iconOpen]: isOpen,
 191                 [iconClose]: !isOpen,
 192                 [active]: isActive
 193             });
 194         }
 195
 196         handleRowContextMenu = (item: TreeItem<T>) =>
 197             (event: React.MouseEvent<HTMLElement>) =>
 198                 this.props.onContextMenu(event, item)
 199
 200         handleCheckboxChange = (item: TreeItem<T>) => {
 201             const { toggleItemSelection } = this.props;
 202             return toggleItemSelection
 203                 ? (event: React.MouseEvent<HTMLElement>) => {
 204                     event.stopPropagation();
 205                     toggleItemSelection(event, item);
 206                 }
 207                 : undefined;
 208         }
 209
 210         handleRadioButtonChange = (item: TreeItem<T>) => {
 211             const { toggleItemRadioButton } = this.props;
 212             return toggleItemRadioButton
 213                 ? (event: React.ChangeEvent<HTMLInputElement>, checked: boolean) => {
 214                     event.stopPropagation();
 215                     toggleItemRadioButton(item);
 216                 }
 217                 : undefined;
 218         }
 219
 220         handleToggleItemOpen = (item: TreeItem<T>) => (event: React.MouseEvent<HTMLElement>) => {
 221             event.stopPropagation();
 222             this.props.toggleItemOpen(event, item);
 223         }
 224     }
 225 );