feat: Pass through additional actions from WidgetPanel (#2224)

- additionalActions was only a prop on Panel - Add it as a prop on WidgetPanel and pass it through
deephaven · Sep 17, 2024 · bc720d1 · bc720d1
1 parent 611ec2c
commit bc720d1
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 59 deletions.
diff --git a/packages/dashboard-core-plugins/src/panels/Panel.tsx b/packages/dashboard-core-plugins/src/panels/Panel.tsx
@@ -11,6 +11,7 @@ import memoize from 'memoize-one';
 import {
   ContextAction,
   ContextActions,
+  createXComponent,
   LoadingOverlay,
   Tooltip,
 } from '@deephaven/components';
@@ -31,7 +32,7 @@ import './Panel.scss';
 
 const log = Log.module('Panel');
 
-interface PanelProps {
+export type CorePanelProps = {
   /**
    * Reference to the component panel.
    * Will wait until it is set before emitting mount/unmount events.
@@ -65,7 +66,7 @@ interface PanelProps {
   isLoaded?: boolean;
   isClonable?: boolean;
   isRenamable?: boolean;
-}
+};
 
 interface PanelState {
   title?: string | null;
@@ -77,8 +78,8 @@ interface PanelState {
  * Also wires up some triggers for common events:
  * Focus, Resize, Show, Session open/close, client disconnect/reconnect.
  */
-class Panel extends PureComponent<PanelProps, PanelState> {
-  constructor(props: PanelProps) {
+class Panel extends PureComponent<CorePanelProps, PanelState> {
+  constructor(props: CorePanelProps) {
     super(props);
 
     this.handleClearAllFilters = this.handleClearAllFilters.bind(this);
@@ -379,4 +380,6 @@ class Panel extends PureComponent<PanelProps, PanelState> {
   }
 }
 
-export default Panel;
+const XPanel = createXComponent(Panel);
+
+export default XPanel;
diff --git a/packages/dashboard-core-plugins/src/panels/WidgetPanel.tsx b/packages/dashboard-core-plugins/src/panels/WidgetPanel.tsx
@@ -1,46 +1,22 @@
-import React, { PureComponent, ReactElement, ReactNode } from 'react';
+import React, { PureComponent, ReactElement } from 'react';
 import classNames from 'classnames';
 import memoize from 'memoize-one';
-import { ContextActions, createXComponent } from '@deephaven/components';
-import { PanelComponent } from '@deephaven/dashboard';
-import type { Container, EventEmitter } from '@deephaven/golden-layout';
-import { copyToClipboard } from '@deephaven/utils';
-import Panel from './Panel';
+import {
+  ContextAction,
+  ContextActions,
+  createXComponent,
+} from '@deephaven/components';
+import type { dh } from '@deephaven/jsapi-types';
+import { copyToClipboard, EMPTY_ARRAY } from '@deephaven/utils';
+import Panel, { CorePanelProps } from './Panel';
 import WidgetPanelTooltip from './WidgetPanelTooltip';
 import './WidgetPanel.scss';
 import { WidgetPanelDescriptor } from './WidgetPanelTypes';
 
-export type WidgetPanelProps = {
-  children: ReactNode;
-
+export type WidgetPanelProps = CorePanelProps & {
   descriptor: WidgetPanelDescriptor;
-  componentPanel?: PanelComponent;
-
-  glContainer: Container;
-  glEventHub: EventEmitter;
-
-  className?: string;
-  errorMessage?: string;
-  isClonable?: boolean;
-  isDisconnected?: boolean;
-  isLoading?: boolean;
-  isLoaded?: boolean;
-  isRenamable?: boolean;
   showTabTooltip?: boolean;
-
-  renderTabTooltip?: () => ReactNode;
-
-  onFocus?: () => void;
-  onBlur?: () => void;
-  onHide?: () => void;
-  onClearAllFilters?: () => void;
-  onResize?: () => void;
-  onSessionClose?: (...args: unknown[]) => void;
-  onSessionOpen?: (...args: unknown[]) => void;
-  onShow?: () => void;
-  onTabBlur?: () => void;
-  onTabFocus?: () => void;
-  onTabClicked?: () => void;
+  isDisconnected?: boolean;
 };
 
 interface WidgetPanelState {
@@ -68,7 +44,6 @@ class WidgetPanel extends PureComponent<WidgetPanelProps, WidgetPanelState> {
     super(props);
 
     this.handleSessionClosed = this.handleSessionClosed.bind(this);
-    this.handleSessionOpened = this.handleSessionOpened.bind(this);
     this.handleCopyName = this.handleCopyName.bind(this);
 
     this.state = {
@@ -119,28 +94,29 @@ class WidgetPanel extends PureComponent<WidgetPanelProps, WidgetPanelState> {
         : undefined
   );
 
-  getCachedActions = memoize((descriptor: WidgetPanelDescriptor) => [
-    {
-      title: `Copy ${descriptor.displayType ?? descriptor.type} Name`,
-      group: ContextActions.groups.medium,
-      order: 20,
-      action: this.handleCopyName,
-    },
-  ]);
+  getCachedActions = memoize(
+    (
+      descriptor: WidgetPanelDescriptor,
+      propsAdditionalActions: readonly ContextAction[] = EMPTY_ARRAY
+    ) => [
+      ...propsAdditionalActions,
+      {
+        title: `Copy ${descriptor.displayType ?? descriptor.type} Name`,
+        group: ContextActions.groups.medium,
+        order: 20,
+        action: this.handleCopyName,
+      },
+    ]
+  );
 
-  handleSessionClosed(...args: unknown[]): void {
+  handleSessionClosed(session: dh.IdeSession): void {
     const { onSessionClose } = this.props;
     // The session has closed and we won't be able to reconnect, as this widget isn't persisted
     this.setState({
       isPanelDisconnected: true,
       isWaitingForReconnect: false,
     });
-    onSessionClose?.(...args);
-  }
-
-  handleSessionOpened(...args: unknown[]): void {
-    const { onSessionOpen } = this.props;
-    onSessionOpen?.(...args);
+    onSessionClose?.(session);
   }
 
   render(): ReactElement {
@@ -164,10 +140,13 @@ class WidgetPanel extends PureComponent<WidgetPanelProps, WidgetPanelState> {
       onFocus,
       onBlur,
       onResize,
+      onSessionOpen,
       onShow,
       onTabBlur,
       onTabFocus,
       onTabClicked,
+
+      additionalActions: propsAdditionalActions,
     } = this.props;
 
     const { isPanelDisconnected, isWidgetDisconnected, isPanelInactive } =
@@ -177,7 +156,10 @@ class WidgetPanel extends PureComponent<WidgetPanelProps, WidgetPanelState> {
       renderTabTooltip ??
       this.getCachedRenderTabTooltip(showTabTooltip, descriptor);
 
-    const additionalActions = this.getCachedActions(descriptor);
+    const additionalActions = this.getCachedActions(
+      descriptor,
+      propsAdditionalActions
+    );
 
     return (
       <Panel
@@ -196,7 +178,7 @@ class WidgetPanel extends PureComponent<WidgetPanelProps, WidgetPanelState> {
         onResize={onResize}
         onShow={onShow}
         onSessionClose={this.handleSessionClosed}
-        onSessionOpen={this.handleSessionOpened}
+        onSessionOpen={onSessionOpen}
         onTabBlur={onTabBlur}
         onTabFocus={onTabFocus}
         onTabClicked={onTabClicked}
@@ -215,6 +197,6 @@ class WidgetPanel extends PureComponent<WidgetPanelProps, WidgetPanelState> {
   }
 }
 
-const XWidgetPanel = createXComponent(WidgetPanel);
+const XWidgetPanel = createXComponent<WidgetPanelProps>(WidgetPanel);
 
 export default XWidgetPanel;