refactor: Move Panel into @deephaven/dashboard #2304
Conversation
- Move Panel into @deephaven/dashboard, removing functionality depending on core plugins and keeping in CorePanel in the dashboard-core-plugins package - Should be no breaking changes, as dashboard-core-plugins re-exports the components that were removed - Allows plugins (such as deephaven.ui) to simply use the `Panel` component without having to depend on other core plugins
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #2304 +/- ##
==========================================
- Coverage 46.60% 46.52% -0.08%
==========================================
Files 704 705 +1
Lines 38963 38973 +10
Branches 9914 9914
==========================================
- Hits 18158 18134 -24
+ Misses 20794 20785 -9
- Partials 11 54 +43
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
| // Deprecated - use TabEvent from @deephaven/dashboard | ||
| export { type TabEvent } from '@deephaven/dashboard'; |
There was a problem hiding this comment.
You could do something like this so the deprecation actually shows up in vscode
import { type TabEvent as TabEventImport } from '@deephaven/dashboard';
/**
* @deprecated Use TabEvent from `@deephaven/dashboard`
*/
export type TabEvent = typeof TabEventImport; // Not sure why typeof is needed hereThis will give the deprecation strikethrough in VSCode
| @@ -0,0 +1,80 @@ | |||
| import React, { PureComponent, type ReactElement } from 'react'; | |||
| import { createXComponent } from '@deephaven/components'; | |||
| import { type BasePanelProps, Panel } from '@deephaven/dashboard'; | |||
There was a problem hiding this comment.
I feel like we should either have BasePanelProps, BasePanel or PanelProps, Panel for consistency
| export { default as CorePanel } from './CorePanel'; | ||
| // Deprecated - use CorePanel instead | ||
| export { default as Panel } from './CorePanel'; |
There was a problem hiding this comment.
Same comment about importing and renaming for the deprecated export w/ a deprecated tag.
CorePanel is what Panel used to be right? Why would someone need/want Panel from @deephaven/dashboard? dh.ui would still need the dashboard-core-components version, right? Or does nothing there need the session open/close events?
| @@ -83,18 +74,15 @@ interface PanelState { | |||
| * Also wires up some triggers for common events: | |||
| * Focus, Resize, Show, Session open/close, client disconnect/reconnect. | |||
There was a problem hiding this comment.
Remove session open/close. And client disconnect/reconnect?
Panelcomponent without having to depend on other core plugins