Rename WidgetPropsV2 to WidgetProps; inline UniversalWidgetProps - #4076
Merged
Conversation
benchristel
requested review from
Myranae,
catandthemachines,
ivyolamit and
nishasy
as code owners
August 13, 2026 20:46
Contributor
npm SnapshotWant to try this PR's changes before it merges? Comment |
Contributor
|
Size Change: -16 B (0%) Total Size: 519 kB 📦 View Changed
ℹ️ View Unchanged
|
jeremywiebe
approved these changes
Aug 13, 2026
jeremywiebe
left a comment
jeremywiebe
left a comment
Collaborator
There was a problem hiding this comment.
Such a huge improvement. Thanks for working on this Ben!
| | Type | Description | | ||
| | ---- | ----------- | | ||
| | \`WidgetProps\<T\>\` | All widgets receive a common set of props from the parent \`Renderer\` component This set of props is defined by the \`WidgetProps\<T\>\` type (\`T\` being the specific render props the widget uses). | | ||
| | \`WidgetProps\<T\>\` | All widgets receive a common set of props from the parent \`Renderer\` component This set of props is defined by the \`WidgetProps\<T\>\` type (\`T\` being the type of the widget's own options, which arrive under the \`options\` prop). | |
Collaborator
There was a problem hiding this comment.
Suggested change
| | \`WidgetProps\<T\>\` | All widgets receive a common set of props from the parent \`Renderer\` component This set of props is defined by the \`WidgetProps\<T\>\` type (\`T\` being the type of the widget's own options, which arrive under the \`options\` prop). | | |
| | \`WidgetProps\<T\>\` | All widgets receive a common set of props from the parent \`Renderer\` component. This set of props is defined by the \`WidgetProps\<T\>\` type (\`T\` being the type of the widget's own options, which arrive under the \`options\` prop). | |
Member
Author
There was a problem hiding this comment.
I ended up replacing this whole table with a brief paragraph. There's not that much to explain about widget props anymore!
Comment on lines
457
to
+460
| * The full set of props provided to all widgets when they are rendered. The | ||
| * `TWidgetOptions` generic argument are the widget-specific props that originate | ||
| * from the PerseusItem. | ||
| * widget-specific options that originate from the PerseusItem are nested under | ||
| * the `options` prop; everything else is provided to every widget regardless of | ||
| * its `type`. |
benchristel
force-pushed
the
benc/widget-props-2
branch
from
August 13, 2026 22:19
aa87d60 to
55e1287
Compare
Base automatically changed from
benc/widget-props-2
to
benc/widget-props-redesign
August 13, 2026 22:31
benchristel
force-pushed
the
benc/widget-props-3
branch
from
August 13, 2026 22:36
9f92148 to
d45c6ae
Compare
benchristel
added a commit
that referenced
this pull request
Aug 13, 2026
## Summary: This is the penultimate change to close out the widget props migration. All widgets now accept their `options` as a separate prop, so the old `WidgetProps` is no longer used. This PR deletes the old `WidgetProps` and renames `WidgetPropsV2` to `WidgetProps`. We also inline `UniversalWidgetProps` into `WidgetProps` since it doesn't need to be a separate type anymore. Issue: LEMS-4354 ## Test plan: CI checks should pass. Author: benchristel Reviewers: jeremywiebe, nishasy, handeyeco, ivyolamit, Myranae, catandthemachines Required Reviewers: Approved By: jeremywiebe Checks: ✅ 10 checks were successful Pull Request URL: #4076
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
2 participants
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.
Summary:
This is the penultimate change to close out the widget props migration. All
widgets now accept their
optionsas a separate prop, so the oldWidgetPropsis no longer used. This PR deletes the old
WidgetPropsand renamesWidgetPropsV2toWidgetProps. We also inlineUniversalWidgetPropsintoWidgetPropssince it doesn't need to be a separate type anymore.Issue: LEMS-4354
Test plan:
CI checks should pass.