Primary entry point exports
Functions - trigger
The "trigger" function in the Angular Animation API is used to create a named animation trigger. This trigger contains a list of state() and transition() entries that are evaluated when the expression bound to the trigger changes. The function returns an object encapsulating the trigger data.
Here's a detailed breakdown of the trigger function and its usage:
trigger(name: string, definitions: AnimationMetadata[]): AnimationTriggerMetadata
Parameters:
name (string):
- An identifying string for the animation trigger.
definitions (AnimationMetadata[]):
- An animation definition object containing an array of state() and transition() declarations.
Returns:
AnimationTriggerMetadata:
- An object that encapsulates the trigger data.
Usage Notes:
Define in Component Metadata:
- Define an animation trigger in the animations section of "@Component" metadata.
Bind in Template:
- In the template, reference the trigger by name and bind it to a trigger expression using the format [@triggerName]="expression".
- Animation trigger bindings convert all values to strings, and then match the previous and current values against any linked transitions.
- Booleans can be specified as 1 or true and 0 or false.
Usage Example:
In this example, an animation trigger named "myAnimationTrigger" is defined within the "@Component" metadata. It contains states and transitions. The template associated with this component uses the defined trigger by binding it to an element within the template code.
Using an Inline Function:
The transition animation method supports reading an inline function to decide if its associated animation should run.
Disabling Animations:
@.disabled Binding:
- When "@.disabled" is true, it prevents all animations from rendering on the element and any inner animation triggers within the element.
Disable Animations Application-wide:
- Disable all animations for an app by placing a host binding set on "@.disabled" on the topmost Angular component.
Overriding Disablement of Inner Animations:
- Despite inner animations being disabled, a parent animation can query() for inner elements located in disabled areas of the template and still animate them if needed.
Detecting when an Animation is Disabled:
- If animations are disabled, the ".disabled" flag on the "AnimationEvent" is true.
This comprehensive explanation covers the creation and usage of animation triggers, including binding, inline functions, disabling animations, and application-wide control.
Source: https://angular.io/api/animations/trigger#trigger
Comments
Post a Comment