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 | Description | Type | Default |
|---|---|---|---|
Anchor |
Element whose offset will be used to trigger animation instead of an actual one. |
string | |
AnchorPlacement |
Specifies which position of the element regarding to window should trigger the animation. |
string | |
AnimatedSize |
Specifies which size dimension should be animated together with the configured animation. Possible values: |
AnimatedSize | AnimatedSize.None |
AnimateOnInitialRender |
Specifies whether the animation should run on the first render. |
bool | true |
Animation |
Specifies the animation effect. RemarksThe list of all supported animations can be found in Animations class. |
IAnimation | null |
Auto |
True if the animation will be executed automatically. Otherwise if false it needs to be run manually with Run method. |
bool | true |
ChildContent |
Specifies the content to be rendered inside this Animate. |
RenderFragment | null |
Delay |
Gets os sets the delay of the animation before it runs automatically, or manually. RemarksValues from 0 to 3000, with step 50ms. |
TimeSpan? | null |
DelayMilliseconds |
Gets os sets the delay in milliseconds of the animation before it runs automatically, or manually. RemarksValues from 0 to 3000, with step 50ms. |
int? | null |
Duration |
Gets os sets the total duration of the animation. RemarksValues from 0 to 3000, with step 50ms. |
TimeSpan? | null |
DurationMilliseconds |
Gets os sets the total duration of the animation, in milliseconds. RemarksValues from 0 to 3000, with step 50ms. |
int? | null |
Easing |
Specifies the easing effect. RemarksThe list of all supported easings can be found in Easings class. |
IEasing | null |
Mirror |
Whether elements should animate out while scrolling past them. |
bool | false |
Offset |
Shifts the trigger point of the animation. |
int | 0 |
Once |
Whether animation should happen only once - while scrolling down. |
bool | false |
Options |
Specifies the animate options. |
AnimateOptions | null |
OptionsName |
Specifies the custom name of the options to get from the configuration. |
string | Microsoft.Extensions.Options.Options.DefaultName |
Trigger |
Specifies when the animation should run. Possible values: |
AnimationTrigger | AnimationTrigger.InView |
Visible |
Specifies whether the content is visible. |
bool | true |
Methods
| Method | Description | Return | Parameters |
|---|---|---|---|
Run |
Runs the animation manually. | void |