15610: Uses a virtualized list to show the collection's file tree. (WIP)
[arvados-workbench2.git] / src / components / tree / tree.tsx
index 3e8cf904cfaae2274d1273bb81f1f77048b34c2a..b5ce5ec50ff9d08346f8aa22b7fc5a6d75f2fb11 100644 (file)
@@ -3,7 +3,7 @@
 // SPDX-License-Identifier: AGPL-3.0
 
 import * as React from 'react';
-import { List, ListItem, ListItemIcon, Collapse, Checkbox } from "@material-ui/core";
+import { List, ListItem, ListItemIcon, Collapse, Checkbox, Radio } from "@material-ui/core";
 import { StyleRulesCallback, withStyles, WithStyles } from '@material-ui/core/styles';
 import { ReactElement } from "react";
 import CircularProgress from '@material-ui/core/CircularProgress';
@@ -60,14 +60,15 @@ const styles: StyleRulesCallback<CssRules> = (theme: ArvadosTheme) => ({
         width: theme.spacing.unit * 3,
         height: theme.spacing.unit * 3,
         margin: `0 ${theme.spacing.unit}px`,
-        color: theme.palette.grey["500"]
+        padding: 0,
+        color: theme.palette.grey["500"],
     }
 });
 
 export enum TreeItemStatus {
-    INITIAL,
-    PENDING,
-    LOADED
+    INITIAL = 'initial',
+    PENDING = 'pending',
+    LOADED = 'loaded'
 }
 
 export interface TreeItem<T> {
@@ -78,47 +79,74 @@ export interface TreeItem<T> {
     selected?: boolean;
     status: TreeItemStatus;
     items?: Array<TreeItem<T>>;
+    level?: number;
 }
 
 export interface TreeProps<T> {
+    disableRipple?: boolean;
+    currentItemUuid?: string;
     items?: Array<TreeItem<T>>;
-    render: (item: TreeItem<T>, level?: number) => ReactElement<{}>;
-    toggleItemOpen: (id: string, status: TreeItemStatus) => void;
-    toggleItemActive: (id: string, status: TreeItemStatus) => void;
     level?: number;
     onContextMenu: (event: React.MouseEvent<HTMLElement>, item: TreeItem<T>) => void;
-    showSelection?: boolean;
-    onSelectionChange?: (event: React.MouseEvent<HTMLElement>, item: TreeItem<T>) => void;
-    disableRipple?: boolean;
+    render: (item: TreeItem<T>, level?: number) => ReactElement<{}>;
+    showSelection?: boolean | ((item: TreeItem<T>) => boolean);
+    levelIndentation?: number;
+    itemRightPadding?: number;
+    toggleItemActive: (event: React.MouseEvent<HTMLElement>, item: TreeItem<T>) => void;
+    toggleItemOpen: (event: React.MouseEvent<HTMLElement>, item: TreeItem<T>) => void;
+    toggleItemSelection?: (event: React.MouseEvent<HTMLElement>, item: TreeItem<T>) => void;
+
+    /**
+     * When set to true use radio buttons instead of checkboxes for item selection.
+     * This does not guarantee radio group behavior (i.e item mutual exclusivity).
+     * Any item selection logic must be done in the toggleItemActive callback prop.
+     */
+    useRadioButtons?: boolean;
 }
 
 export const Tree = withStyles(styles)(
     class Component<T> extends React.Component<TreeProps<T> & WithStyles<CssRules>, {}> {
         render(): ReactElement<any> {
             const level = this.props.level ? this.props.level : 0;
-            const { classes, render, toggleItemOpen, items, toggleItemActive, onContextMenu, disableRipple } = this.props;
+            const { classes, render, toggleItemOpen, items, toggleItemActive, onContextMenu, disableRipple, currentItemUuid, useRadioButtons } = this.props;
             const { list, listItem, loader, toggableIconContainer, renderContainer } = classes;
-            return <List component="div" className={list}>
+            const showSelection = typeof this.props.showSelection === 'function'
+                ? this.props.showSelection
+                : () => this.props.showSelection ? true : false;
+
+            const { levelIndentation = 20, itemRightPadding = 20 } = this.props;
+
+            return <List className={list}>
                 {items && items.map((it: TreeItem<T>, idx: number) =>
                     <div key={`item/${level}/${idx}`}>
-                        <ListItem button className={listItem} style={{ paddingLeft: (level + 1) * 20 }}
+                        <ListItem button className={listItem}
+                            style={{
+                                paddingLeft: (level + 1) * levelIndentation,
+                                paddingRight: itemRightPadding,
+                            }}
                             disableRipple={disableRipple}
-                            onClick={() => toggleItemActive(it.id, it.status)}
+                            onClick={event => toggleItemActive(event, it)}
+                            selected={showSelection(it) && it.id === currentItemUuid}
                             onContextMenu={this.handleRowContextMenu(it)}>
                             {it.status === TreeItemStatus.PENDING ?
                                 <CircularProgress size={10} className={loader} /> : null}
-                            <i onClick={() => this.props.toggleItemOpen(it.id, it.status)}
+                            <i onClick={this.handleToggleItemOpen(it)}
                                 className={toggableIconContainer}>
                                 <ListItemIcon className={this.getToggableIconClassNames(it.open, it.active)}>
-                                    {it.status !== TreeItemStatus.INITIAL && it.items && it.items.length === 0 ? <span /> : <SidePanelRightArrowIcon />}
+                                    {this.getProperArrowAnimation(it.status, it.items!)}
                                 </ListItemIcon>
                             </i>
-                            {this.props.showSelection &&
+                            {showSelection(it) && !useRadioButtons &&
                                 <Checkbox
                                     checked={it.selected}
                                     className={classes.checkbox}
                                     color="primary"
                                     onClick={this.handleCheckboxChange(it)} />}
+                            {showSelection(it) && useRadioButtons &&
+                                <Radio
+                                    checked={it.selected}
+                                    className={classes.checkbox}
+                                    color="primary" />}
                             <div className={renderContainer}>
                                 {render(it, level)}
                             </div>
@@ -134,12 +162,22 @@ export const Tree = withStyles(styles)(
                                     toggleItemActive={toggleItemActive}
                                     level={level + 1}
                                     onContextMenu={onContextMenu}
-                                    onSelectionChange={this.props.onSelectionChange} />
+                                    toggleItemSelection={this.props.toggleItemSelection} />
                             </Collapse>}
                     </div>)}
             </List>;
         }
 
+        getProperArrowAnimation = (status: string, items: Array<TreeItem<T>>) => {
+            return this.isSidePanelIconNotNeeded(status, items) ? <span /> : <SidePanelRightArrowIcon style={{ fontSize: '14px' }} />;
+        }
+
+        isSidePanelIconNotNeeded = (status: string, items: Array<TreeItem<T>>) => {
+            return status === TreeItemStatus.PENDING ||
+                (status === TreeItemStatus.LOADED && !items) ||
+                (status === TreeItemStatus.LOADED && items && items.length === 0);
+        }
+
         getToggableIconClassNames = (isOpen?: boolean, isActive?: boolean) => {
             const { iconOpen, iconClose, active, toggableIcon } = this.props.classes;
             return classnames(toggableIcon, {
@@ -154,12 +192,18 @@ export const Tree = withStyles(styles)(
                 this.props.onContextMenu(event, item)
 
         handleCheckboxChange = (item: TreeItem<T>) => {
-            const { onSelectionChange } = this.props;
-            return onSelectionChange
+            const { toggleItemSelection } = this.props;
+            return toggleItemSelection
                 ? (event: React.MouseEvent<HTMLElement>) => {
-                    onSelectionChange(event, item);
+                    event.stopPropagation();
+                    toggleItemSelection(event, item);
                 }
                 : undefined;
         }
+
+        handleToggleItemOpen = (item: TreeItem<T>) => (event: React.MouseEvent<HTMLElement>) => {
+            event.stopPropagation();
+            this.props.toggleItemOpen(event, item);
+        }
     }
 );