github-mirror/discourse
2
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2024-11-26 11:13:38 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

DEV: Add note about wrapper element to renderInOutlet API (#23903)

Browse Source
This commit is contained in:
David Taylor 2023-10-11 23:11:08 +01:00 committed by GitHub
parent 2ae913f45e
commit e2e30788b9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
app/assets/javascripts/discourse/app/lib/plugin-api.js
View File

@ -985,6 +985,10 @@ class PluginApi {
* api.renderInOutlet('user-profile-primary', <template>Hello world</template>);
* ```
*
* 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
*