mirror of
https://github.com/angular/angular.git
synced 2026-09-14 13:54:52 +08:00
Virginia Dooley
346 lines
17 KiB
Markdown
346 lines
17 KiB
Markdown
# Animation transitions and triggers
|
|
|
|
This guide goes into depth on special transition states such as the `*` wildcard and `void`. It shows how these special states are used for elements entering and leaving a view.
|
|
This section also explores multiple animation triggers, animation callbacks, and sequence-based animation using keyframes.
|
|
|
|
## Predefined states and wildcard matching
|
|
|
|
In Angular, transition states can be defined explicitly through the [`state()`](api/animations/state) function, or using the predefined `*` wildcard and `void` states.
|
|
|
|
### Wildcard state
|
|
|
|
An asterisk `*` or *wildcard* matches any animation state.
|
|
This is useful for defining transitions that apply regardless of the HTML element's start or end state.
|
|
|
|
For example, a transition of `open => *` applies when the element's state changes from open to anything else.
|
|
|
|
<div class="lightbox">
|
|
|
|
<img alt="wildcard state expressions" src="generated/images/guide/animations/wildcard-state-500.png">
|
|
|
|
</div>
|
|
|
|
The following is another code sample using the wildcard state together with the previous example using the `open` and `closed` states.
|
|
Instead of defining each state-to-state transition pair, any transition to `closed` takes 1 second, and any transition to `open` takes 0.5 seconds.
|
|
|
|
This allows the addition of new states without having to include separate transitions for each one.
|
|
|
|
<code-example header="src/app/open-close.component.ts" path="animations/src/app/open-close.component.ts" region="trigger-wildcard1"></code-example>
|
|
|
|
Use a double arrow syntax to specify state-to-state transitions in both directions.
|
|
|
|
<code-example header="src/app/open-close.component.ts" path="animations/src/app/open-close.component.ts" region="trigger-wildcard2"></code-example>
|
|
|
|
### Use wildcard state with multiple transition states
|
|
|
|
In the two-state button example, the wildcard isn't that useful because there are only two possible states, `open` and `closed`.
|
|
In general, use wildcard states when an element has multiple potential states that it can change to.
|
|
If the button can change from `open` to either `closed` or something like `inProgress`, using a wildcard state could reduce the amount of coding needed.
|
|
|
|
<div class="lightbox">
|
|
|
|
<img alt="wildcard state with 3 states" src="generated/images/guide/animations/wildcard-3-states.png">
|
|
|
|
</div>
|
|
|
|
<code-example header="src/app/open-close.component.ts" path="animations/src/app/open-close.component.ts" region="trigger-transition"></code-example>
|
|
|
|
The `* => *` transition applies when any change between two states takes place.
|
|
|
|
Transitions are matched in the order in which they are defined.
|
|
Thus, you can apply other transitions on top of the `* => *` transition.
|
|
For example, define style changes or animations that would apply just to `open => closed`, then use `* => *` as a fallback for state pairings that aren't otherwise called out.
|
|
|
|
To do this, list the more specific transitions *before* `* => *`.
|
|
|
|
### Use wildcards with styles
|
|
|
|
Use the wildcard `*` with a style to tell the animation to use whatever the current style value is, and animate with that.
|
|
Wildcard is a fallback value that's used if the state being animated isn't declared within the trigger.
|
|
|
|
<code-example header="src/app/open-close.component.ts" path="animations/src/app/open-close.component.ts" region="transition4"></code-example>
|
|
|
|
### Void state
|
|
|
|
Use the `void` state to configure transitions for an element that is entering or leaving a page.
|
|
See [Animating entering and leaving a view](#enter-leave-view).
|
|
|
|
### Combine wildcard and void states
|
|
|
|
Combine wildcard and void states in a transition to trigger animations that enter and leave the page:
|
|
|
|
* A transition of `* => void` applies when the element leaves a view, regardless of what state it was in before it left
|
|
* A transition of `void => *` applies when the element enters a view, regardless of what state it assumes when entering
|
|
* The wildcard state `*` matches to *any* state, including `void`
|
|
|
|
## Animate entering and leaving a view
|
|
|
|
This section shows how to animate elements entering or leaving a page.
|
|
|
|
Add a new behavior:
|
|
|
|
* When you add a hero to the list of heroes, it appears to fly onto the page from the left
|
|
* When you remove a hero from the list, it appears to fly out to the right
|
|
|
|
<code-example header="src/app/hero-list-enter-leave.component.ts" path="animations/src/app/hero-list-enter-leave.component.ts" region="animationdef"></code-example>
|
|
|
|
In the preceding code, you applied the `void` state when the HTML element isn't attached to a view.
|
|
|
|
<a id="enter-leave-view"></a>
|
|
|
|
## Aliases :enter and :leave
|
|
|
|
`:enter` and `:leave` are aliases for the `void => *` and `* => void` transitions.
|
|
These aliases are used by several animation functions.
|
|
|
|
<code-example hideCopy language="typescript">
|
|
|
|
transition ( ':enter', [ … ] ); // alias for void => *
|
|
transition ( ':leave', [ … ] ); // alias for * => void
|
|
|
|
</code-example>
|
|
|
|
It's harder to target an element that is entering a view because it isn't in the DOM yet.
|
|
Use the aliases `:enter` and `:leave` to target HTML elements that are inserted or removed from a view.
|
|
|
|
### Use `*ngIf` and `*ngFor` with :enter and :leave
|
|
|
|
The `:enter` transition runs when any `*ngIf` or `*ngFor` views are placed on the page, and `:leave` runs when those views are removed from the page.
|
|
|
|
<div class="alert is-important">
|
|
|
|
**NOTE**: <br />
|
|
Entering/leaving behaviors can sometime be confusing.
|
|
As a rule of thumb consider that any element being added to the DOM by Angular passes via the `:enter` transition. Only elements being directly removed from the DOM by Angular pass via the `:leave` transition. For example, an element's view is removed from the DOM because its parent is being removed from the DOM.
|
|
|
|
</div>
|
|
|
|
This example has a special trigger for the enter and leave animation called `myInsertRemoveTrigger`.
|
|
The HTML template contains the following code.
|
|
|
|
<code-example header="src/app/insert-remove.component.html" path="animations/src/app/insert-remove.component.html" region="insert-remove"></code-example>
|
|
|
|
In the component file, the `:enter` transition sets an initial opacity of 0. It then animates it to change that opacity to 1 as the element is inserted into the view.
|
|
|
|
<code-example header="src/app/insert-remove.component.ts" path="animations/src/app/insert-remove.component.ts" region="enter-leave-trigger"></code-example>
|
|
|
|
Note that this example doesn't need to use [`state()`](api/animations/state).
|
|
|
|
## Transition :increment and :decrement
|
|
|
|
The `transition()` function takes other selector values, `:increment` and `:decrement`.
|
|
Use these to kick off a transition when a numeric value has increased or decreased in value.
|
|
|
|
<div class="alert is-helpful">
|
|
|
|
**NOTE**: <br />
|
|
The following example uses `query()` and `stagger()` methods.
|
|
For more information on these methods, see the [complex sequences](guide/complex-animation-sequences#complex-sequence) page.
|
|
|
|
</div>
|
|
|
|
<code-example header="src/app/hero-list-page.component.ts" path="animations/src/app/hero-list-page.component.ts" region="increment"></code-example>
|
|
|
|
## Boolean values in transitions
|
|
|
|
If a trigger contains a Boolean value as a binding value, then this value can be matched using a `transition()` expression that compares `true` and `false`, or `1` and `0`.
|
|
|
|
<code-example header="src/app/open-close.component.html" path="animations/src/app/open-close.component.2.html" region="trigger-boolean"></code-example>
|
|
|
|
In the code snippet above, the HTML template binds a `<div>` element to a trigger named `openClose` with a status expression of `isOpen`, and with possible values of `true` and `false`.
|
|
This pattern is an alternative to the practice of creating two named states like `open` and `close`.
|
|
|
|
Inside the `@Component` metadata under the `animations:` property, when the state evaluates to `true`, the associated HTML element's height is a wildcard style or default.
|
|
In this case, the animation uses whatever height the element already had before the animation started.
|
|
When the element is `closed`, the element gets animated to a height of 0, which makes it invisible.
|
|
|
|
<code-example header="src/app/open-close.component.ts" path="animations/src/app/open-close.component.2.ts" region="trigger-boolean"></code-example>
|
|
|
|
## Multiple animation triggers
|
|
|
|
You can define more than one animation trigger for a component.
|
|
Attach animation triggers to different elements, and the parent-child relationships among the elements affect how and when the animations run.
|
|
|
|
### Parent-child animations
|
|
|
|
Each time an animation is triggered in Angular, the parent animation always gets priority and child animations are blocked.
|
|
For a child animation to run, the parent animation must query each of the elements containing child animations. It then lets the animations run using the [`animateChild()`](api/animations/animateChild) function.
|
|
|
|
#### Disable an animation on an HTML element
|
|
|
|
A special animation control binding called `@.disabled` can be placed on an HTML element to turn off animations on that element, as well as any nested elements.
|
|
When true, the `@.disabled` binding prevents all animations from rendering.
|
|
|
|
The following code sample shows how to use this feature.
|
|
|
|
<code-tabs>
|
|
<code-pane header="src/app/open-close.component.html" path="animations/src/app/open-close.component.4.html" region="toggle-animation"></code-pane>
|
|
<code-pane header="src/app/open-close.component.ts" path="animations/src/app/open-close.component.4.ts" region="toggle-animation" language="typescript"></code-pane>
|
|
</code-tabs>
|
|
|
|
When the `@.disabled` binding is true, the `@childAnimation` trigger doesn't kick off.
|
|
|
|
When an element within an HTML template has animations turned off using the `@.disabled` host binding, animations are turned off on all inner elements as well.
|
|
You can't selectively turn off multiple animations on a single element.<!-- vale off -->
|
|
|
|
A selective child animations can still be run on a disabled parent in one of the following ways:
|
|
|
|
* A parent animation can use the [`query()`](api/animations/query) function to collect inner elements located in disabled areas of the HTML template.
|
|
Those elements can still animate.
|
|
<!-- vale on -->
|
|
|
|
* A child animation can be queried by a parent and then later animated with the `animateChild()` function
|
|
|
|
#### Disable all animations
|
|
|
|
To turn off all animations for an Angular application, place the `@.disabled` host binding on the topmost Angular component.
|
|
|
|
<code-example header="src/app/app.component.ts" path="animations/src/app/app.component.ts" region="toggle-app-animations"></code-example>
|
|
|
|
<div class="alert is-helpful">
|
|
|
|
**NOTE**: <br />
|
|
Disabling animations application-wide is useful during end-to-end \(E2E\) testing.
|
|
|
|
</div>
|
|
|
|
## Animation callbacks
|
|
|
|
The animation `trigger()` function emits *callbacks* when it starts and when it finishes.
|
|
The following example features a component that contains an `openClose` trigger.
|
|
|
|
<code-example header="src/app/open-close.component.ts" path="animations/src/app/open-close.component.ts" region="events1"></code-example>
|
|
|
|
In the HTML template, the animation event is passed back via `$event`, as `@triggerName.start` and `@triggerName.done`, where `triggerName` is the name of the trigger being used.
|
|
In this example, the trigger `openClose` appears as follows.
|
|
|
|
<code-example header="src/app/open-close.component.html" path="animations/src/app/open-close.component.3.html" region="callbacks"></code-example>
|
|
|
|
A potential use for animation callbacks could be to cover for a slow API call, such as a database lookup.
|
|
For example, an **InProgress** button can be set up to have its own looping animation while the backend system operation finishes.
|
|
|
|
Another animation can be called when the current animation finishes.
|
|
For example, the button goes from the `inProgress` state to the `closed` state when the API call is completed.
|
|
|
|
An animation can influence an end user to *perceive* the operation as faster, even when it is not.
|
|
|
|
Callbacks can serve as a debugging tool, for example in conjunction with `console.warn()` to view the application's progress in a browser's Developer JavaScript Console.
|
|
The following code snippet creates console log output for the original example, a button with the two states of `open` and `closed`.
|
|
|
|
<code-example header="src/app/open-close.component.ts" path="animations/src/app/open-close.component.ts" region="events"></code-example>
|
|
|
|
<a id="keyframes"></a>
|
|
|
|
## Keyframes
|
|
|
|
To create an animation with multiple steps run in sequence, use *keyframes*.
|
|
|
|
Angular's `keyframe()` function allows several style changes within a single timing segment.
|
|
For example, the button, instead of fading, could change color several times over a single 2-second time span.
|
|
|
|
<div class="lightbox">
|
|
|
|
<img alt="keyframes" src="generated/images/guide/animations/keyframes-500.png">
|
|
|
|
</div>
|
|
|
|
The code for this color change might look like this.
|
|
|
|
<code-example header="src/app/status-slider.component.ts" path="animations/src/app/status-slider.component.ts" region="keyframes"></code-example>
|
|
|
|
### Offset
|
|
|
|
Keyframes include an `offset` that defines the point in the animation where each style change occurs.
|
|
Offsets are relative measures from zero to one, marking the beginning and end of the animation. They should be applied to each of the keyframe steps if used at least once.
|
|
|
|
Defining offsets for keyframes is optional.
|
|
If you omit them, evenly spaced offsets are automatically assigned.
|
|
For example, three keyframes without predefined offsets receive offsets of 0, 0.5, and 1.
|
|
Specifying an offset of 0.8 for the middle transition in the preceding example might look like this.
|
|
|
|
<div class="lightbox">
|
|
|
|
<img alt="keyframes with offset" src="generated/images/guide/animations/keyframes-offset-500.png">
|
|
|
|
</div>
|
|
|
|
The code with offsets specified would be as follows.
|
|
|
|
<code-example header="src/app/status-slider.component.ts" path="animations/src/app/status-slider.component.ts" region="keyframesWithOffsets"></code-example>
|
|
|
|
You can combine keyframes with `duration`, `delay`, and `easing` within a single animation.
|
|
|
|
### Keyframes with a pulsation
|
|
|
|
Use keyframes to create a pulse effect in your animations by defining styles at specific offset throughout the animation.
|
|
|
|
Here's an example of using keyframes to create a pulse effect:
|
|
|
|
* The original `open` and `closed` states, with the original changes in height, color, and opacity, occurring over a timeframe of 1 second
|
|
* A keyframes sequence inserted in the middle that causes the button to appear to pulsate irregularly over the course of that same 1 second timeframe
|
|
|
|
<div class="lightbox">
|
|
|
|
<img alt="keyframes with irregular pulsation" src="generated/images/guide/animations/keyframes-pulsation.png">
|
|
|
|
</div>
|
|
|
|
The code snippet for this animation might look like this.
|
|
|
|
<code-example header="src/app/open-close.component.ts" path="animations/src/app/open-close.component.1.ts" region="trigger"></code-example>
|
|
|
|
### Animatable properties and units
|
|
|
|
Angular animations support builds on top of web animations, so you can animate any property that the browser considers animatable.
|
|
This includes positions, sizes, transforms, colors, borders, and more.
|
|
The W3C maintains a list of animatable properties on its [CSS Transitions](https://www.w3.org/TR/css-transitions-1) page.
|
|
|
|
For properties with a numeric value, define a unit by providing the value as a string, in quotes, with the appropriate suffix:
|
|
|
|
* 50 pixels:
|
|
`'50px'`
|
|
|
|
* Relative font size:
|
|
`'3em'`
|
|
|
|
* Percentage:
|
|
`'100%'`
|
|
|
|
You can also provide the value as a number. In such cases Angular assumes a default unit of pixels, or `px`.
|
|
Expressing 50 pixels as `50` is the same as saying `'50px'`.
|
|
|
|
<div class="alert is-helpful">
|
|
|
|
**NOTE**: <br />
|
|
The string `"50"` would instead not be considered valid\).
|
|
|
|
</div>
|
|
|
|
### Automatic property calculation with wildcards
|
|
|
|
Sometimes, the value of a dimensional style property isn't known until runtime.
|
|
For example, elements often have widths and heights that depend on their content or the screen size.
|
|
These properties are often challenging to animate using CSS.
|
|
|
|
In these cases, you can use a special wildcard `*` property value under `style()`. The value of that particular style property is computed at runtime and then plugged into the animation.
|
|
|
|
The following example has a trigger called `shrinkOut`, used when an HTML element leaves the page.
|
|
The animation takes whatever height the element has before it leaves, and animates from that height to zero.
|
|
|
|
<code-example header="src/app/hero-list-auto.component.ts" path="animations/src/app/hero-list-auto.component.ts" region="auto-calc"></code-example>
|
|
|
|
### Keyframes summary
|
|
|
|
The `keyframes()` function in Angular allows you to specify multiple interim styles within a single transition. An optional `offset` can be used to define the point in the animation where each style change should occur.
|
|
|
|
## More on Angular animations
|
|
|
|
You might also be interested in the following:
|
|
|
|
* [Introduction to Angular animations](guide/animations)
|
|
* [Complex animation sequences](guide/complex-animation-sequences)
|
|
* [Reusable animations](guide/reusable-animations)
|
|
* [Route transition animations](guide/route-animations)
|
|
|
|
@reviewed 2022-10-11
|