Class ToastHideAnimationSettings

Specifies the animation configuration to be applied while hiding the Toast component.

Inheritance
System.Object
ToastHideAnimationSettings
Namespace: Syncfusion.Blazor.Notifications
Assembly: Syncfusion.Blazor.dll
Syntax
public class ToastHideAnimationSettings : OwningComponentBase
Remarks

The ToastHideAnimationSettings class provides comprehensive control over the animation behavior when a toast notification is dismissed or hidden. It allows customization of animation duration, easing effects, and animation types to create smooth and visually appealing hide transitions. This class works in conjunction with ToastAnimationSettings to provide complete animation control for toast notifications.

Examples

Configure hide animation settings for a toast component.

<SfToast>
    <ToastAnimationSettings>
        <ToastHideAnimationSettings Duration="500" Effect="ToastEffect.Fade" Easing="ToastEasing.EaseOut" />
    </ToastAnimationSettings>
</SfToast>

Constructors

ToastHideAnimationSettings()

Declaration
public ToastHideAnimationSettings()

Properties

Duration

Gets or sets the duration of the hide animation in milliseconds.

Declaration
public int Duration { get; set; }
Property Value
Type Description
System.Int32

An int value representing the animation duration in milliseconds. The default value is determined by the toast component's default animation settings.
Remarks

This property controls how long the hide animation takes to complete. A shorter duration creates a faster animation, while a longer duration creates a slower, more gradual animation. The duration works in combination with the Easing property to control the overall animation behavior during toast dismissal.

Easing

Gets or sets the easing function that controls the acceleration and deceleration of the hide animation.

Declaration
public ToastEasing Easing { get; set; }
Property Value
Type Description
ToastEasing

A ToastEasing enumeration value that specifies the timing function for the animation. The default value depends on the toast component's default settings.
Remarks

The easing property determines how the animation progresses over time, affecting the visual smoothness and feel of the hide transition. Different easing functions create different animation characteristics - for example, ease-in starts slowly and accelerates, while ease-out starts quickly and decelerates. This property works together with Duration to create the desired animation experience.

Effect

Gets or sets the animation effect to be applied when hiding the toast notification.

Declaration
public ToastEffect Effect { get; set; }
Property Value
Type Description
ToastEffect

A ToastEffect enumeration value that specifies the type of animation effect. The default value depends on the toast component's default settings.
Remarks

This property determines the visual style of the hide animation. When a toast is dismissed, the specified effect controls how the toast disappears from view. The available animation effects include:

  • Fade - Creates a fade-out effect where the toast gradually becomes transparent
  • FadeZoom - Combines fade and zoom effects for a more dynamic transition
  • FlipLeftDown - Rotates the toast down and to the left
  • FlipLeftUp - Rotates the toast up and to the left
  • FlipRightDown - Rotates the toast down and to the right
  • FlipRightUp - Rotates the toast up and to the right
  • FlipXDown - Flips the toast horizontally downward
  • FlipXUp - Flips the toast horizontally upward
  • FlipYLeft - Flips the toast vertically to the left
  • FlipYRight - Flips the toast vertically to the right
  • SlideBottom - Slides the toast toward the bottom of the screen
  • SlideLeft - Slides the toast toward the left side of the screen
  • SlideRight - Slides the toast toward the right side of the screen
  • SlideTop - Slides the toast toward the top of the screen
  • Zoom - Scales the toast down while hiding it
  • None - No animation effect is applied
The effect works in combination with Duration and Easing to create the complete animation experience.

Methods

Dispose()

Dispose the unmanaged resources.

Declaration
public virtual void Dispose()

Dispose(Boolean)

Dispose the unmanaged resources.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

Boolean value to dispose the object.

OnParametersSetAsync()

Method invoked when the component has received parameters from its parent.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type Description
System.Threading.Tasks.Task

A System.Threading.Tasks.Task representing any asynchronous operation.