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

This commit is contained in:
David Taylor
2023-10-11 23:11:08 +01:00
committed by GitHub
parent 2ae913f45e
commit e2e30788b9

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
*