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 from "@material-ui/core/List/List";
   7 import ListItem from "@material-ui/core/ListItem/ListItem";
   8 import { StyleRulesCallback, withStyles, WithStyles } from '@material-ui/core/styles';
   9 import { ReactElement } from "react";
  10 import Collapse from "@material-ui/core/Collapse/Collapse";
  11 import CircularProgress from '@material-ui/core/CircularProgress';
  12 import { ArvadosTheme } from '../../common/custom-theme';
  13
  14 type CssRules = 'list' | 'activeArrow' | 'inactiveArrow' | 'arrowRotate' | 'arrowTransition' | 'loader' | 'arrowVisibility';
  15
  16 const styles: StyleRulesCallback<CssRules> = (theme: ArvadosTheme) => ({
  17     list: {
  18         paddingBottom: '3px',
  19         paddingTop: '3px',
  20     },
  21     activeArrow: {
  22         color: theme.palette.primary.main,
  23         position: 'absolute',
  24     },
  25     inactiveArrow: {
  26         color: theme.palette.grey["700"],
  27         position: 'absolute',
  28     },
  29     arrowTransition: {
  30         transition: 'all 0.1s ease',
  31     },
  32     arrowRotate: {
  33         transition: 'all 0.1s ease',
  34         transform: 'rotate(-90deg)',
  35     },
  36     arrowVisibility: {
  37         opacity: 0,
  38     },
  39     loader: {
  40         position: 'absolute',
  41         transform: 'translate(0px)',
  42         top: '3px'
  43     }
  44 });
  45
  46 export enum TreeItemStatus {
  47     Initial,
  48     Pending,
  49     Loaded
  50 }
  51
  52 export interface TreeItem<T> {
  53     data: T;
  54     id: string;
  55     open: boolean;
  56     active: boolean;
  57     status: TreeItemStatus;
  58     toggled?: boolean;
  59     items?: Array<TreeItem<T>>;
  60 }
  61
  62 interface TreeProps<T> {
  63     items?: Array<TreeItem<T>>;
  64     render: (item: TreeItem<T>, level?: number) => ReactElement<{}>;
  65     toggleItemOpen: (id: string, status: TreeItemStatus) => void;
  66     toggleItemActive: (id: string, status: TreeItemStatus) => void;
  67     level?: number;
  68     onContextMenu: (event: React.MouseEvent<HTMLElement>, item: TreeItem<T>) => void;
  69 }
  70
  71 export const Tree = withStyles(styles)(
  72     class Component<T> extends React.Component<TreeProps<T> & WithStyles<CssRules>, {}> {
  73         render(): ReactElement<any> {
  74             const level = this.props.level ? this.props.level : 0;
  75             const { classes, render, toggleItemOpen, items, toggleItemActive, onContextMenu } = this.props;
  76             const { list, inactiveArrow, activeArrow, loader } = classes;
  77             return <List component="div" className={list}>
  78                 {items && items.map((it: TreeItem<T>, idx: number) =>
  79                     <div key={`item/${level}/${idx}`}>
  80                         <ListItem button className={list} style={{ paddingLeft: (level + 1) * 20 }}
  81                                   onClick={() => toggleItemActive(it.id, it.status)}
  82                                   onContextMenu={this.handleRowContextMenu(it)}>
  83                             {it.status === TreeItemStatus.Pending ?
  84                                 <CircularProgress size={10} className={loader}/> : null}
  85                             {it.toggled && it.items && it.items.length === 0 ? null : this.renderArrow(it.status, it.active ? activeArrow : inactiveArrow, it.open, it.id)}
  86                             {render(it, level)}
  87                         </ListItem>
  88                         {it.items && it.items.length > 0 &&
  89                         <Collapse in={it.open} timeout="auto" unmountOnExit>
  90                             <Tree
  91                                 items={it.items}
  92                                 render={render}
  93                                 toggleItemOpen={toggleItemOpen}
  94                                 toggleItemActive={toggleItemActive}
  95                                 level={level + 1}
  96                                 onContextMenu={onContextMenu}/>
  97                         </Collapse>}
  98                     </div>)}
  99             </List>;
 100         }
 101
 102         renderArrow(status: TreeItemStatus, arrowClass: string, open: boolean, id: string) {
 103             const { arrowTransition, arrowVisibility, arrowRotate } = this.props.classes;
 104             return <i onClick={() => this.props.toggleItemOpen(id, status)}
 105                       className={`
 106                         ${arrowClass}
 107                         ${status === TreeItemStatus.Pending ? arrowVisibility : ''}
 108                         ${open ? `fas fa-caret-down ${arrowTransition}` : `fas fa-caret-down ${arrowRotate}`}`}/>;
 109         }
 110
 111         handleRowContextMenu = (item: TreeItem<T>) =>
 112             (event: React.MouseEvent<HTMLElement>) =>
 113                 this.props.onContextMenu(event, item)
 114     }
 115 );