Class ProgressButtonAnimationSettings

Represents the animation settings for the SfProgressButton component.

Inheritance

System.Object

ProgressButtonAnimationSettings

Namespace: Syncfusion.Blazor.SplitButtons

Assembly: Syncfusion.Blazor.dll

Syntax

public class ProgressButtonAnimationSettings : OwningComponentBase

Remarks

This class allows for the customization of animation effects, including duration and easing, for the progress indicator within the SfProgressButton.

Constructors

ProgressButtonAnimationSettings()

Declaration

public ProgressButtonAnimationSettings()

Properties

Duration

Gets or sets the duration of the animation in milliseconds.

Declaration

public double Duration { get; set; }

Property Value

Type	Description
System.Double	A double value that specifies the animation duration. The default value is 400.

Remarks

This property controls the time it takes for the animation effect to complete. A higher value will result in a slower animation.

Easing

Gets or sets the easing function for the animation, which defines the rate of change over time.

Declaration

public string Easing { get; set; }

Property Value

Type	Description
System.String	A string representing the timing function for the animation. The default value is "ease".

Remarks

This property accepts standard CSS easing functions, such as "linear", "ease-in", "ease-out", and "ease-in-out", to control the animation's acceleration and deceleration.

Effect

Gets or sets the animation effect for the progress indicator.

Declaration

public AnimationEffect Effect { get; set; }

Property Value

Type	Description
AnimationEffect	An AnimationEffect enum member that specifies the visual effect. The default value is None.

Remarks

This property defines the type of animation applied when the progress is displayed. For example, SlideLeft moves the content with a slide-left animation, while ZoomIn applies a zoom-in effect. Other options include SlideRight, SlideUp, SlideDown, and ZoomOut.

Methods

Dispose(Boolean)

Releases the resources used by the component.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	A bool value indicating whether the component is in the process of being disposed.

OnInitializedAsync()

Asynchronously initializes the component and updates the parent progress button with these settings.

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the asynchronous operation.