@luigi-project/client-support-angular

ClientSupportAngular

This library provides several features to run your Angular application inside the Luigi micro frontend framework.
If you want to know more about Luigi, please have a look at the Luigi homepage.

How to use the library

1. Import the library in the package.json:

npm install @luigi-project/client-support-angular -s

1. Once the library is imported and saved in your Angular project, you need to import the module LuigiAngularSupportModule:

imports: [
  ........
  ,LuigiAngularSupportModule
],

Features

These are the main features provided by the library:

• LuigiContextService
• LuigiAutoRoutingService

LuigiContextService

You can inject this service inside your Angular items in order to:

• Get the current (latest) Context that we received from Luigi Core
• Provide an Observable where through subscribing, you can get any Context change

LuigiContextService is an abstract class. Its implementation is in the LuigiContextServiceImpl class.
If you need to change or extend the implementation, you can easily create a new class extending LuigiContextServiceImpl:

In this class, we added the possibility to "reuse" a component and not initialize it every time you load it (it could be useful to keep component state.)

export class YourContextService extends  LuigiContextServiceImpl {
    ....    
}

Inside your module, redefine the provider:

providers: [
   {
       provide: LuigiContextService,
       useClass: YourContextService
   }
]

LuigiAutoRoutingService

This service cannot be used directly, but it will provide useful features on how to synchronize your angular application with Luigi navigation.
It can happen that in your microfrontend, user can navigate through different components/pages.
With this feature we provide an easy way of synchronizing angular route with Luigi navigation; in angular route configuration, you can now add in data these attributes:

{path: 'luigi-client-support-preload',component: Sample1Component,data: { fromVirtualTreeRoot: true }}
{path: 'luigi-client-support-preload',component: Sample2Component,data: { luigiRoute: '/home/sample2' }}

with data: { fromVirtualTreeRoot: true }, once we load Sample1Component, we will call Luigi Client:

 luigiClient.linkManager().fromVirtualTreeRoot().withoutSync().navigate({route url});

with data: { luigiRoute: '/home/sample2' }, uses luigiClient API in this way:

 luigiClient.linkManager().withoutSync().navigate(data.luigiRoute);

More information about linkManager can be found here.

LuigiRouteStrategy

To use LuigiAutoRoutingService, this library defines a new RouteReuseStrategy named LuigiRouteStrategy.
If you need to define your own RouteReuseStrategy, you can extend LuigiRouteStrategy by overriding it in this way:

export class YourRouteStrategy extends LuigiRouteStrategy {

   retrieve(route: ActivatedRouteSnapshot): DetachedRouteHandle {
       super.retrieve(route);
       // Your code
   }

}

and define the provider:

{
     provide: RouteReuseStrategy,
     useClass: YourRouteStrategy
}

We also provide an example of how to extend LuigiRouteStrategy in class LuigiReuseRouteStrategy.
In this class, we added the possibility to "reuse" a component and not initialize it every time you load it (it could be useful to keep component state.)

LuigiReuseRouteStrategy can be configured in the following way:

{path: 'luigi-client-support-preload',component: Sample1Component,data: { reuse: true }}

If you want to use LuigiReuseRouteStrategy (it is not enabled by default), you need to configure in your application:

{
     provide: RouteReuseStrategy,
     useClass: LuigiReuseRouteStrategy
}