New to Telerik UI for Blazor? Start a free 30-day trial

TelerikButton

Class

Represents a Telerik UI for Blazor Button component that handles user clicks, form submissions, and navigation actions. Supports icons, multiple styling options, accessibility features, and various button types including submit, reset, and standard buttons. Can be styled with different fill modes, sizes, colors, and corner rounding to match your application's design requirements.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

public class TelerikButton : ButtonBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseBaseComponentButtonBaseTelerikButton

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Constructors

TelerikButton()

public TelerikButton()

Methods

BuildRenderTree(RenderTreeBuilder)

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters:__builderRenderTreeBuilder

Overrides: ComponentBase.BuildRenderTree(RenderTreeBuilder)

Dispose()

public override void Dispose()

Overrides: BaseComponent.Dispose()

FocusAsync()

Task

Programmatically moves focus to the button. The button must be Visible and Enabled to receive focus successfully.

public Task FocusAsync()

Returns:

Task

OnAfterRenderAsync(bool)

Task

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters:firstRenderboolReturns:

Task

Overrides: BaseComponent.OnAfterRenderAsync(bool)

Properties

ButtonSettings

RenderFragment

Provides configuration for WebMCP tools, such as a Name to distinguish this Button from others on the same page.

[Parameter]
public RenderFragment? ButtonSettings { get; set; }

ButtonType

[Accessibility] Sets the HTML button type attribute which determines the button's behavior when clicked. Default value is Submit.

[Parameter]
public ButtonType ButtonType { get; set; }

Remarks:

Submit submits the parent form when clicked. Button performs no default action and is used with custom OnClick handlers. Reset resets all form controls to their initial values.

EnableWebMcpTools

bool

Enables the registration of WebMCP tools for this Button instance. When set to true, the Button click operation is exposed as a tool discoverable by AI models through the browser. Default value is false.

[Parameter]
public bool EnableWebMcpTools { get; set; }

Form

string

Associates the button with a specific form element by referencing the form's ID attribute. Example: "myFormId".

[Parameter]
public string? Form { get; set; }

OnClick

EventCallback<MouseEventArgs>

Fires when the user clicks the button. The event provides MouseEventArgs containing details about the click event.

[Parameter]
public EventCallback<MouseEventArgs> OnClick { get; set; }

Visible

bool

Controls whether the button appears on the page. When set to false, the button is hidden from view. Default value is true.

[Parameter]
public bool Visible { get; set; }