Skip to content

docs: schematics #10502

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.

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 2 commits into from
Apr 6, 2018
Merged

docs: schematics #10502

merged 2 commits into from
Apr 6, 2018

Conversation

amcdnl
Copy link
Contributor

@amcdnl amcdnl commented Mar 20, 2018

Adds simple docs for the schematics

@amcdnl amcdnl self-assigned this Mar 20, 2018
@amcdnl amcdnl requested a review from jelbourn March 20, 2018 20:15
@googlebot googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Mar 20, 2018
@amcdnl amcdnl requested a review from josephperrott March 20, 2018 20:15
@@ -0,0 +1,53 @@
Angular Material comes packaged with Angular CLI schematics to make
creating new components easy.
Copy link
Member

Choose a reason for hiding this comment

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

Does this make creating Material applications easier? Or just components?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh good point, I think it should be applications.


- Ensure project depedencies in `package.json`
- Ensure project depedencies in your app module
- Add Prebuilt or Setup Custom Theme
Copy link
Member

Choose a reason for hiding this comment

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

Should a note be included on how to choose a prebuilt or custom theme?

Copy link
Contributor Author

@amcdnl amcdnl Mar 26, 2018

Choose a reason for hiding this comment

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

It will ask you which and add it when you launch this schematic.

### Navigation Schematic
The navigation schematic will create a new component that includes
a toolbar with the app name and the side nav pre-configured to be
responsive.
Copy link
Member

Choose a reason for hiding this comment

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

responsive based on the Material Breakpoints?

responsive.

```
ng g @angular/material:material-nav
Copy link
Member

Choose a reason for hiding this comment

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

I think it is clearer if you don't use the g alias, and instead have:

ng generate @angular/material:material-nav

Copy link
Member

@jelbourn jelbourn left a comment

Choose a reason for hiding this comment

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

We should also point to this in the getting started guide.


## Install Schematics
Schematics come packaged with Angular Material, so once you have
installed the npm package, they will be available via the Angular CLI.
Copy link
Member

Choose a reason for hiding this comment

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

I think you can also do ng add @angular/material and it will install for you, but we can only test that once it's on npm

@amcdnl
Copy link
Contributor Author

amcdnl commented Mar 26, 2018

@jelbourn @josephperrott - Ready to go.

Copy link
Member

@jelbourn jelbourn left a comment

Choose a reason for hiding this comment

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

LGTM

@jelbourn jelbourn added pr: lgtm action: merge The PR is ready for merge by the caretaker target: major This PR is targeted for the next major release labels Mar 26, 2018
@jelbourn jelbourn merged commit f4b0ea3 into angular:master Apr 6, 2018
Longfld pushed a commit to Longfld/material2 that referenced this pull request Apr 6, 2018
@amcdnl amcdnl deleted the schematic-docs branch April 9, 2018 13:24
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 8, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker cla: yes PR author has agreed to Google's Contributor License Agreement target: major This PR is targeted for the next major release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants