Text component

Text

Use TextEdit to have a basic input.

<TextEdit />

Placeholder

<TextEdit Placeholder="Some text value..." />

Static text

Static text removes the background, border, shadow, and horizontal padding, while maintaining the vertical spacing so you can easily align the input in any context, like a horizontal form.

<TextEdit Plaintext="true" />

Disabled

A disabled input element is unusable and un-clickable.

<TextEdit Disabled="true" />

Readonly

If you use the read-only attribute, the input text will look similar to a normal one, but is not editable.

<TextEdit ReadOnly="true" />

Sizing

Sets the heights of input elements.

<TextEdit Size="Size.Small" />
<TextEdit Size="Size.Large" />

Pattern

Use pattern attribute to specify regular expression that will be used while validating the input text value.

<Validation UsePattern="true">
    <TextEdit Pattern="[A-Za-z]{3}">
        <Feedback>
            <ValidationError>Pattern does not match!</ValidationError>
        </Feedback>
    </TextEdit>
</Validation>

EditMask

Edit masks are used to prevent user from entering an invalid values and when entered string must match a specific format. For example you can limit input to only accept numeric string, date string or if you want full control you can use RegEx format.

<TextEdit MaskType="MaskType.RegEx" EditMask="^[a-zA-Z ]*$" />

Roles

Use Role to define text value.

<TextEdit Role="TextRole.Email" />
<TextEdit Role="TextRole.Password" />

Usage

TextEdit by itself is not really usable if you can’t use it. To get or set the input value you have two options. You can use bind-* attribute or you can use a TextChanged event.

With bind attribute

By using bind-* attribute the text will be automatically assigned to the member variable.

<TextEdit @bind-Text="@name" />

@code{
    string name;
}

With event

When using the event TextChanged, you also must define the Text value attribute.

<TextEdit Text="@name" TextChanged="@OnNameChanged" />

@code{
    string name;

    void OnNameChanged( string value )
    {
        name = value;
    }
}

Settings

Text Changed mode

By default the TextChanged event will be raised on every keypress. To override default behavior of TextChanged event and to disable the change on every keypress you must set the ChangeTextOnKeyPress to false on application start. After setting it to false the event will be raised only after the input loses focus.

public void ConfigureServices( IServiceCollection services )
{
  services
    .AddBlazorise( options =>
    {
      options.ChangeTextOnKeyPress = false;
    } );
}

Text Delay mode

Because of some limitations in Blazor, sometimes there can be problems when ChangeTextOnKeyPress is enabled. Basically if you try to type too fast into the text field the caret can jump randomly from current selection to the end of the text. To prevent that behaviour you need to enable DelayTextOnKeyPress. Once enabled it will slightly delay every value entered into the field to allow the Blazor engine to do it’s thing. By default this option is disabled.

public void ConfigureServices( IServiceCollection services )
{
  services
    .AddBlazorise( options =>
    {
      options.DelayTextOnKeyPress = true;
      options.DelayTextOnKeyPressInterval = 300;
    } );
}

Note: All of the options above can also be defined on each TextEdit individually. Defining them on TextEdit will override any global settings.

Attributes

Name	Type	Default	Description
Role	TextRole	Text	The role of the input text.
Text	string		Input value.
TextChanged	event		Occurs after text has changed.
Plaintext	boolean	false	Remove the default form field styling and preserve the correct margin and padding.
ReadOnly	boolean	false	Prevents modification of the input’s value.
Disabled	boolean	false	Prevents user interactions and make it appear lighter.
MaxLength	int?	null	Specifies the maximum number of characters allowed in the input element.
Placeholder	string		Sets the placeholder for the empty text.
Pattern	string		Specifies a regular expression that the input element’s value is checked against on form validation.
Color	Colors	None	Component visual or contextual style variants.
Size	Sizes	None	Component size variations.
EditMask	string		A string representing a edit mask expression.
MaskType	MaskType	None	Specify the mask type used by the editor.
VisibleCharacters	int?	null	Specifies the visible width, in characters, of an <input> element.
ChangeTextOnKeyPress	bool?	null	If true the text in will be changed after each key press (overrides global settings).
DelayTextOnKeyPress	bool?	null	If true the entered text will be slightly delayed before submitting it to the internal value.
DelayTextOnKeyPressInterval	int?	null	Interval in milliseconds that entered text will be delayed from submitting to the internal value.
KeyDown	EventCallback<KeyboardEventArgs>		Occurs when a key is pressed down while the control has focus.
KeyPress	EventCallback<KeyboardEventArgs>		Occurs when a key is pressed while the control has focus.
KeyUp	EventCallback<KeyboardEventArgs>		Occurs when a key is released while the control has focus.
OnFocus	EventCallback<FocusEventArgs>		Occurs when the input box gains focus.
FocusIn	EventCallback<FocusEventArgs>		Occurs when the input box gains focus.
FocusOut	EventCallback<FocusEventArgs>		Occurs when the input box loses focus.
Autofocus	bool	false	Set’s the focus to the component after the rendering is done.