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 } 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         color: theme.palette.grey["500"]
  64     }
  65 });
  66
  67 export enum TreeItemStatus {
  68     INITIAL = 'initial',
  69     PENDING = 'pending',
  70     LOADED = 'loaded'
  71 }
  72
  73 export interface TreeItem<T> {
  74     data: T;
  75     id: string;
  76     open: boolean;
  77     active: boolean;
  78     selected?: boolean;
  79     status: TreeItemStatus;
  80     items?: Array<TreeItem<T>>;
  81 }
  82
  83 export interface TreeProps<T> {
  84     items?: Array<TreeItem<T>>;
  85     render: (item: TreeItem<T>, level?: number) => ReactElement<{}>;
  86     toggleItemOpen: (id: string, status: TreeItemStatus) => void;
  87     toggleItemActive: (id: string, status: TreeItemStatus) => void;
  88     level?: number;
  89     onContextMenu: (event: React.MouseEvent<HTMLElement>, item: TreeItem<T>) => void;
  90     showSelection?: boolean;
  91     onSelectionChange?: (event: React.MouseEvent<HTMLElement>, item: TreeItem<T>) => void;
  92     disableRipple?: boolean;
  93 }
  94
  95 export const Tree = withStyles(styles)(
  96     class Component<T> extends React.Component<TreeProps<T> & WithStyles<CssRules>, {}> {
  97         render(): ReactElement<any> {
  98             const level = this.props.level ? this.props.level : 0;
  99             const { classes, render, toggleItemOpen, items, toggleItemActive, onContextMenu, disableRipple } = this.props;
 100             const { list, listItem, loader, toggableIconContainer, renderContainer } = classes;
 101             return <List component="div" className={list}>
 102                 {items && items.map((it: TreeItem<T>, idx: number) =>
 103                     <div key={`item/${level}/${idx}`}>
 104                         <ListItem button className={listItem} style={{ paddingLeft: (level + 1) * 20 }}
 105                             disableRipple={disableRipple}
 106                             onClick={() => toggleItemActive(it.id, it.status)}
 107                             onContextMenu={this.handleRowContextMenu(it)}>
 108                             {it.status === TreeItemStatus.PENDING ?
 109                                 <CircularProgress size={10} className={loader} /> : null}
 110                             <i onClick={this.handleToggleItemOpen(it.id, it.status)}
 111                                 className={toggableIconContainer}>
 112                                 <ListItemIcon className={this.getToggableIconClassNames(it.open, it.active)}>
 113                                     {this.getProperArrowAnimation(it.status, it.items!)}
 114                                 </ListItemIcon>
 115                             </i>
 116                             {this.props.showSelection &&
 117                                 <Checkbox
 118                                     checked={it.selected}
 119                                     className={classes.checkbox}
 120                                     color="primary"
 121                                     onClick={this.handleCheckboxChange(it)} />}
 122                             <div className={renderContainer}>
 123                                 {render(it, level)}
 124                             </div>
 125                         </ListItem>
 126                         {it.items && it.items.length > 0 &&
 127                             <Collapse in={it.open} timeout="auto" unmountOnExit>
 128                                 <Tree
 129                                     showSelection={this.props.showSelection}
 130                                     items={it.items}
 131                                     render={render}
 132                                     disableRipple={disableRipple}
 133                                     toggleItemOpen={toggleItemOpen}
 134                                     toggleItemActive={toggleItemActive}
 135                                     level={level + 1}
 136                                     onContextMenu={onContextMenu}
 137                                     onSelectionChange={this.props.onSelectionChange} />
 138                             </Collapse>}
 139                     </div>)}
 140             </List>;
 141         }
 142
 143         getProperArrowAnimation = (status: string, items: Array<TreeItem<T>>) => {
 144             return this.isSidePanelIconNotNeeded(status, items) ? <span /> : <SidePanelRightArrowIcon />;
 145         }
 146
 147         isSidePanelIconNotNeeded = (status: string, items: Array<TreeItem<T>>) => {
 148             return status === TreeItemStatus.PENDING ||
 149                 (status === TreeItemStatus.LOADED && !items) ||
 150                 (status === TreeItemStatus.LOADED && items && items.length === 0);
 151         }
 152
 153         getToggableIconClassNames = (isOpen?: boolean, isActive?: boolean) => {
 154             const { iconOpen, iconClose, active, toggableIcon } = this.props.classes;
 155             return classnames(toggableIcon, {
 156                 [iconOpen]: isOpen,
 157                 [iconClose]: !isOpen,
 158                 [active]: isActive
 159             });
 160         }
 161
 162         handleRowContextMenu = (item: TreeItem<T>) =>
 163             (event: React.MouseEvent<HTMLElement>) =>
 164                 this.props.onContextMenu(event, item)
 165
 166         handleCheckboxChange = (item: TreeItem<T>) => {
 167             const { onSelectionChange } = this.props;
 168             return onSelectionChange
 169                 ? (event: React.MouseEvent<HTMLElement>) => {
 170                     onSelectionChange(event, item);
 171                 }
 172                 : undefined;
 173         }
 174
 175         handleToggleItemOpen = (id: string, status: TreeItemStatus) => (event: React.MouseEvent<HTMLElement>) => {
 176             event.stopPropagation();
 177             this.props.toggleItemOpen(id, status);
 178         }
 179     }
 180 );