DEV: Make outletArgs available as regular arguments in PluginOutlet #32742
Conversation
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
08d84e4 to
6a4f386
Compare
Historically, plugin outlet arguments had to be accessed like `@outletArgs.foo` in templates, or `this.args.outletArgs.foo` in javascript. Following this commit, outletArgs will be passed to connector components at the top level, so they can be accessed like `@foo` in templates or `this.args.foo` in JS. `@outletArgs` remains available for compatibility, and there are no plans to remove it. For custom classic component connectors, these new arguments may clash with functions/fields defined on the component class. This rare case will be automatically detected, protected against, and a deprecation will be shown.
6a4f386 to
1337a66
Compare
CvX
reviewed
May 16, 2025
app/assets/javascripts/discourse/tests/integration/components/plugin-outlet-test.gjs
Outdated
Show resolved
Hide resolved
CvX
reviewed
May 16, 2025
app/assets/javascripts/discourse/tests/integration/components/plugin-outlet-test.gjs
Outdated
Show resolved
Hide resolved
…plugin-outlet-test.gjs Co-authored-by: Jarek Radosz <jradosz@gmail.com>
CvX
approved these changes
May 16, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Historically, plugin outlet arguments had to be accessed like
@outletArgs.fooin templates, orthis.args.outletArgs.fooin javascript. Following this commit, outletArgs will be passed to connectors at the top level, so they can be accessed like@fooin templates orthis.args.fooin JS.@outletArgsremains available for compatibility, and there are no plans to remove it.For custom classic component connectors, these new arguments may clash with functions/fields defined on the component class. This rare case will be automatically detected, protected against, and a deprecation will be shown.