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, Collapse, Checkbox, Radio } from "@material-ui/core";
7 import { StyleRulesCallback, withStyles, WithStyles } from '@material-ui/core/styles';
8 import { ReactElement } from "react";
9 import CircularProgress from '@material-ui/core/CircularProgress';
10 import * as classnames from "classnames";
12 import { ArvadosTheme } from '~/common/custom-theme';
13 import { SidePanelRightArrowIcon } from '../icon/icon';
15 type CssRules = 'list'
19 | 'toggableIconContainer'
26 const styles: StyleRulesCallback<CssRules> = (theme: ArvadosTheme) => ({
35 transform: 'translate(0px)',
38 toggableIconContainer: {
39 color: theme.palette.grey["700"],
50 color: theme.palette.primary.main,
53 transition: 'all 0.1s ease',
56 transition: 'all 0.1s ease',
57 transform: 'rotate(90deg)',
60 width: theme.spacing.unit * 3,
61 height: theme.spacing.unit * 3,
62 margin: `0 ${theme.spacing.unit}px`,
64 color: theme.palette.grey["500"],
68 export enum TreeItemStatus {
74 export interface TreeItem<T> {
80 status: TreeItemStatus;
81 items?: Array<TreeItem<T>>;
85 export interface TreeProps<T> {
86 disableRipple?: boolean;
87 currentItemUuid?: string;
88 items?: Array<TreeItem<T>>;
90 onContextMenu: (event: React.MouseEvent<HTMLElement>, item: TreeItem<T>) => void;
91 render: (item: TreeItem<T>, level?: number) => ReactElement<{}>;
92 showSelection?: boolean | ((item: TreeItem<T>) => boolean);
93 levelIndentation?: number;
94 itemRightPadding?: number;
95 toggleItemActive: (event: React.MouseEvent<HTMLElement>, item: TreeItem<T>) => void;
96 toggleItemOpen: (event: React.MouseEvent<HTMLElement>, item: TreeItem<T>) => void;
97 toggleItemSelection?: (event: React.MouseEvent<HTMLElement>, item: TreeItem<T>) => void;
100 * When set to true use radio buttons instead of checkboxes for item selection.
101 * This does not guarantee radio group behavior (i.e item mutual exclusivity).
102 * Any item selection logic must be done in the toggleItemActive callback prop.
104 useRadioButtons?: boolean;
107 export const Tree = withStyles(styles)(
108 class Component<T> extends React.Component<TreeProps<T> & WithStyles<CssRules>, {}> {
109 render(): ReactElement<any> {
110 const level = this.props.level ? this.props.level : 0;
111 const { classes, render, toggleItemOpen, items, toggleItemActive, onContextMenu, disableRipple, currentItemUuid, useRadioButtons } = this.props;
112 const { list, listItem, loader, toggableIconContainer, renderContainer } = classes;
113 const showSelection = typeof this.props.showSelection === 'function'
114 ? this.props.showSelection
115 : () => this.props.showSelection ? true : false;
117 const { levelIndentation = 20, itemRightPadding = 20 } = this.props;
119 return <List className={list}>
120 {items && items.map((it: TreeItem<T>, idx: number) =>
121 <div key={`item/${level}/${idx}`}>
122 <ListItem button className={listItem}
124 paddingLeft: (level + 1) * levelIndentation,
125 paddingRight: itemRightPadding,
127 disableRipple={disableRipple}
128 onClick={event => toggleItemActive(event, it)}
129 selected={showSelection(it) && it.id === currentItemUuid}
130 onContextMenu={this.handleRowContextMenu(it)}>
131 {it.status === TreeItemStatus.PENDING ?
132 <CircularProgress size={10} className={loader} /> : null}
133 <i onClick={this.handleToggleItemOpen(it)}
134 className={toggableIconContainer}>
135 <ListItemIcon className={this.getToggableIconClassNames(it.open, it.active)}>
136 {this.getProperArrowAnimation(it.status, it.items!)}
139 {showSelection(it) && !useRadioButtons &&
141 checked={it.selected}
142 className={classes.checkbox}
144 onClick={this.handleCheckboxChange(it)} />}
145 {showSelection(it) && useRadioButtons &&
147 checked={it.selected}
148 className={classes.checkbox}
150 <div className={renderContainer}>
154 {it.items && it.items.length > 0 &&
155 <Collapse in={it.open} timeout="auto" unmountOnExit>
157 showSelection={this.props.showSelection}
160 disableRipple={disableRipple}
161 toggleItemOpen={toggleItemOpen}
162 toggleItemActive={toggleItemActive}
164 onContextMenu={onContextMenu}
165 toggleItemSelection={this.props.toggleItemSelection} />
171 getProperArrowAnimation = (status: string, items: Array<TreeItem<T>>) => {
172 return this.isSidePanelIconNotNeeded(status, items) ? <span /> : <SidePanelRightArrowIcon style={{ fontSize: '14px' }} />;
175 isSidePanelIconNotNeeded = (status: string, items: Array<TreeItem<T>>) => {
176 return status === TreeItemStatus.PENDING ||
177 (status === TreeItemStatus.LOADED && !items) ||
178 (status === TreeItemStatus.LOADED && items && items.length === 0);
181 getToggableIconClassNames = (isOpen?: boolean, isActive?: boolean) => {
182 const { iconOpen, iconClose, active, toggableIcon } = this.props.classes;
183 return classnames(toggableIcon, {
185 [iconClose]: !isOpen,
190 handleRowContextMenu = (item: TreeItem<T>) =>
191 (event: React.MouseEvent<HTMLElement>) =>
192 this.props.onContextMenu(event, item)
194 handleCheckboxChange = (item: TreeItem<T>) => {
195 const { toggleItemSelection } = this.props;
196 return toggleItemSelection
197 ? (event: React.MouseEvent<HTMLElement>) => {
198 event.stopPropagation();
199 toggleItemSelection(event, item);
204 handleToggleItemOpen = (item: TreeItem<T>) => (event: React.MouseEvent<HTMLElement>) => {
205 event.stopPropagation();
206 this.props.toggleItemOpen(event, item);