Angular 2 @NgModel [Purpose Of Root Module & Export Module]

The @NgModule is a new decorator. This module is recently added in Angular 2.

The @NgModule is a class and work with the @NgModule decorator function. @NgModule takes a metadata object that tells Angular “how to compile and run module code”.

The @NgModules page guides you from the most elementary @NgModule to a multi-faceted sample with lazy modules.

Stayed Informed – Angular 2 vs. Angular 1

Stayed Informed - Angular 4 vs. Angular 2

The @NgModule main use to simplify the way you define and manage the dependencies in your applications and using @NgModule you can consolidate different components and services into cohesive blocks of functionality.

The Basic Example of @NgModule as,

@NgModule({
  imports: [BrowserModule],
  declarations: [YourComponent],
  bootstrap: [YourComponent]
})
class YourAppModule {}

The @NgModule is a way to organize your dependencies for

1.      Compiler

2.      Dependency Injection

The declarations of @NgModule.declarations as,

@NgModule({
     declarations: [
        AppComponent,
        YourComponent,
        YourDirective,
        YourPipe,
        ...OTHER DIRECTIVES AND SO ON.
   ]
})

The @NgModule providers as,

@NgModule({
    providers: [
        YourService,
        SomeLibraryService,
    ],
})

The @NgModule exporting as,

@NgModule({
    declarations: [YourComponent, YourPipe]
    exports: [YourComponent, YourPipe],
    providers: [YourService]
})
export class YourModule { }

Why Angular 2 modules needed?

An Angular @NgModule allows us to define a context for compiling templates.

Why @NgModule?

1.      Easy to use Components

2.      Easy to use Directives

3.      Easy to use Pipes

4.      Providers’ Inheritance

5.      Library Architecture

6.      Easy to migrate from angular.module()

7.      So on

What is a Root Module?

Each application only has one root module and each component, directive and pipe should only be associated to a single module. This one is the main reason.

How Should We Organize Modules?

There are no standard ways to group modules, but the recommendations are,

1.      Features as a module

2.      Shared utilities as a module

Module’s Features:-

For example, suppose that your application has customer, product and feature. Each module has some components, directives and pipes.

Module’s Utility:-

For the functions or features that can be shared across modules and application, consider creating a shared module.

How to declaration Module?

import {NgModule, ApplicationRef} from '@angular/core';
import {CommonModule} from '@angular/common';
import {FormsModule} from '@angular/forms';
import {MaterialModule} from '@angular2-material/module';
import {AppComponent} from './app.component';

@NgModule({
  declarations: [AppComponent],
  imports: [BrowserModule, CommonModule, FormsModule, MaterialModule],
  entryComponents: [AppComponent]
})
class AppModule {
  constructor(appRef: ApplicationRef) {
    appRef.bootstrap(AppComponent);
  }
}

//Bootstrapping

import {AppModule} from './app.module';
import {platformBrowserDynamic} from '@angular/browser-platform-dynamic';
platformBrowserDynamic().bootstrapModule(AppModule);


@NgModule
class NgModule {
  declarations: Array<ComponentType | DirectiveType | PipeType>;
  imports: Array<ModuleType | ModuleWithProviders>;
  exports: Array<ComponentType | DirectiveType | PipeType | ModuleType>;
  providers: Array<Providers | Array<any> >;
  entryComponents: Array<ComponentType>;
  schemas: Array<any>;
}

What is One Root Module?

When we create an Angular 2 app, we define a root module. We learned about this in the previous post. This root module is defined with @NgModule and works quite well for small apps.

// app.module.ts
@NgModule({
  imports: [BrowserModule, FormsModule, HttpModule],
  declarations: [
    AppComponent,
    VehicleListComponent,
    VehicleSelectionDirective,
    VehicleSortingPipe
  ],
  providers: [
    LoggerService,
    VehicleService,
    UserProfileService
  ],
  bootstrap: [AppComponent],
})
export class AppModule { }  

Our root module declares our components, pipes and directives.

Our root module imports common features from the Angular 2 BrowserModule, FormsModule, and HttpModule.

Final Conclusions are,

1.      The Use of NgModule.providers

a.     Remove Component.providers

2.      Use NgModule.declarations

a.     Remove Component.directives/pipes

3.      Keep a single scope

4.      Use modules

a.     Http, Forms, Router, and so on.

5.      Make modules

6.      Module as a Library

I hope you are enjoying with this post! Please share with you friends. Thank you so much!