DEV: Deprecate PluginOutlet `@args` in favour of `@outletArgs`

This commit is contained in:
David Taylor 2023-01-31 12:47:40 +00:00
parent fe4a71848e
commit 84f6a8399d
1 changed files with 8 additions and 0 deletions

View File

@ -16,6 +16,8 @@ const GET_DEPRECATION_MSG =
"Plugin outlet context is no longer an EmberObject - using `get()` is deprecated."; "Plugin outlet context is no longer an EmberObject - using `get()` is deprecated.";
const TAG_NAME_DEPRECATION_MSG = const TAG_NAME_DEPRECATION_MSG =
"The `tagName` argument to PluginOutlet is deprecated. If a wrapper element is required, define it manually around the outlet call."; "The `tagName` argument to PluginOutlet is deprecated. If a wrapper element is required, define it manually around the outlet call.";
const ARGS_DEPRECATION_MSG =
"PluginOutlet arguments should now be passed using `@outletArgs=` instead of `@args=`";
/** /**
A plugin outlet is an extension point for templates where other templates can A plugin outlet is an extension point for templates where other templates can
@ -67,6 +69,12 @@ export default class PluginOutletComponent extends GlimmerComponentWithDeprecate
}); });
} }
if (this.args.args) {
deprecated(`${ARGS_DEPRECATION_MSG} (outlet: ${this.args.name})`, {
id: "discourse.plugin-outlet-args",
});
}
return result; return result;
} }