feat: DH-22891: Example middleware plugin#1372
Draft
vbabich wants to merge 1 commit into
Draft
Conversation
## feat: DH-22891: Example middleware plugin
Adds `table-middleware-example`, a minimal `WidgetMiddlewarePlugin`
demonstrating how a middleware plugin is inserted into a widget's render
chain and how it can **wrap** the next component and **inject** custom
props — with no coupling to IrisGrid or any other specific widget.
### What it does
- A single shared body hook (`exampleMiddlewareBody`) returning `{
inject, wrap }`: injects a custom `exampleInjectedProp` and wraps the
wrapped component in an `ExampleMiddlewareContext.Provider` plus a small
"Wrapped by example middleware" banner.
- The one body hook drives both middleware paths via the
`@deephaven/plugin` factories: `createWidgetMiddleware` (non-panel /
dashboard) and `createPanelMiddleware` (panel path, which preserves
golden-layout's panel ref so `componentState` persistence stays intact).
- Wired up as a `PluginType.MIDDLEWARE_PLUGIN` with `supportedTypes:
['Table', 'TreeTable', 'HierarchicalTable', 'PartitionedTable']`,
registered in `plugins/manifest.json`.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
table-middleware-example, a minimalWidgetMiddlewarePlugindemonstrating how a middleware plugin is inserted into a widget's render
chain and how it can wrap the next component and inject custom
props — with no coupling to IrisGrid or any other specific widget.
What it does
exampleMiddlewareBody) returning{ inject, wrap }: injects a customexampleInjectedPropand wraps thewrapped component in an
ExampleMiddlewareContext.Providerplus a small"Wrapped by example middleware" banner.
@deephaven/pluginfactories:createWidgetMiddleware(non-panel /dashboard) and
createPanelMiddleware(panel path, which preservesgolden-layout's panel ref so
componentStatepersistence stays intact).PluginType.MIDDLEWARE_PLUGINwithsupportedTypes: ['Table', 'TreeTable', 'HierarchicalTable', 'PartitionedTable'],registered in
plugins/manifest.json.