19894: Show dirty indicator on process type filter
[arvados-workbench2.git] / src / components / tree / tree.tsx
index 93e90c7772ef924f98b534ca5d1ac1f8e7c976d6..fc9dbc743ae19a15d59172bd2c30734eb223cd11 100644 (file)
 //
 // SPDX-License-Identifier: AGPL-3.0
 
-import * as React from 'react';
-import List from "@material-ui/core/List/List";
-import ListItem from "@material-ui/core/ListItem/ListItem";
+import React from 'react';
+import { List, ListItem, ListItemIcon, Checkbox, Radio, Collapse } from "@material-ui/core";
+import { StyleRulesCallback, withStyles, WithStyles } from '@material-ui/core/styles';
+import { CollectionIcon, DefaultIcon, DirectoryIcon, FileIcon, ProjectIcon, FilterGroupIcon } from 'components/icon/icon';
 import { ReactElement } from "react";
-import Collapse from "@material-ui/core/Collapse/Collapse";
+import CircularProgress from '@material-ui/core/CircularProgress';
+import classnames from "classnames";
+
+import { ArvadosTheme } from 'common/custom-theme';
+import { SidePanelRightArrowIcon } from '../icon/icon';
+import { ResourceKind } from 'models/resource';
+import { GroupClass } from 'models/group';
+
+type CssRules = 'list'
+    | 'listItem'
+    | 'active'
+    | 'loader'
+    | 'toggableIconContainer'
+    | 'iconClose'
+    | 'renderContainer'
+    | 'iconOpen'
+    | 'toggableIcon'
+    | 'checkbox'
+    | 'childItem'
+    | 'childItemIcon';
+
+const styles: StyleRulesCallback<CssRules> = (theme: ArvadosTheme) => ({
+    list: {
+        padding: '3px 0px'
+    },
+    listItem: {
+        padding: '3px 0px',
+    },
+    loader: {
+        position: 'absolute',
+        transform: 'translate(0px)',
+        top: '3px'
+    },
+    toggableIconContainer: {
+        color: theme.palette.grey["700"],
+        height: '14px',
+        width: '14px',
+    },
+    toggableIcon: {
+        fontSize: '14px'
+    },
+    renderContainer: {
+        flex: 1
+    },
+    iconClose: {
+        transition: 'all 0.1s ease',
+    },
+    iconOpen: {
+        transition: 'all 0.1s ease',
+        transform: 'rotate(90deg)',
+    },
+    checkbox: {
+        width: theme.spacing.unit * 3,
+        height: theme.spacing.unit * 3,
+        margin: `0 ${theme.spacing.unit}px`,
+        padding: 0,
+        color: theme.palette.grey["500"],
+    },
+    childItem: {
+        cursor: 'pointer',
+        display: 'flex',
+        padding: '3px 20px',
+        fontSize: '0.875rem',
+        alignItems: 'center',
+        '&:hover': {
+            backgroundColor: 'rgba(0, 0, 0, 0.08)',
+        }
+    },
+    childItemIcon: {
+        marginLeft: '8px',
+        marginRight: '16px',
+        color: 'rgba(0, 0, 0, 0.54)',
+    },
+    active: {
+        color: theme.palette.primary.main,
+    },
+});
+
+export enum TreeItemStatus {
+    INITIAL = 'initial',
+    PENDING = 'pending',
+    LOADED = 'loaded'
+}
 
 export interface TreeItem<T> {
     data: T;
     id: string;
     open: boolean;
+    active: boolean;
+    selected?: boolean;
+    initialState?: boolean;
+    indeterminate?: boolean;
+    flatTree?: boolean;
+    status: TreeItemStatus;
     items?: Array<TreeItem<T>>;
 }
 
