Skip to content

Commit

Permalink
docs(getting-started): include cdk in systemjs config (angular#5626)
Browse files Browse the repository at this point in the history
* The getting started guide includes a brief section for the SystemJS configuration of a project using Angular Material. This extra section now also needs to include the CDK package.

Fixes angular#5624
  • Loading branch information
devversion authored and jelbourn committed Jul 10, 2017
1 parent 557b31b commit 145ca8e
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions guides/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ For existing apps, follow these steps to begin using Angular Material.
npm install --save @angular/material @angular/cdk
```

A snapshot build with the latest changes from master is also available. Note that this snapshot build should not be considered stable and may break between releases.
A snapshot build with the latest changes from master is also available. Note that this snapshot
build should not be considered stable and may break between releases.

```bash
npm install --save angular/material2-builds angular/cdk-builds
Expand Down Expand Up @@ -134,15 +135,16 @@ Note that `md-icon` supports any font or svg icons; using Material Icons is one

## Appendix: Configuring SystemJS

If your project is using SystemJS for module loading, you will need to add `@angular/material`
to the SystemJS configuration:
If your project is using SystemJS for module loading, you will need to add `@angular/material` and
`@angular/cdk` to the SystemJS configuration:

```js
System.config({
// existing configuration options
map: {
// ...
'@angular/material': 'npm:@angular/material/bundles/material.umd.js',
'@angular/cdk': 'npm:@angular/cdk/bundles/cdk.umd.js'
// ...
}
});
Expand Down

0 comments on commit 145ca8e

Please sign in to comment.