//
// SPDX-License-Identifier: AGPL-3.0
-import * as React from 'react';
-import { List, ListItem, ListItemIcon, Collapse, Checkbox, Radio } from "@material-ui/core";
+import React, { useCallback, useState } 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, ProcessIcon, FilterGroupIcon, FreezeIcon } from 'components/icon/icon';
import { ReactElement } from "react";
import CircularProgress from '@material-ui/core/CircularProgress';
-import * as classnames from "classnames";
+import classnames from "classnames";
-import { ArvadosTheme } from '~/common/custom-theme';
+import { ArvadosTheme } from 'common/custom-theme';
import { SidePanelRightArrowIcon } from '../icon/icon';
+import { ResourceKind } from 'models/resource';
+import { GroupClass } from 'models/group';
+import { SidePanelTreeCategory } from 'store/side-panel-tree/side-panel-tree-actions';
type CssRules = 'list'
| 'listItem'
| 'renderContainer'
| 'iconOpen'
| 'toggableIcon'
- | 'checkbox';
+ | 'checkbox'
+ | 'childItem'
+ | 'childItemIcon'
+ | 'frozenIcon'
+ | 'indentSpacer';
const styles: StyleRulesCallback<CssRules> = (theme: ArvadosTheme) => ({
list: {
color: theme.palette.grey["700"],
height: '14px',
width: '14px',
+ marginBottom: '0.4rem',
},
toggableIcon: {
- fontSize: '14px'
+ fontSize: '14px',
},
renderContainer: {
flex: 1
},
- active: {
- color: theme.palette.primary.main,
- },
iconClose: {
transition: 'all 0.1s ease',
},
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,
+ },
+ frozenIcon: {
+ fontSize: 20,
+ color: theme.palette.grey["600"],
+ marginLeft: '10px',
+ },
+ indentSpacer: {
+ width: '0.25rem'
}
});
export interface TreeItem<T> {
data: T;
+ depth?: number;
id: string;
open: boolean;
active: boolean;
selected?: boolean;
+ initialState?: boolean;
+ indeterminate?: boolean;
+ flatTree?: boolean;
status: TreeItemStatus;
items?: Array<TreeItem<T>>;
+ isFrozen?: boolean;
}
export interface TreeProps<T> {
currentItemUuid?: string;
items?: Array<TreeItem<T>>;
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);
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;
+ selectedRef?: (node: HTMLDivElement | null) => 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 toggleItemRadioButton callback prop.
+ * Any item selection logic must be done in the toggleItemActive callback prop.
*/
useRadioButtons?: boolean;
+}
- /**
- * Called when selection of an item in the tree is toggled via a radio button.
- * Use this callback prop to implement any selection logic (i.e item mutual exclusivity).
- */
- toggleItemRadioButton?: (item: TreeItem<T>) => void;
+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];
+};
+
+const isInFavoritesTree = (item: TreeItem<any>): boolean => {
+ return item.id === SidePanelTreeCategory.FAVORITES || item.id === SidePanelTreeCategory.PUBLIC_FAVORITES;
}
-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, currentItemUuid, useRadioButtons } = 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}/${idx}`}>
- <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={this.handleRowContextMenu(it)}>
- {it.status === TreeItemStatus.PENDING ?
- <CircularProgress size={10} className={loader} /> : null}
- <i onClick={this.handleToggleItemOpen(it)}
- 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}
- className={classes.checkbox}
- color="primary"
- onClick={this.handleCheckboxChange(it)} />}
- {showSelection(it) && useRadioButtons &&
- <Radio
- checked={it.selected}
- className={classes.checkbox}
- color="primary"
- onChange={this.handleRadioButtonChange(it)} />}
- <div className={renderContainer}>
- {render(it, level)}
- </div>
- </ListItem>
- {it.items && it.items.length > 0 &&
- <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={onContextMenu}
- toggleItemSelection={this.props.toggleItemSelection} />
- </Collapse>}
- </div>)}
- </List>;
+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;
+ selectedRef?: (node: HTMLDivElement | null) => void;
+}
+
+const FLAT_TREE_ACTIONS = {
+ toggleOpen: 'TOGGLE_OPEN',
+ contextMenu: 'CONTEXT_MENU',
+ toggleActive: 'TOGGLE_ACTIVE',
+};
+
+const ItemIcon = React.memo(({ type, kind, headKind, 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;
}
+ }
- getProperArrowAnimation = (status: string, items: Array<TreeItem<T>>) => {
- return this.isSidePanelIconNotNeeded(status, items) ? <span /> : <SidePanelRightArrowIcon style={{ fontSize: '14px' }} />;
+ if (kind) {
+ if(kind === ResourceKind.LINK && headKind) kind = headKind;
+ switch (kind) {
+ case ResourceKind.COLLECTION:
+ Icon = CollectionIcon;
+ break;
+ case ResourceKind.CONTAINER_REQUEST:
+ Icon = ProcessIcon;
+ 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 };
- isSidePanelIconNotNeeded = (status: string, items: Array<TreeItem<T>>) => {
+ 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` }}>
+ {isInFavoritesTree(props.it) ?
+ <div className={props.classes.indentSpacer} />
+ :
+ <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} ref={item.active ? props.selectedRef : undefined}>
+ <span style={{ display: 'flex', alignItems: 'center' }}>
+ <ItemIcon type={item.data.type} active={item.active} kind={item.data.kind} headKind={item.data.headKind || null} groupClass={item.data.kind === ResourceKind.GROUP ? item.data.groupClass : ''} classes={props.classes} />
+ <span style={{ fontSize: '0.875rem' }}>
+ {item.data.name}
+ </span>
+ {
+ !!item.data.frozenByUuid ? <FreezeIcon className={props.classes.frozenIcon} /> : null
+ }
+ </span>
+ </div>
+ </div>)
+ }
+ </div>;
+
+export const Tree = withStyles(styles)(
+ function<T>(props: TreeProps<T> & WithStyles<CssRules>) {
+ const level = props.level ? props.level : 0;
+ const { classes, render, items, toggleItemActive, toggleItemOpen, disableRipple, currentItemUuid, useRadioButtons, itemsMap } = props;
+ const { list, listItem, loader, toggableIconContainer, renderContainer } = classes;
+ const showSelection = typeof props.showSelection === 'function'
+ ? props.showSelection
+ : () => props.showSelection ? true : false;
+
+ const getProperArrowAnimation = (status: string, items: Array<TreeItem<T>>) => {
+ return isSidePanelIconNotNeeded(status, items) ? <span /> : <SidePanelRightArrowIcon style={{ fontSize: '14px' }} />;
+ }
+
+ const 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;
+ const getToggableIconClassNames = (isOpen?: boolean, isActive?: boolean) => {
+ const { iconOpen, iconClose, active, toggableIcon } = props.classes;
return classnames(toggableIcon, {
[iconOpen]: isOpen,
[iconClose]: !isOpen,
});
}
- handleRowContextMenu = (item: TreeItem<T>) =>
- (event: React.MouseEvent<HTMLElement>) =>
- this.props.onContextMenu(event, item)
-
- handleCheckboxChange = (item: TreeItem<T>) => {
- const { toggleItemSelection } = this.props;
+ const handleCheckboxChange = (item: TreeItem<T>) => {
+ const { toggleItemSelection } = props;
return toggleItemSelection
? (event: React.MouseEvent<HTMLElement>) => {
event.stopPropagation();
: undefined;
}
- handleRadioButtonChange = (item: TreeItem<T>) => {
- const { toggleItemRadioButton } = this.props;
- return toggleItemRadioButton
- ? (event: React.ChangeEvent<HTMLInputElement>, checked: boolean) => {
- event.stopPropagation();
- toggleItemRadioButton(item);
- }
- : undefined;
- }
-
- handleToggleItemOpen = (item: TreeItem<T>) => (event: React.MouseEvent<HTMLElement>) => {
+ const handleToggleItemOpen = (item: TreeItem<T>, event: React.MouseEvent<HTMLElement>) => {
event.stopPropagation();
- this.props.toggleItemOpen(event, item);
+ props.toggleItemOpen(event, item);
}
+
+ // Scroll to selected item whenever it changes, accepts selectedRef from props for recursive trees
+ const [cachedSelectedRef, setCachedRef] = useState<HTMLDivElement | null>(null)
+ const selectedRef = props.selectedRef || useCallback((node: HTMLDivElement | null) => {
+ if (node && node.scrollIntoView && node !== cachedSelectedRef) {
+ node.scrollIntoView({ behavior: "smooth", block: "center" });
+ }
+ setCachedRef(node);
+ }, [cachedSelectedRef]);
+
+ const { levelIndentation = 20, itemRightPadding = 20 } = props;
+ return <List className={list}>
+ {items && items.map((it: TreeItem<T>, idx: number) => {
+ if (isInFavoritesTree(it) && it.open === true && it.items && it.items.length) {
+ it = { ...it, items: it.items.filter(item => item.depth && item.depth < 3) }
+ }
+ return <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) => props.onContextMenu(event, it)}>
+ {it.status === TreeItemStatus.PENDING ?
+ <CircularProgress size={10} className={loader} /> : null}
+ <i onClick={(e) => handleToggleItemOpen(it, e)}
+ className={toggableIconContainer}>
+ <ListItemIcon className={getToggableIconClassNames(it.open, it.active)}>
+ {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={handleCheckboxChange(it)} />}
+ {showSelection(it) && useRadioButtons &&
+ <Radio
+ checked={it.selected}
+ className={classes.checkbox}
+ color="primary" />}
+ <div className={renderContainer} ref={!!it.active ? selectedRef : undefined}>
+ {render(it, level)}
+ </div>
+ </ListItem>
+ {
+ it.open && it.items && it.items.length > 0 &&
+ it.flatTree ?
+ <FlatTree
+ it={it}
+ itemsMap={itemsMap}
+ showSelection={showSelection}
+ classes={props.classes}
+ useRadioButtons={useRadioButtons}
+ levelIndentation={levelIndentation}
+ handleCheckboxChange={handleCheckboxChange}
+ onContextMenu={props.onContextMenu}
+ handleToggleItemOpen={handleToggleItemOpen}
+ toggleItemActive={props.toggleItemActive}
+ getToggableIconClassNames={getToggableIconClassNames}
+ getProperArrowAnimation={getProperArrowAnimation}
+ selectedRef={selectedRef}
+ /> :
+ <Collapse in={it.open} timeout="auto" unmountOnExit>
+ <Tree
+ showSelection={props.showSelection}
+ items={it.items}
+ render={render}
+ disableRipple={disableRipple}
+ toggleItemOpen={toggleItemOpen}
+ toggleItemActive={toggleItemActive}
+ level={level + 1}
+ onContextMenu={props.onContextMenu}
+ toggleItemSelection={props.toggleItemSelection}
+ selectedRef={selectedRef}
+ />
+ </Collapse>
+ }
+ </div>;
+ })}
+ </List>;
}
);