Skip to content

docs(animations): update developers on state of package #44014

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

Closed
michaelurban wants to merge 2 commits into from
Closed

docs(animations): update developers on state of package #44014

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
837f367
docs(animations): update developers on state of package
Nov 2, 2021
1248eeb
fixup! docs(animations): update developers on state of package
petebacondarwin Nov 6, 2021
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
2 changes: 1 addition & 1 deletion aio/content/guide/animations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
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>
Comment thread
petebacondarwin marked this conversation as resolved.
Outdated
</tr>

</table>
Expand Down
11 changes: 11 additions & 0 deletions aio/content/guide/route-animations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
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
View file
Open in desktop
Original file line number Diff line number Diff line change
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