@outletArgs are now available as top-level arguments

Dev
1

In the latest version of Discourse, outlet arguments can be accessed as top-level arguments to your connector components.

In a template, that means that @outletArgs.foo can be replaced with @foo. In Glimmer Component JS, this.args.outletArgs.foo can be replaced with this.args.foo.

The old @outletArgs argument is still available, and we don’t have any plans to deprecate it. So there’s no rush to update any existing code. In the future we may introduce a custom eslint rule to detect & automatically modernize uses of @outletArgs and this.args.outletArgs.

The plugin outlet inspector has already been updated to display arguments in the modern way:

SCR-20250618-lajw
SCR-20250618-lajw672×224 12.9 KB

We’ll be following up with changes to documentation in the near future.

16 Likes
2

Much more consistent :+1:t2:

3 Likes
3

Pardon my ignorance, but where do you access these args? In a connector .gjs file? Or in a renderInOutlet?

4

There are two ways to render a connector component into a plugin outlet.

One is to place your component in /connectors/{outlet-name}/my-connector.gjs (or a .js/.hbs combo). The other way is to author your component elsewhere, and call api.renderInOutlet("{outlet-name}", MyConnectorComponent)

In both cases, the outlet args will be passed through to your component.