Text Field

e-textfield Component is a fundamental user interface element used to collect user input or data in various forms, such as text, numbers, dates, or selections.

view on GitHub

Icons

The e-textfield With Icon component pairs a standard text input with a functional addon element, can be positioned on either the left or right side of the input field.

Validations

Input fields use a rule-based validation system that returns true or a text string.

API Reference

Props

Explore the available props for the form component

PropertyDescriptionTypeDefault
retain-colorallows the input to maintain the color regardless of the state it is inbooleanfalse
disabledModify the style and change the input state to disabledbooleanfalse
readonlychange the input state to disabledbooleanfalse
counterplaces a counter at the bottom of the component with the number of characters that have been entered booleanfalse
clearablesets whether the component is cleanable or not booleanfalse
label-inlineset the css rule white-space: nowrap; to the labelbooleanfalse
detaildisplays an informational message below the componentstring
outlinedapplies an outlined stylebooleanfalse
labellabel associated with the input fieldstring | number
model-valueThe v-model value of the component. string | number
placeholderinput placeholderstring
suffixDisplays suffix text.string
prefixDisplays prefix text.string
input-alignapply text-align css rule to the input fieldstring
colorApplies specified color to the component - supports only utility colors (for example primary or secondary) stringundefined
limitsets a character limit to the input fieldbooleanfalse
detail-errorsshows an error message below the component and changes the stateArray<string>[]
label-min-widthThis sets a minimum width in px for the labelstring
colsSets the default number of columns the component extends. Available options are: {1...24}. string | number
smChanges the number of columns on small and greater breakpoints.string | number
mdChanges the number of columns on medium and greater breakpoints.string | number
lgChanges the number of columns on large and greater breakpoints.string | number
icon-clearicon displayed on the button to clear the input contentArray<IconPath> IconPath string undefined
append-iconicon to be displayed to the left of the componentArray<IconPath> IconPath string undefined
prepend-iconicon to be displayed to the left of the component Array<IconPath> IconPath string undefined
rulesAccepts a array of types function that pass an input value as an argument and must return either true | false or a string containing an error message. This also change the input state.Array<(param: any)=> string | true>