docs(aio): add NgModule docs

angular · Jan 9, 2018 · 788bcb5 · 788bcb5
1 parent 80a5b91
commit 788bcb5
Show file tree

Hide file tree

Showing 205 changed files with 3,814 additions and 2,426 deletions.
diff --git a/aio/content/examples/bootstrapping/bs-config.1.json b/aio/content/examples/bootstrapping/bs-config.1.json
@@ -0,0 +1,8 @@
+{
+  "server": {
+    "baseDir": "src",
+    "routes": {
+      "/node_modules": "node_modules"
+    }
+  }
+}
diff --git a/aio/content/examples/bootstrapping/e2e/app.e2e-spec.ts b/aio/content/examples/bootstrapping/e2e/app.e2e-spec.ts
@@ -0,0 +1,14 @@
+import { AppPage } from './app.po';
+
+describe('feature-modules App', () => {
+  let page: AppPage;
+
+  beforeEach(() => {
+    page = new AppPage();
+  });
+
+  it('should display message saying app works', () => {
+    page.navigateTo();
+    expect(page.getParagraphText()).toEqual('app works!');
+  });
+});
diff --git a/...ent/examples/ngmodule/example-config.json → ...xamples/bootstrapping/example-config.json b/...ent/examples/ngmodule/example-config.json → ...xamples/bootstrapping/example-config.json
diff --git a/aio/content/examples/bootstrapping/plnkr.json b/aio/content/examples/bootstrapping/plnkr.json
@@ -0,0 +1,11 @@
+{
+  "description": "Bootstrapping",
+  "basePath": "src/",
+  "files": [
+    "!**/*.d.ts",
+    "!**/*.js",
+    "!**/*.[1,2].*"
+  ],
+  "open": "app/app.component.ts",
+  "tags": ["ngmodules"]
+}
diff --git a/aio/content/examples/bootstrapping/src/app/app.component.css b/aio/content/examples/bootstrapping/src/app/app.component.css
diff --git a/aio/content/examples/bootstrapping/src/app/app.component.html b/aio/content/examples/bootstrapping/src/app/app.component.html
@@ -0,0 +1,3 @@
+<h1>
+  {{title}}
+</h1>
diff --git a/aio/content/examples/bootstrapping/src/app/app.component.spec.ts b/aio/content/examples/bootstrapping/src/app/app.component.spec.ts
@@ -0,0 +1,32 @@
+import { TestBed, async } from '@angular/core/testing';
+import { AppComponent } from './app.component';
+
+describe('AppComponent', () => {
+  beforeEach(() => {
+    TestBed.configureTestingModule({
+      declarations: [
+        AppComponent
+      ],
+    });
+    TestBed.compileComponents();
+  });
+
+  it('should create the app', async(() => {
+    const fixture = TestBed.createComponent(AppComponent);
+    const app = fixture.debugElement.componentInstance;
+    expect(app).toBeTruthy();
+  }));
+
+  it(`should have as title 'app works!'`, async(() => {
+    const fixture = TestBed.createComponent(AppComponent);
+    const app = fixture.debugElement.componentInstance;
+    expect(app.title).toEqual('app works!');
+  }));
+
+  it('should render title in a h1 tag', async(() => {
+    const fixture = TestBed.createComponent(AppComponent);
+    fixture.detectChanges();
+    const compiled = fixture.debugElement.nativeElement;
+    expect(compiled.querySelector('h1').textContent).toContain('app works!');
+  }));
+});
diff --git a/aio/content/examples/bootstrapping/src/app/app.component.ts b/aio/content/examples/bootstrapping/src/app/app.component.ts
@@ -0,0 +1,10 @@
+import { Component } from '@angular/core';
+
+@Component({
+  selector: 'app-root',
+  templateUrl: './app.component.html',
+  styleUrls: ['./app.component.css']
+})
+export class AppComponent {
+  title = 'app works!';
+}
diff --git a/aio/content/examples/bootstrapping/src/app/app.module.ts b/aio/content/examples/bootstrapping/src/app/app.module.ts
@@ -0,0 +1,34 @@
+// #docplaster
+// #docregion whole-ngmodule
+
+// imports
+import { BrowserModule } from '@angular/platform-browser';
+import { NgModule } from '@angular/core';
+import { FormsModule } from '@angular/forms';
+import { HttpModule } from '@angular/http';
+
+import { AppComponent } from './app.component';
+// #docregion directive-import
+import { ItemDirective } from './item.directive';
+// #enddocregion directive-import
+
+
+// @NgModule decorator with its metadata
+@NgModule({
+// #docregion declarations
+  declarations: [
+    AppComponent,
+    ItemDirective
+  ],
+  // #enddocregion declarations
+  imports: [
+    BrowserModule,
+    FormsModule,
+    HttpModule
+  ],
+  providers: [],
+  bootstrap: [AppComponent]
+})
+export class AppModule { }
+
+// #enddocregion whole-ngmodule
diff --git a/aio/content/examples/bootstrapping/src/app/item.directive.spec.ts b/aio/content/examples/bootstrapping/src/app/item.directive.spec.ts
@@ -0,0 +1,8 @@
+import { ItemDirective } from './item.directive';
+
+describe('ItemDirective', () => {
+  it('should create an instance', () => {
+    const directive = new ItemDirective();
+    expect(directive).toBeTruthy();
+  });
+});
diff --git a/aio/content/examples/bootstrapping/src/app/item.directive.ts b/aio/content/examples/bootstrapping/src/app/item.directive.ts
@@ -0,0 +1,15 @@
+// #docplaster
+// #docregion directive
+
+
+import { Directive } from '@angular/core';
+
+@Directive({
+  selector: '[appItem]'
+})
+export class ItemDirective {
+// code goes here
+  constructor() { }
+
+}
+// #enddocregion directive
diff --git a/aio/content/examples/bootstrapping/src/index.html b/aio/content/examples/bootstrapping/src/index.html
@@ -0,0 +1,14 @@
+<!doctype html>
+<html>
+<head>
+  <meta charset="utf-8">
+  <title>NgmoduleDemo</title>
+  <base href="/">
+
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <link rel="icon" type="image/x-icon" href="favicon.ico">
+</head>
+<body>
+  <app-root>Loading...</app-root>
+</body>
+</html>
diff --git a/aio/content/examples/bootstrapping/src/main.ts b/aio/content/examples/bootstrapping/src/main.ts
@@ -0,0 +1,11 @@
+import { enableProdMode } from '@angular/core';
+import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
+
+import { AppModule } from './app/app.module';
+import { environment } from './environments/environment';
+
+if (environment.production) {
+  enableProdMode();
+}
+
+platformBrowserDynamic().bootstrapModule(AppModule);
diff --git a/aio/content/examples/feature-modules/e2e/app.e2e-spec.ts b/aio/content/examples/feature-modules/e2e/app.e2e-spec.ts
@@ -0,0 +1,17 @@
+import { AppPage } from './app.po';
+
+describe('feature-modules App', () => {
+  let page: AppPage;
+
+  beforeEach(() => {
+    page = new AppPage();
+  });
+
+  it('should display message saying app works', () => {
+    page.navigateTo();
+    expect(page.getParagraphText()).toEqual('app works!');
+  });
+});
+
+
+
diff --git a/aio/content/examples/feature-modules/example-config.json b/aio/content/examples/feature-modules/example-config.json
@@ -0,0 +1,4 @@
+{
+  "build": "build:cli",
+  "run": "serve:cli"
+}
diff --git a/aio/content/examples/feature-modules/plnkr.json b/aio/content/examples/feature-modules/plnkr.json
@@ -0,0 +1,11 @@
+{
+  "description": "Feature Modules",
+  "basePath": "src/",
+  "files": [
+    "!**/*.d.ts",
+    "!**/*.js",
+    "!**/*.[1,2].*"
+  ],
+  "open": "app/app.component.ts",
+  "tags": ["feature modules"]
+}
diff --git a/aio/content/examples/feature-modules/src/app/app.component.css b/aio/content/examples/feature-modules/src/app/app.component.css
diff --git a/aio/content/examples/feature-modules/src/app/app.component.html b/aio/content/examples/feature-modules/src/app/app.component.html
@@ -0,0 +1,9 @@
+<!-- #docplaster -->
+<!-- #docregion app-component-template -->
+<h1>
+  {{title}}
+</h1>
+
+<!-- add the selector from the CustomerDashboardComponent -->
+<app-customer-dashboard></app-customer-dashboard>
+<!-- #enddocregion app-component-template -->
diff --git a/aio/content/examples/feature-modules/src/app/app.component.spec.ts b/aio/content/examples/feature-modules/src/app/app.component.spec.ts
@@ -0,0 +1,32 @@
+import { TestBed, async } from '@angular/core/testing';
+import { AppComponent } from './app.component';
+
+describe('AppComponent', () => {
+  beforeEach(() => {
+    TestBed.configureTestingModule({
+      declarations: [
+        AppComponent
+      ],
+    });
+    TestBed.compileComponents();
+  });
+
+  it('should create the app', async(() => {
+    const fixture = TestBed.createComponent(AppComponent);
+    const app = fixture.debugElement.componentInstance;
+    expect(app).toBeTruthy();
+  }));
+
+  it(`should have as title 'app works!'`, async(() => {
+    const fixture = TestBed.createComponent(AppComponent);
+    const app = fixture.debugElement.componentInstance;
+    expect(app.title).toEqual('app works!');
+  }));
+
+  it('should render title in a h1 tag', async(() => {
+    const fixture = TestBed.createComponent(AppComponent);
+    fixture.detectChanges();
+    const compiled = fixture.debugElement.nativeElement;
+    expect(compiled.querySelector('h1').textContent).toContain('app works!');
+  }));
+});
diff --git a/aio/content/examples/feature-modules/src/app/app.component.ts b/aio/content/examples/feature-modules/src/app/app.component.ts
@@ -0,0 +1,10 @@
+import { Component } from '@angular/core';
+
+@Component({
+  selector: 'app-root',
+  templateUrl: './app.component.html',
+  styleUrls: ['./app.component.css']
+})
+export class AppComponent {
+  title = 'app works!';
+}
diff --git a/aio/content/examples/feature-modules/src/app/app.module.ts b/aio/content/examples/feature-modules/src/app/app.module.ts
@@ -0,0 +1,27 @@
+// #docplaster
+// #docregion app-module
+import { BrowserModule } from '@angular/platform-browser';
+import { NgModule } from '@angular/core';
+import { FormsModule } from '@angular/forms';
+import { HttpModule } from '@angular/http';
+
+import { AppComponent } from './app.component';
+// import the feature module here so you can add it to the imports array below
+import { CustomerDashboardModule } from './customer-dashboard/customer-dashboard.module';
+
+
+@NgModule({
+  declarations: [
+    AppComponent
+  ],
+  imports: [
+    BrowserModule,
+    FormsModule,
+    HttpModule,
+    CustomerDashboardModule // add the feature module here
+  ],
+  providers: [],
+  bootstrap: [AppComponent]
+})
+export class AppModule { }
+// #enddocregion app-module
diff --git a/aio/content/examples/feature-modules/src/app/customer-dashboard/customer-dashboard.module.ts b/aio/content/examples/feature-modules/src/app/customer-dashboard/customer-dashboard.module.ts
@@ -0,0 +1,34 @@
+// #docplaster
+// #docregion customer-dashboard
+import { NgModule } from '@angular/core';
+import { CommonModule } from '@angular/common';
+// #enddocregion customer-dashboard
+// #docregion customer-dashboard-component
+// import the new component
+import { CustomerDashboardComponent } from './customer-dashboard/customer-dashboard.component';
+// #enddocregion customer-dashboard-component
+
+
+// #docregion customer-dashboard-component
+@NgModule({
+  imports: [
+    CommonModule
+  ],
+  declarations: [
+    CustomerDashboardComponent
+  ],
+  // #enddocregion customer-dashboard-component
+  // #docregion component-exports
+  exports: [
+    CustomerDashboardComponent
+  ]
+  // #enddocregion component-exports
+  // #docregion customer-dashboard-component
+})
+
+// #enddocregion customer-dashboard-component
+
+// #docregion customer-dashboard
+export class CustomerDashboardModule { }
+
+// #enddocregion customer-dashboard
diff --git a/...re-modules/src/app/customer-dashboard/customer-dashboard/customer-dashboard.component.css b/...re-modules/src/app/customer-dashboard/customer-dashboard/customer-dashboard.component.css
diff --git a/...e-modules/src/app/customer-dashboard/customer-dashboard/customer-dashboard.component.html b/...e-modules/src/app/customer-dashboard/customer-dashboard/customer-dashboard.component.html
@@ -0,0 +1,7 @@
+
+<!-- #docplaster -->
+<!-- #docregion feature-template -->
+<p>
+  customer-dashboard works!
+</p>
+<!-- #enddocregion feature-template -->
diff --git a/...odules/src/app/customer-dashboard/customer-dashboard/customer-dashboard.component.spec.ts b/...odules/src/app/customer-dashboard/customer-dashboard/customer-dashboard.component.spec.ts
@@ -0,0 +1,25 @@
+import { async, ComponentFixture, TestBed } from '@angular/core/testing';
+
+import { CustomerDashboardComponent } from './customer-dashboard.component';
+
+describe('CustomerDashboardComponent', () => {
+  let component: CustomerDashboardComponent;
+  let fixture: ComponentFixture<CustomerDashboardComponent>;
+
+  beforeEach(async(() => {
+    TestBed.configureTestingModule({
+      declarations: [ CustomerDashboardComponent ]
+    })
+    .compileComponents();
+  }));
+
+  beforeEach(() => {
+    fixture = TestBed.createComponent(CustomerDashboardComponent);
+    component = fixture.componentInstance;
+    fixture.detectChanges();
+  });
+
+  it('should create', () => {
+    expect(component).toBeTruthy();
+  });
+});
diff --git a/...ure-modules/src/app/customer-dashboard/customer-dashboard/customer-dashboard.component.ts b/...ure-modules/src/app/customer-dashboard/customer-dashboard/customer-dashboard.component.ts
@@ -0,0 +1,15 @@
+import { Component, OnInit } from '@angular/core';
+
+@Component({
+  selector: 'app-customer-dashboard',
+  templateUrl: './customer-dashboard.component.html',
+  styleUrls: ['./customer-dashboard.component.css']
+})
+export class CustomerDashboardComponent implements OnInit {
+
+  constructor() { }
+
+  ngOnInit() {
+  }
+
+}
diff --git a/aio/content/examples/feature-modules/src/index.html b/aio/content/examples/feature-modules/src/index.html
@@ -0,0 +1,14 @@
+<!doctype html>
+<html>
+<head>
+  <meta charset="utf-8">
+  <title>Feature Modules</title>
+  <base href="/">
+
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <link rel="icon" type="image/x-icon" href="favicon.ico">
+</head>
+<body>
+  <app-root>Loading...</app-root>
+</body>
+</html>
diff --git a/aio/content/examples/feature-modules/src/main.ts b/aio/content/examples/feature-modules/src/main.ts
@@ -0,0 +1,11 @@
+import { enableProdMode } from '@angular/core';
+import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
+
+import { AppModule } from './app/app.module';
+import { environment } from './environments/environment';
+
+if (environment.production) {
+  enableProdMode();
+}
+
+platformBrowserDynamic().bootstrapModule(AppModule);