1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
5 import * as React from 'react';
6 import { List, ListItem, ListItemIcon, Checkbox, Radio, Collapse } from "@material-ui/core";
7 import { StyleRulesCallback, withStyles, WithStyles } from '@material-ui/core/styles';
8 import { CollectionIcon, DefaultIcon, DirectoryIcon, FileIcon, ProjectIcon, FilterGroupIcon } from '~/components/icon/icon';
9 import { ReactElement } from "react";
10 import CircularProgress from '@material-ui/core/CircularProgress';
11 import classnames from "classnames";
13 import { ArvadosTheme } from '~/common/custom-theme';
14 import { SidePanelRightArrowIcon } from '../icon/icon';
15 import { ResourceKind } from '~/models/resource';
16 import { GroupClass } from '~/models/group';
18 type CssRules = 'list'
22 | 'toggableIconContainer'
31 const styles: StyleRulesCallback<CssRules> = (theme: ArvadosTheme) => ({
40 transform: 'translate(0px)',
43 toggableIconContainer: {
44 color: theme.palette.grey["700"],
55 transition: 'all 0.1s ease',
58 transition: 'all 0.1s ease',
59 transform: 'rotate(90deg)',
62 width: theme.spacing.unit * 3,
63 height: theme.spacing.unit * 3,
64 margin: `0 ${theme.spacing.unit}px`,
66 color: theme.palette.grey["500"],
75 backgroundColor: 'rgba(0, 0, 0, 0.08)',
81 color: 'rgba(0, 0, 0, 0.54)',
84 color: theme.palette.primary.main,
88 export enum TreeItemStatus {
94 export interface TreeItem<T> {
101 status: TreeItemStatus;
102 items?: Array<TreeItem<T>>;
105 export interface TreeProps<T> {
106 disableRipple?: boolean;
107 currentItemUuid?: string;
108 items?: Array<TreeItem<T>>;
110 itemsMap?: Map<string, TreeItem<T>>;
111 onContextMenu: (event: React.MouseEvent<HTMLElement>, item: TreeItem<T>) => void;
112 render: (item: TreeItem<T>, level?: number) => ReactElement<{}>;
113 showSelection?: boolean | ((item: TreeItem<T>) => boolean);
114 levelIndentation?: number;
115 itemRightPadding?: number;
116 toggleItemActive: (event: React.MouseEvent<HTMLElement>, item: TreeItem<T>) => void;
117 toggleItemOpen: (event: React.MouseEvent<HTMLElement>, item: TreeItem<T>) => void;
118 toggleItemSelection?: (event: React.MouseEvent<HTMLElement>, item: TreeItem<T>) => void;
121 * When set to true use radio buttons instead of checkboxes for item selection.
122 * This does not guarantee radio group behavior (i.e item mutual exclusivity).
123 * Any item selection logic must be done in the toggleItemActive callback prop.
125 useRadioButtons?: boolean;
128 const getActionAndId = (event: any, initAction: string | undefined = undefined) => {
129 const { nativeEvent: { target } } = event;
130 let currentTarget: HTMLElement = target as HTMLElement;
131 let action: string | undefined = initAction || currentTarget.dataset.action;
132 let id: string | undefined = currentTarget.dataset.id;
134 while (action === undefined || id === undefined) {
135 currentTarget = currentTarget.parentElement as HTMLElement;
137 if (!currentTarget) {
141 action = action || currentTarget.dataset.action;
142 id = id || currentTarget.dataset.id;
148 interface FlatTreeProps {
150 levelIndentation: number;
151 onContextMenu: Function;
152 handleToggleItemOpen: Function;
153 toggleItemActive: Function;
154 getToggableIconClassNames: Function;
155 getProperArrowAnimation: Function;
156 itemsMap?: Map<string, TreeItem<any>>;
160 const FLAT_TREE_ACTIONS = {
161 toggleOpen: 'TOGGLE_OPEN',
162 contextMenu: 'CONTEXT_MENU',
163 toggleActive: 'TOGGLE_ACTIVE',
166 const ItemIcon = React.memo(({type, kind, active, groupClass, classes}: any) => {
167 let Icon = ProjectIcon;
169 if (groupClass === GroupClass.FILTER) {
170 Icon = FilterGroupIcon;
176 Icon = DirectoryIcon;
188 case ResourceKind.COLLECTION:
189 Icon = CollectionIcon;
196 return <Icon className={classnames({ [classes.active]: active }, classes.childItemIcon)} />;
199 const FlatTree = (props: FlatTreeProps) =>
201 onContextMenu={(event) => {
202 const [action, id] = getActionAndId(event, FLAT_TREE_ACTIONS.contextMenu);
203 props.onContextMenu(event, { id } as any);
205 onClick={(event) => {
206 const [action, id] = getActionAndId(event);
209 const item = props.itemsMap ? props.itemsMap[id] : { id };
212 case FLAT_TREE_ACTIONS.toggleOpen:
213 props.handleToggleItemOpen(item as any, event);
215 case FLAT_TREE_ACTIONS.toggleActive:
216 props.toggleItemActive(event, item as any);
225 (props.it.items || [])
226 .map((item: any) => <div key={item.id} data-id={item.id}
227 className={classnames(props.classes.childItem, { [props.classes.active]: item.active })}
228 style={{ paddingLeft: `${item.depth * props.levelIndentation}px` }}>
229 <i data-action={FLAT_TREE_ACTIONS.toggleOpen} className={props.classes.toggableIconContainer}>
230 <ListItemIcon className={props.getToggableIconClassNames(item.open, item.active)}>
231 {props.getProperArrowAnimation(item.status, item.items!)}
234 <div data-action={FLAT_TREE_ACTIONS.toggleActive} className={props.classes.renderContainer}>
235 <span style={{ display: 'flex', alignItems: 'center' }}>
236 <ItemIcon type={item.data.type} active={item.active} kind={item.data.kind} groupClass={item.data.kind === ResourceKind.GROUP ? item.data.groupClass : ''} classes={props.classes} />
237 <span style={{ fontSize: '0.875rem' }}>
246 export const Tree = withStyles(styles)(
247 class Component<T> extends React.Component<TreeProps<T> & WithStyles<CssRules>, {}> {
248 render(): ReactElement<any> {
249 const level = this.props.level ? this.props.level : 0;
250 const { classes, render, items, toggleItemActive, toggleItemOpen, disableRipple, currentItemUuid, useRadioButtons, itemsMap } = this.props;
251 const { list, listItem, loader, toggableIconContainer, renderContainer } = classes;
252 const showSelection = typeof this.props.showSelection === 'function'
253 ? this.props.showSelection
254 : () => this.props.showSelection ? true : false;
256 const { levelIndentation = 20, itemRightPadding = 20 } = this.props;
258 return <List className={list}>
259 {items && items.map((it: TreeItem<T>, idx: number) =>
260 <div key={`item/${level}/${it.id}`}>
261 <ListItem button className={listItem}
263 paddingLeft: (level + 1) * levelIndentation,
264 paddingRight: itemRightPadding,
266 disableRipple={disableRipple}
267 onClick={event => toggleItemActive(event, it)}
268 selected={showSelection(it) && it.id === currentItemUuid}
269 onContextMenu={(event) => this.props.onContextMenu(event, it)}>
270 {it.status === TreeItemStatus.PENDING ?
271 <CircularProgress size={10} className={loader} /> : null}
272 <i onClick={(e) => this.handleToggleItemOpen(it, e)}
273 className={toggableIconContainer}>
274 <ListItemIcon className={this.getToggableIconClassNames(it.open, it.active)}>
275 {this.getProperArrowAnimation(it.status, it.items!)}
278 {showSelection(it) && !useRadioButtons &&
280 checked={it.selected}
281 className={classes.checkbox}
283 onClick={this.handleCheckboxChange(it)} />}
284 {showSelection(it) && useRadioButtons &&
286 checked={it.selected}
287 className={classes.checkbox}
289 <div className={renderContainer}>
294 it.open && it.items && it.items.length > 0 &&
299 classes={this.props.classes}
300 levelIndentation={levelIndentation}
301 onContextMenu={this.props.onContextMenu}
302 handleToggleItemOpen={this.handleToggleItemOpen}
303 toggleItemActive={this.props.toggleItemActive}
304 getToggableIconClassNames={this.getToggableIconClassNames}
305 getProperArrowAnimation={this.getProperArrowAnimation}
307 <Collapse in={it.open} timeout="auto" unmountOnExit>
309 showSelection={this.props.showSelection}
312 disableRipple={disableRipple}
313 toggleItemOpen={toggleItemOpen}
314 toggleItemActive={toggleItemActive}
316 onContextMenu={this.props.onContextMenu}
317 toggleItemSelection={this.props.toggleItemSelection} />
324 getProperArrowAnimation = (status: string, items: Array<TreeItem<T>>) => {
325 return this.isSidePanelIconNotNeeded(status, items) ? <span /> : <SidePanelRightArrowIcon style={{ fontSize: '14px' }} />;
328 isSidePanelIconNotNeeded = (status: string, items: Array<TreeItem<T>>) => {
329 return status === TreeItemStatus.PENDING ||
330 (status === TreeItemStatus.LOADED && !items) ||
331 (status === TreeItemStatus.LOADED && items && items.length === 0);
334 getToggableIconClassNames = (isOpen?: boolean, isActive?: boolean) => {
335 const { iconOpen, iconClose, active, toggableIcon } = this.props.classes;
336 return classnames(toggableIcon, {
338 [iconClose]: !isOpen,
343 handleCheckboxChange = (item: TreeItem<T>) => {
344 const { toggleItemSelection } = this.props;
345 return toggleItemSelection
346 ? (event: React.MouseEvent<HTMLElement>) => {
347 event.stopPropagation();
348 toggleItemSelection(event, item);
353 handleToggleItemOpen = (item: TreeItem<T>, event: React.MouseEvent<HTMLElement>) => {
354 event.stopPropagation();
355 this.props.toggleItemOpen(event, item);