Text Field

BsTextField is a component that let users enter text into an UI.

Overview

BsTextField component mimics the HTML5 <input type="text"> element. This means that you can add attributes like required, readonly, or disabled and it will react to them to give the best experience. You can also use v-model directive to create two-way data bindings on the model-value property.

Text Field

Password Field

State Readonly

State Disabled

IMPORTANT

Do not use the model-value property when using v-model.

Style Variants

You can style <bs-text-field> to your own preference or use a style variant based on Google Material Design 2 or Material Design 3 specifications.

Default

You can style <bs-text-field> that follows Google Material Design 2 specifications by using floating-label property explicitly.

Classic Field

Floating Label

Field Label

Filled

Use filled property explicitly to enable <bs-text-field> with solid fill style. And when combined with floating-label property, <bs-text-field> will have a style that follows the Google Material Design 3 specifications.

Classic Field

---

Floating Label

Field Label

Outlined

Use outlined property explicitly to enable <bs-text-field> with outline style. And when combined with floating-label property, <bs-text-field> will have a style that follows the Google Material Design 3 specifications.

Classic Field

---

Floating Label

Field Label

Rounded Filled

Combine filled property and rounded property explicitly to enable <bs-text-field> with rounded pill solid style.

Added since v2.0.5

Classic Field

---

Floating Label

Field Label

Rounded Outlined

Combine outlined property and rounded property explicitly to enable <bs-text-field> with rounded pill outline style.

Added since v2.0.5

Classic Field

---

Floating Label

Field Label

Browser Autocomplete

The autocomplete property gives you the option to enable browser to predict the user input.

Full Name

Email

Datalist Support

Datalist is a native HTML tag of <datalist> that contains a list of <option> tags. By assigning an ID to the datalist tag, the list can be references from a text field by defining the datalist property explicitly. This give the text field the behavior of a combobox or auto-complete, allowing existing values to be chosen, or new values to be entered.

Sizes

INFO

• Datalists work in conjunction with the browser's built in auto-complete, displaying datalist options first, followed by auto-complete options.
• Datalists cannot be applied to input fields with type password, or range.
• Not all browsers fully support <datalist> and implementations can be buggy. It is recommended that datalists be treated as an enhancement and not be relied upon at this time. Check Can I Use for full support details on all browsers.

Clearable

Define the clear-button property explicitly, so that the field value can be cleared easily.

Text Field

Password Field

Help Text

The help-text property on <bs-text-field> adds an help text beneath the text field. And sets the persistent-help-text property to false will make the help text visible only when the text field is focused.

Product or Service

Your landing page

www.example.com/page

Product or Service

Your landing page

www.example.com/page

Product or Service

Your landing page

www.example.com/page

Icons

The properties prepend-icon, prepend-icon-outer, append-icon and append-icon-outer provides the ability to add icon to <bs-text-field>.

Use any valid android icon name from Google Material Symbols with or without a suffix. Valid suffixes are: _outlined, _rounded, _sharp, _filled, _outlined_filled, _rounded_filled, and _sharp_filled. Suffix _filled and _outlined_filled will display the same icon style variant.

Updated on v2.1.0

Prepend

Append

Prepend Outer

Append Outer

Prepend

Append

Prepend Outer

Append Outer

Prepend

Append

Prepend Outer

Append Outer

INFO

Since Vue MDBootstrap v2.1.0, Google Material Icons are replaced with Google Material Symbols.

Prefixes and Suffixes

The prefix and suffix properties allows you to prepend and append inline non-modifiable text before or after the input field.

Added since v2.0.10

Website

Email Address

Website

Email Address

Website

Email Address

Usage Example

The following is an example that demonstrate more advanced use of the <bs-text-field> with form validation.

CSS Variables

Updated on v2.0.10

--md-field-active-border-color: rgb(var(--md-field-active-indicator));
--md-field-active-border-width: 2px;
--md-field-color-bg: currentColor;
--md-field-border-color: currentColor;
--md-field-border-width: 1px;
--md-field-control-height: 3.5rem;
--md-field-floating-label-color: var(--md-field-label-color);
--md-field-label-color: currentColor;
--md-field-padding-start: 1rem;
--md-field-padding-end: 1rem;
--md-field-padding-top: 1.625rem;
--md-field-padding-bottom: 0.375rem;
--md-field-inline-text-font-weight: 500;

// global css variables
--md-field-primary-indicator-rgb: 98, 0, 238;
--md-field-primary-indicator: rgb(var(--md-field-primary-indicator-rgb));
--md-field-accent-indicator-rgb: 185,156,225;
--md-field-accent-indicator: rgb(var(--md-field-accent-indicator-rgb));
--md-field-active-indicator: var(--md-field-primary-indicator-rgb);

API Reference