-interface TreeProps<T> {
+export interface TreeProps<T> {
+    disableRipple?: boolean;
+    currentItemUuid?: string;
     items?: Array<TreeItem<T>>;
-    render: (item: T) => ReactElement<{}>;
-    toggleItem: (id: string) => any;
     level?: number;
+    itemsMap?: Map<string, TreeItem<T>>;
+    onContextMenu: (event: React.MouseEvent<HTMLElement>, item: TreeItem<T>) => void;
+    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;
 }
 
-class Tree<T> extends React.Component<TreeProps<T>, {}> {
-    render(): ReactElement<any> {
-        const level = this.props.level ? this.props.level : 0;
-        return <List component="div">
-            {this.props.items && this.props.items.map((it: TreeItem<T>, idx: number) =>
-             <div key={`item/${level}/${idx}`}>      
-                <ListItem button onClick={() => this.props.toggleItem(it.id)} style={{paddingLeft: (level + 1) * 20}}>  
-                    <i style={{marginRight: "10px"}} className={it.open ? "fas fa-caret-down" : "fas fa-caret-right"} />
-                    {this.props.render(it.data)}
-                </ListItem>
-                {it.items && it.items.length > 0 &&
-                <Collapse in={it.open} timeout="auto" unmountOnExit>
-                    <Tree items={it.items}
-                        render={this.props.render}
-                        toggleItem={this.props.toggleItem}
-                        level={level + 1}/>
-                </Collapse>}
-             </div>)}
-        </List>
+const getActionAndId = (event: any, initAction: string | undefined = undefined) => {
+    const { nativeEvent: { target } } = event;
+    let currentTarget: HTMLElement = target as HTMLElement;
+    let action: string | undefined = initAction || currentTarget.dataset.action;
+    let id: string | undefined = currentTarget.dataset.id;
+
+    while (action === undefined || id === undefined) {
+        currentTarget = currentTarget.parentElement as HTMLElement;
+
+        if (!currentTarget) {
+            break;
+        }
+
+        action = action || currentTarget.dataset.action;
+        id = id || currentTarget.dataset.id;
     }
+
+    return [action, id];
+};
+
+interface FlatTreeProps {
+    it: TreeItem<any>;
+    levelIndentation: number;
+    onContextMenu: Function;
+    handleToggleItemOpen: Function;
+    toggleItemActive: Function;
+    getToggableIconClassNames: Function;
+    getProperArrowAnimation: Function;
+    itemsMap?: Map<string, TreeItem<any>>;
+    classes: any;
+    showSelection: any;
+    useRadioButtons?: boolean;
+    handleCheckboxChange: Function;
 }
 
-export default Tree;
+const FLAT_TREE_ACTIONS = {
+    toggleOpen: 'TOGGLE_OPEN',
+    contextMenu: 'CONTEXT_MENU',
+    toggleActive: 'TOGGLE_ACTIVE',
+};
+
+const ItemIcon = React.memo(({ type, kind, active, groupClass, classes }: any) => {
+    let Icon = ProjectIcon;
+
+    if (groupClass === GroupClass.FILTER) {
+        Icon = FilterGroupIcon;
+    }
+
+    if (type) {
+        switch (type) {
+            case 'directory':
+                Icon = DirectoryIcon;
+                break;
+            case 'file':
+                Icon = FileIcon;
+                break;
+            default:
+                Icon = DefaultIcon;
+        }
+    }
+
+    if (kind) {
+        switch (kind) {
+            case ResourceKind.COLLECTION:
+                Icon = CollectionIcon;
+                break;
+            default:
+                break;
+        }
+    }
+
+    return <Icon className={classnames({ [classes.active]: active }, classes.childItemIcon)} />;
+});
+
+const FlatTree = (props: FlatTreeProps) =>
+    <div
+        onContextMenu={(event) => {
+            const id = getActionAndId(event, FLAT_TREE_ACTIONS.contextMenu)[1];
+            props.onContextMenu(event, { id } as any);
+        }}
+        onClick={(event) => {
+            const [action, id] = getActionAndId(event);
+
+            if (action && id) {
+                const item = props.itemsMap ? props.itemsMap[id] : { id };
+
+                switch (action) {
+                    case FLAT_TREE_ACTIONS.toggleOpen:
+                        props.handleToggleItemOpen(item as any, event);
+                        break;
+                    case FLAT_TREE_ACTIONS.toggleActive:
+                        props.toggleItemActive(event, item as any);
+                        break;
+                    default:
+                        break;
+                }
+            }
+        }}
+    >
+        {
+            (props.it.items || [])
+                .map((item: any) => <div key={item.id} data-id={item.id}
+                    className={classnames(props.classes.childItem, { [props.classes.active]: item.active })}
+                    style={{ paddingLeft: `${item.depth * props.levelIndentation}px` }}>
+                    <i data-action={FLAT_TREE_ACTIONS.toggleOpen} className={props.classes.toggableIconContainer}>
+                        <ListItemIcon className={props.getToggableIconClassNames(item.open, item.active)}>
+                            {props.getProperArrowAnimation(item.status, item.items!)}
+                        </ListItemIcon>
+                    </i>
+                    {props.showSelection(item) && !props.useRadioButtons &&
+                        <Checkbox
+                            checked={item.selected}
+                            className={props.classes.checkbox}
+                            color="primary"
+                            onClick={props.handleCheckboxChange(item)} />}
+                    {props.showSelection(item) && props.useRadioButtons &&
+                        <Radio
+                            checked={item.selected}
+                            className={props.classes.checkbox}
+                            color="primary" />}
+                    <div data-action={FLAT_TREE_ACTIONS.toggleActive} className={props.classes.renderContainer}>
+                        <span style={{ display: 'flex', alignItems: 'center' }}>
+                            <ItemIcon type={item.data.type} active={item.active} kind={item.data.kind} groupClass={item.data.kind === ResourceKind.GROUP ? item.data.groupClass : ''} classes={props.classes} />
+                            <span style={{ fontSize: '0.875rem' }}>
+                                {item.data.name}
+                            </span>
+                        </span>
+                    </div>
+                </div>)
+        }
+    </div>;
+
+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, items, toggleItemActive, toggleItemOpen, disableRipple, currentItemUuid, useRadioButtons, itemsMap } = this.props;
+            const { list, listItem, loader, toggableIconContainer, renderContainer } = classes;
+            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}/${it.id}`}>
+                        <ListItem button className={listItem}
+                            style={{
+                                paddingLeft: (level + 1) * levelIndentation,
+                                paddingRight: itemRightPadding,
+                            }}
+                            disableRipple={disableRipple}
+                            onClick={event => toggleItemActive(event, it)}
+                            selected={showSelection(it) && it.id === currentItemUuid}
+                            onContextMenu={(event) => this.props.onContextMenu(event, it)}>
+                            {it.status === TreeItemStatus.PENDING ?
+                                <CircularProgress size={10} className={loader} /> : null}
+                            <i onClick={(e) => this.handleToggleItemOpen(it, e)}
+                                className={toggableIconContainer}>
+                                <ListItemIcon className={this.getToggableIconClassNames(it.open, it.active)}>
+                                    {this.getProperArrowAnimation(it.status, it.items!)}
+                                </ListItemIcon>
+                            </i>
+                            {showSelection(it) && !useRadioButtons &&
+                                <Checkbox
+                                    checked={it.selected}
+                                    indeterminate={!it.selected && it.indeterminate}
+                                    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>
+                        </ListItem>
+                        {
+                            it.open && it.items && it.items.length > 0 &&
+                                it.flatTree ?
+                                <FlatTree
+                                    it={it}
+                                    itemsMap={itemsMap}
+                                    showSelection={showSelection}
+                                    classes={this.props.classes}
+                                    useRadioButtons={useRadioButtons}
+                                    levelIndentation={levelIndentation}
+                                    handleCheckboxChange={this.handleCheckboxChange}
+                                    onContextMenu={this.props.onContextMenu}
+                                    handleToggleItemOpen={this.handleToggleItemOpen}
+                                    toggleItemActive={this.props.toggleItemActive}
+                                    getToggableIconClassNames={this.getToggableIconClassNames}
+                                    getProperArrowAnimation={this.getProperArrowAnimation}
+                                /> :
+                                <Collapse in={it.open} timeout="auto" unmountOnExit>
+                                    <Tree
+                                        showSelection={this.props.showSelection}
+                                        items={it.items}
+                                        render={render}
+                                        disableRipple={disableRipple}
+                                        toggleItemOpen={toggleItemOpen}
+                                        toggleItemActive={toggleItemActive}
+                                        level={level + 1}
+                                        onContextMenu={this.props.onContextMenu}
+                                        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, {
+                [iconOpen]: isOpen,
+                [iconClose]: !isOpen,
+                [active]: isActive
+            });
+        }
+
+        handleCheckboxChange = (item: TreeItem<T>) => {
+            const { toggleItemSelection } = this.props;
+            return toggleItemSelection
+                ? (event: React.MouseEvent<HTMLElement>) => {
+                    event.stopPropagation();
+                    toggleItemSelection(event, item);
+                }
+                : undefined;
+        }
+
+        handleToggleItemOpen = (item: TreeItem<T>, event: React.MouseEvent<HTMLElement>) => {
+            event.stopPropagation();
+            this.props.toggleItemOpen(event, item);
+        }
+    }
+);