Table of Contents

Class MudInput<T>

Namespace
MudBlazor
Assembly
MudBlazor.dll

A component for collecting an input value.

public class MudInput<T> : MudBaseInput<T>, IComponent, IHandleEvent, IHandleAfterRender, IMudStateHasChanged, IFormComponent, IAsyncDisposable

Type Parameters

T

The type of object managed by this input.

Inheritance
MudInput<T>
Implements
Derived
Inherited Members
Extension Methods

Constructors

MudInput() 

public MudInput()

Properties

AdornmentClassname 

protected string AdornmentClassname { get; }

Property Value

string

AutoGrow

Stretches this input vertically to accommodate the Text value.

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

Property Value

bool

Remarks

Defaults to false.

ChildContent

The content within this input component.

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

Property Value

RenderFragment

Remarks

Will only display if InputType is Hidden.

Classname 

protected string Classname { get; }

Property Value

string

ClearButtonClassname 

protected string ClearButtonClassname { get; }

Property Value

string

ClearIcon

The icon to display when Clearable is true.

[Parameter]
public string ClearIcon { get; set; }

Property Value

string

Remarks

Defaults to Clear.

Clearable

Shows a button to clear this input's value.

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

Property Value

bool

Remarks

Defaults to false.

ElementReference

The reference to the HTML element for this component.

public ElementReference ElementReference { get; }

Property Value

ElementReference

HideSpinButtons

For MudNumericField<T>, hides the spin buttons.

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

Property Value

bool

Remarks

Defaults to true.

InputClassname 

protected string InputClassname { get; }

Property Value

string

InputType

The type of input collected by this component.

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

Property Value

InputType

Remarks

Defaults to Text. Represents a valid HTML5 input type.

InputTypeString 

protected string InputTypeString { get; }

Property Value

string

MaxLines

The maximum vertical lines to display when AutoGrow is true.

[Parameter]
public int MaxLines { get; set; }

Property Value

int

Remarks

Defaults to 0. When 0. this property is ignored.

NumericDownIcon

The icon to display for the Down arrow button.

[Parameter]
public string NumericDownIcon { get; set; }

Property Value

string

Remarks

Defaults to KeyboardArrowDown.

NumericUpIcon

The icon to display for the Up arrow button.

[Parameter]
public string NumericUpIcon { get; set; }

Property Value

string

Remarks

Defaults to KeyboardArrowUp.

OnClearButtonClick

Occurs when the clear button is clicked.

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

Property Value

EventCallback<MouseEventArgs>

Remarks

When clicked, the Text and Value properties are reset.

OnDecrement

Occurs when the Down arrow button is clicked.

[Parameter]
public EventCallback OnDecrement { get; set; }

Property Value

EventCallback

Remarks

Only occurs when InputType is Number. For numeric inputs, use the MudNumericField<T> component.

OnIncrement

Occurs when the Up arrow button is clicked.

[Parameter]
public EventCallback OnIncrement { get; set; }

Property Value

EventCallback

Remarks

Only occurs when InputType is Number. For numeric inputs, use the MudNumericField<T> component.

OnMouseWheel

Occurs when a mouse wheel event is raised.

[Parameter]
public EventCallback<WheelEventArgs> OnMouseWheel { get; set; }

Property Value

EventCallback<WheelEventArgs>

Methods

BlurAsync()

When overridden, releases focus from this input.

public override ValueTask BlurAsync()

Returns

ValueTask

A ValueTask object.

BuildRenderTree(RenderTreeBuilder) 

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

DisposeAsyncCore()

Called to dispose this instance.

protected override ValueTask DisposeAsyncCore()

Returns

ValueTask

FocusAsync()

When overridden, obtains focus for this input.

public override ValueTask FocusAsync()

Returns

ValueTask

A ValueTask object.

HandleClearButtonAsync(MouseEventArgs) 

protected virtual Task HandleClearButtonAsync(MouseEventArgs e)

Parameters

e MouseEventArgs

Returns

Task

OnAfterRenderAsync(bool) 

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

firstRender bool

Returns

Task

OnChange(ChangeEventArgs?) 

protected Task OnChange(ChangeEventArgs? args)

Parameters

args ChangeEventArgs

Returns

Task

OnInput(ChangeEventArgs?) 

protected Task OnInput(ChangeEventArgs? args)

Parameters

args ChangeEventArgs

Returns

Task

OnPaste(ClipboardEventArgs)

Paste hook for descendants.

protected virtual Task OnPaste(ClipboardEventArgs args)

Parameters

args ClipboardEventArgs

Returns

Task

SelectAsync()

When overridden, selects this input.

public override ValueTask SelectAsync()

Returns

ValueTask

A ValueTask object.

SelectRangeAsync(int, int)

When overridden, selects a portion of the input.

public override ValueTask SelectRangeAsync(int pos1, int pos2)

Parameters

pos1 int

The index of the first character to select.

pos2 int

The index of the last character to select.

Returns

ValueTask

A ValueTask object.

SetParametersAsync(ParameterView) 

public override Task SetParametersAsync(ParameterView parameters)

Parameters

parameters ParameterView

Returns

Task

SetText(string?)

Set the Text to the specified value.

public Task SetText(string? text)

Parameters

text string

The new value.

Returns

Task