From e2e30788b92aacaad2a6d485f5b35360daf1e771 Mon Sep 17 00:00:00 2001 From: David Taylor Date: Wed, 11 Oct 2023 23:11:08 +0100 Subject: [PATCH] DEV: Add note about wrapper element to `renderInOutlet` API (#23903) --- app/assets/javascripts/discourse/app/lib/plugin-api.js | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/app/assets/javascripts/discourse/app/lib/plugin-api.js b/app/assets/javascripts/discourse/app/lib/plugin-api.js index 9457a17b193..71e4bccb8fd 100644 --- a/app/assets/javascripts/discourse/app/lib/plugin-api.js +++ b/app/assets/javascripts/discourse/app/lib/plugin-api.js @@ -985,6 +985,10 @@ class PluginApi { * api.renderInOutlet('user-profile-primary', ); * ``` * + * Note that when passing a component definition to an outlet like this, the default + * `@connectorTagName` of the outlet is not used. If you need a wrapper element, you'll + * need to add it to your component's template. + * * @param {string} outletName - Name of plugin outlet to render into * @param {Component} klass - Component class definition to be rendered *