IRemotePluggableApplicationModule
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Definition of the remote pluggable application. The application is loaded via Module Federation.
export interface IRemotePluggableApplicationModule
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (ALPHA) Exposed module name. Must match the remote module definition. Maps to internal application module (e.g. “./src/remote-entry.tsx”) | ||
string | (ALPHA) Base route of the application. It is relative to the shell application route. | ||
string | (ALPHA) Unique module federation scope value (must match the remote module definition during build) Must be unique within the same remote federation to not share dependencies and scope with another application. | ||
string | (ALPHA) Full URL of the remote federated module with the application bundle. |
Property details
IRemotePluggableApplicationModule.modulepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Exposed module name. Must match the remote module definition. Maps to internal application module (e.g. “./src/remote-entry.tsx”)
module: string;
Example
“./AppModule”
IRemotePluggableApplicationModule.routeBasepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Base route of the application. It is relative to the shell application route.
routeBase: string;
Example
“/my-application”
When the application is registered to “organization” scope, the application will be hosted at /organization/my-application. When the application is registered to the “workspace” scope, the application will be hosted at /workspace/{workspaceId}/my-application.
IRemotePluggableApplicationModule.scopepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Unique module federation scope value (must match the remote module definition during build) Must be unique within the same remote federation to not share dependencies and scope with another application.
scope: string;
Example
“my-remote-federated-module”
IRemotePluggableApplicationModule.urlpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Full URL of the remote federated module with the application bundle.
url: string;