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 } 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',
39 interface MPVHideablePanelDataProps {
45 panelRef?: MutableRefObject<any>;
48 interface MPVHideablePanelActionProps {
49 doHidePanel: () => void;
50 doMaximizePanel: () => void;
51 doUnMaximizePanel: () => void;
54 type MPVHideablePanelProps = MPVHideablePanelDataProps & MPVHideablePanelActionProps;
56 const MPVHideablePanel = ({doHidePanel, doMaximizePanel, doUnMaximizePanel, name, visible, maximized, illuminated, ...props}: MPVHideablePanelProps) =>
59 {React.cloneElement((props.children as ReactElement), { doHidePanel, doMaximizePanel, doUnMaximizePanel, 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;
75 doUnMaximizePanel?: () => void;
78 // Props received by panel implementors
79 export type MPVPanelProps = MPVPanelDataProps & MPVPanelActionProps;
81 type MPVPanelContentProps = {children: ReactElement} & MPVPanelProps & GridProps;
83 // Grid item compatible component for layout and MPV props passing
84 export const MPVPanelContent = ({doHidePanel, doMaximizePanel, doUnMaximizePanel, panelName,
85 panelMaximized, panelIlluminated, panelRef, forwardProps, maxHeight,
86 ...props}: MPVPanelContentProps) => {
88 if (panelRef && panelRef.current) {
89 panelRef.current.scrollIntoView({alignToTop: true});
93 const mh = panelMaximized
97 return <Grid item style={{maxHeight: mh}} {...props}>
98 <span ref={panelRef} /> {/* Element to scroll to when the panel is selected */}
99 <Paper style={{height: '100%'}} elevation={panelIlluminated ? 8 : 0}>
101 ? React.cloneElement(props.children, { doHidePanel, doMaximizePanel, doUnMaximizePanel, panelName, panelMaximized })
107 export interface MPVPanelState {
111 interface MPVContainerDataProps {
112 panelStates?: MPVPanelState[];
114 type MPVContainerProps = MPVContainerDataProps & GridProps;
116 // Grid container compatible component that also handles panel toggling.
117 const MPVContainerComponent = ({children, panelStates, classes, ...props}: MPVContainerProps & WithStyles<CssRules>) => {
118 if (children === undefined || children === null || children === {}) {
120 } else if (!isArray(children)) {
121 children = [children];
123 const initialVisibility = (children as ReactNodeArray).map((_, idx) =>
124 !panelStates || // if panelStates wasn't passed, default to all visible panels
126 (panelStates[idx].visible || panelStates[idx].visible === undefined)));
127 const [panelVisibility, setPanelVisibility] = useState<boolean[]>(initialVisibility);
128 const [previousPanelVisibility, setPreviousPanelVisibility] = useState<boolean[]>(initialVisibility);
129 const [highlightedPanel, setHighlightedPanel] = useState<number>(-1);
130 const [selectedPanel, setSelectedPanel] = useState<number>(-1);
131 const panelRef = useRef<any>(null);
133 let panels: JSX.Element[] = [];
134 let buttons: JSX.Element[] = [];
136 if (isArray(children)) {
137 for (let idx = 0; idx < children.length; idx++) {
138 const showFn = (idx: number) => () => {
139 setPreviousPanelVisibility(initialVisibility);
141 ...panelVisibility.slice(0, idx),
143 ...panelVisibility.slice(idx+1)
145 setSelectedPanel(idx);
147 const hideFn = (idx: number) => () => {
148 setPreviousPanelVisibility(initialVisibility);
150 ...panelVisibility.slice(0, idx),
152 ...panelVisibility.slice(idx+1)
155 const maximizeFn = (idx: number) => () => {
156 setPreviousPanelVisibility(panelVisibility);
157 // Maximize X == hide all but X
159 ...panelVisibility.slice(0, idx).map(() => false),
161 ...panelVisibility.slice(idx+1).map(() => false),
164 const unMaximizeFn = (idx: number) => () => {
165 setPanelVisibility(previousPanelVisibility);
166 setSelectedPanel(idx);
168 const panelName = panelStates === undefined
170 : (panelStates[idx] && panelStates[idx].name) || `Panel ${idx+1}`;
171 const btnVariant = panelVisibility[idx]
174 const btnTooltip = panelVisibility[idx]
176 :`Open ${panelName} panel`;
177 const panelIsMaximized = panelVisibility[idx] &&
178 panelVisibility.filter(e => e).length === 1;
182 <Tooltip title={btnTooltip} disableFocusListener>
183 <Button variant={btnVariant} size="small" color="primary"
184 className={classNames(classes.button)}
185 onMouseEnter={() => {
186 setHighlightedPanel(idx);
188 onMouseLeave={() => {
189 setHighlightedPanel(-1);
191 onClick={showFn(idx)}>
198 <MPVHideablePanel key={idx} visible={panelVisibility[idx]} name={panelName}
199 panelRef={(idx === selectedPanel) ? panelRef : undefined}
200 maximized={panelIsMaximized} illuminated={idx === highlightedPanel}
201 doHidePanel={hideFn(idx)} doMaximizePanel={maximizeFn(idx)} doUnMaximizePanel={panelIsMaximized ? unMaximizeFn(idx) : () => null}>
204 panels = [...panels, aPanel];
208 return <Grid container {...props}>
209 <Grid container item direction="row">
210 { buttons.map((tgl, idx) => <Grid item key={idx}>{tgl}</Grid>) }
212 <Grid container item {...props} xs className={classes.content}
213 onScroll={() => setSelectedPanel(-1)}>
214 { panelVisibility.includes(true)
216 : <Grid container item alignItems='center' justify='center'>
217 <DefaultView messages={["All panels are hidden.", "Click on the buttons above to show them."]} icon={InfoIcon} />
223 export const MPVContainer = withStyles(styles)(MPVContainerComponent);