Class ProgressButtonSpinSettings

Configures the appearance and behavior of the spinner within the SfProgressButton component.

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
ProgressButtonSpinSettings
Implements
Inherited Members
Namespace: Syncfusion.Blazor.SplitButtons
Assembly: Syncfusion.Blazor.dll
Syntax
public class ProgressButtonSpinSettings : SfOwningComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable
Remarks

The ProgressButtonSpinSettings allows you to customize the position, width, and template of the spinner displayed during progress.

Examples
<SfProgressButton Content="Submit">
    <ProgressButtonSpinSettings Position="SpinPosition.Right" Width="20">
        <SpinTemplate>
            <div class="custom-spinner"></div>
        </SpinTemplate>
    </ProgressButtonSpinSettings>
</SfProgressButton>

Constructors

ProgressButtonSpinSettings()

Declaration
public ProgressButtonSpinSettings()

Properties

Position

Gets or sets a value that indicates the position of the spinner within the SfProgressButton.

Declaration
[Parameter]
public SpinPosition Position { get; set; }
Property Value
Type Description
SpinPosition

One of the SpinPosition enumeration values. The default value is Left.
Remarks

This property controls the placement of the spinner relative to the button's content. The available positions are:

  • Left: The spinner is placed to the left of the content.
  • Right: The spinner is placed to the right of the content.
  • Top: The spinner is placed above the content.
  • Bottom: The spinner is placed below the content.
  • Center: The spinner is placed in the center of the button, overlaying the content.

SpinTemplate

Gets or sets the custom template for the spinner in the SfProgressButton.

Declaration
[Parameter]
public RenderFragment SpinTemplate { get; set; }
Property Value
Type Description
RenderFragment

A RenderFragment that defines the custom spinner content. The default value is null.
Remarks

This template allows you to replace the default spinner with custom HTML content or components. When a SpinTemplate is provided, it will be rendered as the spinner during the progress state.

Width

Gets or sets the width of the spinner in the SfProgressButton.

Declaration
[Parameter]
public string Width { get; set; }
Property Value
Type Description
string

A string representing the width of the spinner. The default value is "16". The value can be specified in pixels or as a percentage.
Remarks

This property allows you to control the size of the spinner. For example, you can set it to "20px" or "100%". If only a numeric value is provided, it is treated as pixels.

Methods

Dispose(bool)

Releases the unmanaged resources used by the ProgressButtonSpinSettings and optionally releases the managed resources.

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

true to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides
Remarks

This method cleans up resources by detaching from the parent SfProgressButton.

OnInitializedAsync()

Method invoked when the component is ready to start.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
Task

A Task representing the asynchronous operation.
Overrides
Remarks

This method notifies the parent SfProgressButton about these spin settings.

Implements