docs: Getting started guide update about animations #12377
Conversation
|
Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). 📝 Please visit https://cla.developers.google.com/ to sign. Once you've signed (or fixed any issues), please reply here (e.g. What to do if you already signed the CLAIndividual signers
Corporate signers
|
googlebot
added
the
cla: no
|
☑️ CLA signed |
|
CLAs look good, thanks! |
googlebot
added
cla: yes
guides/getting-started.md
Outdated
| Some Material components depend on the Angular animations module in order to be able to do | ||
| more advanced transitions. If you want these animations to work in your app, you have to | ||
| install the `@angular/animations` module and include the `BrowserAnimationsModule` in your app. | ||
| Animations package is required to build application with Material components, but you don't have to configure it unless you use animated components like Drawer, Bottom Sheet etc. |
There was a problem hiding this comment.
nit: "Material components" -> "Angular Material"
There was a problem hiding this comment.
Another nit: "Animations package" -> "The @angular/animations package"
guides/getting-started.md
Outdated
| Some Material components depend on the Angular animations module in order to be able to do | ||
| more advanced transitions. If you want these animations to work in your app, you have to | ||
| install the `@angular/animations` module and include the `BrowserAnimationsModule` in your app. | ||
| Animations package is required to build application with Material components, but you don't have to configure it unless you use animated components like Drawer, Bottom Sheet etc. |
There was a problem hiding this comment.
I would omit the part "but you don't have to configure it unless you use animated components like Drawer, Bottom Sheet etc." since we might end up adding animations to other components in the future. For the getting started guide, it's simpler to always tell people to add an animations module.
There was a problem hiding this comment.
@jelbourn what do you think about to move the installation part to the Step 1 and here to leave only configuration of Browser/Noop animation.
guides/getting-started.md
Outdated
| @@ -59,7 +59,7 @@ import {BrowserAnimationsModule} from '@angular/platform-browser/animations'; | |||
| export class PizzaPartyAppModule { } | |||
| ``` | |||
|
|
|||
| If you don't want to add another dependency to your project, you can use the `NoopAnimationsModule`. | |||
| If you want to disable animation for these components you can use the `NoopAnimationsModule`. | |||
There was a problem hiding this comment.
I would phrase this as
Alternatively, you can disable animations by importing `NoopAnimationsModule`.
guides/getting-started.md
Outdated
| @@ -48,6 +46,8 @@ npm install --save @angular/animations | |||
| yarn add @angular/animations | |||
| ``` | |||
|
|
|||
| If you want to provide animations for these components include the `BrowserAnimationsModule` in your app. | |||
There was a problem hiding this comment.
I would phrase this as
Once the animations package is installed, import `BrowserAnimationsModule` into your application.
jelbourn
added
pr: lgtm
docs
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
Closes #12365