Skip to content

docs: update information about schematics #11091

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 2, 2018
Merged

docs: update information about schematics #11091

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 9 additions & 14 deletions guides/schematics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,13 @@ Schematics come packaged with Angular Material, so once you have
installed the npm package, they will be available via the Angular CLI.

If you run it will automatically install Angular Material for you
and run the shell schematic.
and run the install schematic.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is actually called "shell" in the collection.json. We should change that, too.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"shell" typically means "app shell" which includes navigation similar to the material-nav schematic, but that is not included in the shell/install schematic as far as I know.

if you'd like to change the underlying schematic name, then could someone please take over this PR as I'm not familiar with the implementation details and won't have time to follow up on this PR today.


```
ng add @angular/material
```

## Packaged Schematics
Angular Material has 4 schematics it comes packaged with:

- Material Shell
- Navigation
- Dashboard
- Table

### Shell Schematic
The shell schematic will help you quickly add Material to a new project.
The install schematic will help you quickly add Material to a new project.
This schematic will:

- Ensure project depedencies in `package.json`
Expand All @@ -30,9 +21,13 @@ This schematic will:
- Adds Roboto fonts to your index.html
- Apply simple CSS reset to body

```
ng add @angular/material
```

## Generator Schematics
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know if "Generator Schematics" is the best term, but all the schematics are "packaged" so it seems like suboptimal name. I'd rather differentiate them by how they are used "install vs generator" than "shell vs packaged". please let me know if you think otherwise.

In addition to the install schematic Angular Material has three schematics it comes packaged with:

- Navigation
- Dashboard
- Table

### Navigation Schematic
The navigation schematic will create a new component that includes
Expand Down