# Feature modules

Feature modules are NgModules for the purpose of organizing code.

For the final sample application with a feature module that this page describes, see the <live-example></live-example>.

As your application grows, you can organize code relevant for a specific feature.
This helps apply clear boundaries for features.
With feature modules, you can keep code related to a specific functionality or feature separate from other code.
Delineating areas of your application helps with collaboration between developers and teams, separating directives, and managing the size of the root module.

## Feature modules vs. root modules

A feature module is an organizational best practice, as opposed to a concept of the core Angular API.
A feature module delivers a cohesive set of functionality focused on a specific application need such as a user workflow, routing, or forms.
While you can do everything within the root module, feature modules help you partition the application into focused areas.
A feature module collaborates with the root module and with other modules through the services it provides and the components, directives, and pipes that it shares.

## How to make a feature module

Assuming you already have an application that you created with the [Angular CLI](cli), create a feature module using the CLI by entering the following command in the root project directory.
Replace `CustomerDashboard` with the name of your module.
You can omit the "Module" suffix from the name because the CLI appends it:

<code-example format="shell" language="shell">

ng generate module CustomerDashboard

</code-example>

This causes the CLI to create a folder called `customer-dashboard` with a file inside called `customer-dashboard.module.ts` with the following contents:

<code-example format="typescript" language="typescript">

import { NgModule } from '&commat;angular/core';
import { CommonModule } from '&commat;angular/common';

&commat;NgModule({
  imports: [
    CommonModule
  ],
  declarations: []
})
export class CustomerDashboardModule { }

</code-example>

The structure of an NgModule is the same whether it is a root module or a feature module.
In the CLI generated feature module, there are two JavaScript import statements at the top of the file: the first imports `NgModule`, which, like the root module, lets you use the `@NgModule` decorator; the second imports `CommonModule`, which contributes many common directives such as `ngIf` and `ngFor`.
Feature modules import `CommonModule` instead of `BrowserModule`, which is only imported once in the root module.
`CommonModule` only contains information for common directives such as `ngIf` and `ngFor` which are needed in most templates, whereas `BrowserModule` configures the Angular application for the browser which needs to be done only once.

The `declarations` array is available for you to add declarables, which are components, directives, and pipes that belong exclusively to this particular module.
To add a component, enter the following command at the command line where `customer-dashboard` is the directory where the CLI generated the feature module and `CustomerDashboard` is the name of the component:

<code-example format="shell" language="shell">

ng generate component customer-dashboard/CustomerDashboard

</code-example>

This generates a folder for the new component within the customer-dashboard folder and updates the feature module with the `CustomerDashboardComponent` info:

<code-example header="src/app/customer-dashboard/customer-dashboard.module.ts" path="feature-modules/src/app/customer-dashboard/customer-dashboard.module.ts" region="customer-dashboard-component"></code-example>

The `CustomerDashboardComponent` is now in the JavaScript import list at the top and added to the `declarations` array, which lets Angular know to associate this new component with this feature module.

## Importing a feature module

To incorporate the feature module into your app, you have to let the root module, `app.module.ts`, know about it.
Notice the `CustomerDashboardModule` export at the bottom of `customer-dashboard.module.ts`.
This exposes it so that other modules can get to it.
To import it into the `AppModule`, add it to the imports in `app.module.ts` and to the `imports` array:

<code-example header="src/app/app.module.ts" path="feature-modules/src/app/app.module.ts" region="app-module"></code-example>

Now the `AppModule` knows about the feature module.
If you were to add any service providers to the feature module, `AppModule` would know about those too, as would any other feature modules.
However, NgModules don't expose their components by default.

## Rendering a feature module's component template

When the CLI generated the `CustomerDashboardComponent` for the feature module, it included a template, `customer-dashboard.component.html`, with the following markup:

<code-example header="src/app/customer-dashboard/customer-dashboard/customer-dashboard.component.html" path="feature-modules/src/app/customer-dashboard/customer-dashboard/customer-dashboard.component.html" region="feature-template"></code-example>

To see this HTML in the `AppComponent`, you first have to export the `CustomerDashboardComponent` in the `CustomerDashboardModule`.
In `customer-dashboard.module.ts`, just beneath the `declarations` array, add an `exports` array containing `CustomerDashboardComponent`:

<code-example header="src/app/customer-dashboard/customer-dashboard.module.ts" path="feature-modules/src/app/customer-dashboard/customer-dashboard.module.ts" region="component-exports"></code-example>

Next, in the `AppComponent`, `app.component.html`, add the tag `<app-customer-dashboard>`:

<code-example header="src/app/app.component.html" path="feature-modules/src/app/app.component.html" region="app-component-template"></code-example>

Now, in addition to the title that renders by default, the `CustomerDashboardComponent` template renders too:

<div class="lightbox">

<img alt="feature module component" src="generated/images/guide/feature-modules/feature-module.png">

</div>

## More on NgModules

You may also be interested in the following:

*   [Lazy Loading Modules with the Angular Router](guide/lazy-loading-ngmodules)
*   [Providers](guide/providers)
*   [Types of Feature Modules](guide/module-types)

<!-- links -->

<!-- external links -->

<!-- end links -->

@reviewed 2022-02-28