1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
5 import React, { MutableRefObject, ReactElement, ReactNode, useEffect, useRef, useState } from 'react';
14 } from "@material-ui/core";
15 import { GridProps } from '@material-ui/core/Grid';
16 import { isArray } from 'lodash';
17 import { DefaultView } from 'components/default-view/default-view';
18 import { InfoIcon, InvisibleIcon, VisibleIcon } from 'components/icon/icon';
19 import { ReactNodeArray } from 'prop-types';
20 import classNames from 'classnames';
22 type CssRules = 'button' | 'buttonIcon' | 'content';
24 const styles: StyleRulesCallback<CssRules> = theme => ({
31 padding: '2px 0px 2px 5px',
40 interface MPVHideablePanelDataProps {
46 panelRef?: MutableRefObject<any>;
49 interface MPVHideablePanelActionProps {
50 doHidePanel: () => void;
51 doMaximizePanel: () => void;
54 type MPVHideablePanelProps = MPVHideablePanelDataProps & MPVHideablePanelActionProps;
56 const MPVHideablePanel = ({doHidePanel, doMaximizePanel, name, visible, maximized, illuminated, ...props}: MPVHideablePanelProps) =>
59 {React.cloneElement((props.children as ReactElement), { doHidePanel, doMaximizePanel, panelName: name, panelMaximized: maximized, panelIlluminated: illuminated, panelRef: props.panelRef })}
63 interface MPVPanelDataProps {
65 panelMaximized?: boolean;
66 panelIlluminated?: boolean;
67 panelRef?: MutableRefObject<any>;
68 forwardProps?: boolean;
72 interface MPVPanelActionProps {
73 doHidePanel?: () => void;
74 doMaximizePanel?: () => void;
77 // Props received by panel implementors
78 export type MPVPanelProps = MPVPanelDataProps & MPVPanelActionProps;
80 type MPVPanelContentProps = {children: ReactElement} & MPVPanelProps & GridProps;
82 // Grid item compatible component for layout and MPV props passing
83 export const MPVPanelContent = ({doHidePanel, doMaximizePanel, panelName,
84 panelMaximized, panelIlluminated, panelRef, forwardProps, maxHeight,
85 ...props}: MPVPanelContentProps) => {
87 if (panelRef && panelRef.current) {
88 panelRef.current.scrollIntoView({behavior: 'smooth'});
92 const mh = panelMaximized
96 return <Grid item style={{maxHeight: mh}} {...props}>
97 <span ref={panelRef} /> {/* Element to scroll to when the panel is selected */}
98 <Paper style={{height: '100%'}} elevation={panelIlluminated ? 8 : 0}>
100 ? React.cloneElement(props.children, { doHidePanel, doMaximizePanel, panelName, panelMaximized })
106 export interface MPVPanelState {
110 interface MPVContainerDataProps {
111 panelStates?: MPVPanelState[];
113 type MPVContainerProps = MPVContainerDataProps & GridProps;
115 // Grid container compatible component that also handles panel toggling.
116 const MPVContainerComponent = ({children, panelStates, classes, ...props}: MPVContainerProps & WithStyles<CssRules>) => {
117 if (children === undefined || children === null || children === {}) {
119 } else if (!isArray(children)) {
120 children = [children];
122 const visibility = (children as ReactNodeArray).map((_, idx) =>
123 !panelStates || // if panelStates wasn't passed, default to all visible panels
125 (panelStates[idx].visible || panelStates[idx].visible === undefined)));
126 const [panelVisibility, setPanelVisibility] = useState<boolean[]>(visibility);
127 const [brightenedPanel, setBrightenedPanel] = useState<number>(-1);
128 const panelRef = useRef<any>(null);
130 let panels: JSX.Element[] = [];
131 let toggles: JSX.Element[] = [];
133 if (isArray(children)) {
134 for (let idx = 0; idx < children.length; idx++) {
135 const showFn = (idx: number) => () => {
137 ...panelVisibility.slice(0, idx),
139 ...panelVisibility.slice(idx+1)
142 const hideFn = (idx: number) => () => {
144 ...panelVisibility.slice(0, idx),
146 ...panelVisibility.slice(idx+1)
149 const maximizeFn = (idx: number) => () => {
150 // Maximize X == hide all but X
152 ...panelVisibility.slice(0, idx).map(() => false),
154 ...panelVisibility.slice(idx+1).map(() => false),
157 const toggleIcon = panelVisibility[idx]
158 ? <VisibleIcon className={classNames(classes.buttonIcon)} />
159 : <InvisibleIcon className={classNames(classes.buttonIcon)}/>
160 const panelName = panelStates === undefined
162 : (panelStates[idx] && panelStates[idx].name) || `Panel ${idx+1}`;
163 const toggleVariant = "outlined";
164 const toggleTooltip = panelVisibility[idx]
166 :`Show ${panelName} panel`;
167 const panelIsMaximized = panelVisibility[idx] &&
168 panelVisibility.filter(e => e).length === 1;
170 let brightenerTimer: NodeJS.Timer;
173 <Tooltip title={toggleTooltip} disableFocusListener>
174 <Button variant={toggleVariant} size="small" color="primary"
175 className={classNames(classes.button)}
176 onMouseEnter={() => {
177 brightenerTimer = setTimeout(
178 () => setBrightenedPanel(idx), 100);
180 onMouseLeave={() => {
181 brightenerTimer && clearTimeout(brightenerTimer);
182 setBrightenedPanel(-1);
184 onClick={showFn(idx)}>
192 <MPVHideablePanel key={idx} visible={panelVisibility[idx]} name={panelName}
193 panelRef={(idx === brightenedPanel) ? panelRef : undefined}
194 maximized={panelIsMaximized} illuminated={idx === brightenedPanel}
195 doHidePanel={hideFn(idx)} doMaximizePanel={maximizeFn(idx)}>
198 panels = [...panels, aPanel];
202 return <Grid container {...props}>
203 <Grid container item direction="row">
204 { toggles.map((tgl, idx) => <Grid item key={idx}>{tgl}</Grid>) }
206 <Grid container item {...props} xs className={classes.content}>
207 { panelVisibility.includes(true)
209 : <Grid container item alignItems='center' justify='center'>
210 <DefaultView messages={["All panels are hidden.", "Click on the buttons above to show them."]} icon={InfoIcon} />
216 export const MPVContainer = withStyles(styles)(MPVContainerComponent);