Property	Type	Default	Description
action-icon-variant	String	'outlined'	Sets the action icon style variant. Valid values are: outlined, rounded, sharp, filled, outlined_filled, rounded_filled, and sharp_filled. Updated on v2.1.0
append-icon	String		Sets icon to display at the inner right side. Updated on v2.1.0 Use any valid android icon name from Google Material Symbols with or without a suffix. Valid suffixes are: _outlined, _rounded, _sharp, _filled, _outlined_filled, _rounded_filled, and _sharp_filled.
append-icon-outer	String		Sets icon to display at the outer right side. Updated on v2.1.0 Use any valid android icon name from Google Material Symbols with or without a suffix. Valid suffixes are: _outlined, _rounded, _sharp, _filled, _outlined_filled, _rounded_filled, and _sharp_filled.
autocomplete	Boolean/String	false	Sets browsers autocomplete predictions on/off.
autofocus	Boolean	false	Autofocus field when this component is mounted.
clear-button	Boolean	false	Sets auto show the clear button.
datalist	String		Target <datalist> element ID.
disabled	Boolean	false	Enable/disable the component and the <input> element.
external-validator deprecated	TValidator		Use validator instead.
filled	Boolean	false	Create the component with solid fill style appearance. See Google Material Design for details.
flat	Boolean	false	Create the component with flat style appearance, and removes the borders. The component appearance will be styled like plain text.
floating-label	Boolean	false	Create the component with floating field label. See Google Material Design for details.
help-text	String		The help text to display below the field component.
id	String		Sets <input> element ID attribute. This property value is auto generates.
maxlength	Number		Sets <input> element maximum characters allowed.
minlength	Number		Sets <input> element minimum characters allowed.
model-value v-model	String/Number		Monitored by v-model to maintain this field value. v2.0.0
name	String		Sets <input> element name attribute.
outlined	Boolean	false	Create the component with outline style appearance. See Google Material Design spec.
password-toggle	Boolean	true	Enable toggle password field.
persistent-help-text	Boolean	true	Keeps help text visible when the component is not focused.
placeholder	String		Sets the field placeholder.
prefix	String		Prepend inline non-modifiable text before the input field. v2.0.10
prepend-icon	String		Sets icon to display at the inner left side. Updated on v2.1.0 Use any valid android icon name from Google Material Symbols with or without a suffix. Valid suffixes are: _outlined, _rounded, _sharp, _filled, _outlined_filled, _rounded_filled, and _sharp_filled.
prepend-icon-outer	String		Sets icon to display at the outer left side. Updated on v2.1.0 Use any valid android icon name from Google Material Symbols with or without a suffix. Valid suffixes are: _outlined, _rounded, _sharp, _filled, _outlined_filled, _rounded_filled, and _sharp_filled.
readonly	Boolean	false	Put the component in readonly state and sets the <input> element readonly attribute.
required	Boolean	false	Sets <input> element required attribute.
rounded	Boolean	false	Create the component with rounded-pill style appearance. v2.0.5
suffix	String		Append inline non-modifiable text after the input field. v2.0.10
type	String	'text'	Sets <input> element type attribute. Valid values are: text, password, email, url, tel.
validation-icon	Boolean	false	Display validation icon or not, when this field has been validated. v2.0.0
validator	TValidator		The configuration options to integrate external validator plugin to validate this field value. v2.0.0

Name	Arguments	Description
blur	( evt:FocusEvent)	Triggers when cursor leave the <input> element.
clear		Fired after this field value is cleared.
focus	( evt:FocusEvent)	Triggers when cursor entered the <input> element.
keydown	( evt:KeyboardEvent)	Triggers when cursor is still in the <input> element and keyboard key is pressed.
update:model-value	( value:String/Number)	Used to update the model-value property. v2.0.0

Name	Description
default	The outlet slot used to place the field label.
append-inner	The outlet slot used to place custom icon or component at the inner right side. v2.0.0
append-outer	The outlet slot used to place custom icon or component at the outer right side. v2.0.0
help-text	The outlet slot used for custom help text. v2.0.0
prepend-inner	The outlet slot used to place custom icon or component at the inner left side. v2.0.0
prepend-outer	The outlet slot used to place custom icon or component at the outer left side. v2.0.0

TValidator

The validator configuration option has properties as described below:

Property	Type	Description
validators	Record<String,Boolean>	External validator plugin validation result.
messages	Record<String,String>	Validation message for each validation types.
hasError	Boolean	An indicator that tells the field value pass the validation or not.
dirty	Boolean	Value comes from validator plugin that indicate the field is dirty or not.

All properties are mandatory.

NOTE

Vue MDBootstrap does not include form validation by default, we leave that up to the 3rd party form validation plugin. As of now, Vuelidate has been fully tested with our component library.