Blazorise Animate API
Explore the Blazorise Animate API reference for parameters, events, methods, and related types.
For examples and usage guidance, see the Animate documentation.
API
Parameters
| Parameter | Default | Type |
|---|---|---|
Anchor | — | string |
Element whose offset will be used to trigger animation instead of an actual one. | ||
AnchorPlacement | — | string |
Specifies which position of the element regarding to window should trigger the animation. | ||
AnimatedSize | None | AnimatedSize |
Specifies which size dimension should be animated together with the configured animation. Possible values: NoneWidthHeight | ||
AnimateOnInitialRender | true | bool |
Specifies whether the animation should run on the first render. | ||
Animation | Fade | IAnimation |
Specifies the animation effect. The list of all supported animations can be found in Animations class. When omitted, uses AnimateOptions.Animation, falling back to Fade. | ||
Auto | true | bool |
True if the animation will be executed automatically. Otherwise if false it needs to be run manually with Run method. | ||
ChildContent | null | RenderFragment |
Specifies the content to be rendered inside this Animate. | ||
Delay | 0 ms | TimeSpan? |
Gets os sets the delay of the animation before it runs automatically, or manually. Values from 0 to 3000, with step 50ms. When omitted, uses DelayMilliseconds, then a positive AnimateOptions.Delay, then 0 ms. | ||
DelayMilliseconds | 0 | int? |
Gets os sets the delay in milliseconds of the animation before it runs automatically, or manually. Values from 0 to 3000, with step 50ms. When omitted, uses a positive AnimateOptions.Delay, then 0 ms. Delay takes precedence when supplied. | ||
Duration | 400 ms | TimeSpan? |
Gets os sets the total duration of the animation. Values from 0 to 3000, with step 50ms. When omitted, uses DurationMilliseconds, then a positive AnimateOptions.Duration, then 400 ms. | ||
DurationMilliseconds | 400 | int? |
Gets os sets the total duration of the animation, in milliseconds. Values from 0 to 3000, with step 50ms. When omitted, uses a positive AnimateOptions.Duration, then 400 ms. Duration takes precedence when supplied. | ||
Easing | Ease | IEasing |
Specifies the easing effect. The list of all supported easings can be found in Easings class. When omitted, uses AnimateOptions.Easing, falling back to Easings.Ease. | ||
Mirror | false | bool |
Whether elements should animate out while scrolling past them. When omitted, uses AnimateOptions.Mirror, falling back to false. | ||
Offset | 0 | int |
Shifts the trigger point of the animation. | ||
Once | false | bool |
Whether animation should happen only once - while scrolling down. When omitted, uses AnimateOptions.Once, falling back to false. | ||
Options | null | AnimateOptions |
Specifies the animate options. | ||
OptionsName | Microsoft.Extensions.Options.Options.DefaultName | string |
Specifies the custom name of the options to get from the configuration. | ||
Trigger | InView | AnimationTrigger |
Specifies when the animation should run. Possible values: InViewRender | ||
Visible | true | bool |
Specifies whether the content is visible. | ||
Methods
| Method | Return | Parameters |
|---|---|---|
Run | void | — |
Runs the animation manually.
| ||