Skip to content

Commit

Permalink
docs(animations): update developers on state of package (#44014)
Browse files Browse the repository at this point in the history
Notify developers that @angular/animations package has been "significantly de-prioritized"

`animateChild` documentation now references #30477

References #30477# Please enter the commit message for your changes. Lines starting

PR Close #44014
  • Loading branch information
Michael Urban authored and atscott committed Nov 8, 2021
1 parent 7e0c7ce commit db37f02
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 1 deletion.
2 changes: 1 addition & 1 deletion aio/content/guide/animations.md
Expand Up @@ -314,7 +314,7 @@ What it does

<tr>
<td><code>animateChild()</code></td>
<td>Allows animations on child components to be run within the same timeframe as the parent.</td>
<td>Allows animations on child components to be run within the same timeframe as the parent. <strong>Note:</strong> Please see GitHub Issue <a href="https://github.com/angular/angular/issues/30477">#30477</a> before attempting to use <code>animateChild()</code> together with route transition animations.</td>
</tr>

</table>
Expand Down
11 changes: 11 additions & 0 deletions aio/content/guide/route-animations.md
Expand Up @@ -75,6 +75,11 @@ Animations can be defined directly inside your components. For this example you

The following code snippet defines a reusable animation named `slideInAnimation`.

<div class="alert is-important">

**Note:** `animateChild()` does not currently work with route transition animations. Please see GitHub Issue <a href="https://github.com/angular/angular/issues/30477">#30477</a> for more information.

</div>

<code-example path="animations/src/app/animations.ts" header="src/app/animations.ts" region="route-animations" language="typescript"></code-example>

Expand Down Expand Up @@ -109,6 +114,12 @@ Use the `query()` method to find and animate elements within the current host co

Assume that you are routing from the *Home => About*.

<div class="alert is-important">

**Note:** `animateChild()` does not currently work with route transition animations. Please see GitHub Issue <a href="https://github.com/angular/angular/issues/30477">#30477</a> for more information.

</div>

<code-example path="animations/src/app/animations.ts" header="src/app/animations.ts (excerpt)" region="query" language="typescript"></code-example>

The animation code does the following after styling the views:
Expand Down
4 changes: 4 additions & 0 deletions packages/animations/src/animation_metadata.ts
Expand Up @@ -1114,6 +1114,10 @@ export function animation(
* with animations that are assigned using the Angular animation library. CSS keyframes
* and transitions are not handled by this API.
*
* `animateChild()` does not currently work with route transition animations. Please see
* GitHub Issue {@link https://github.com/angular/angular/issues/30477 #30477} for more
* information.
*
* @publicApi
*/
export function animateChild(options: AnimateChildOptions|null = null):
Expand Down

0 comments on commit db37f02

Please sign in to comment.