Skip to main content
Version: 1.x

@microsoft/fast-foundation > TextField

TextField class

A Text Field Custom HTML Element. Based largely on the <input type="text" /> element.

start - Content which can be provided before the number field input

end - Content which can be provided after the number field input

  • The default slot for the label

label - The label

root - The element wrapping the control, including start and end slots

control - The text field element

change - Fires a custom 'change' event when the value has changed

Signature:
export declare class TextField extends FormAssociatedTextField 

Properties

PropertyModifiersTypeDescription
autofocusbooleanIndicates that this element should get focus after the page finishes loading. See autofocus HTML attribute for more information.
liststringAllows associating a datalist to the element by https://developer.mozilla.org/en-US/docs/Web/API/Element/id.
maxlengthnumberThe maximum number of characters a user can enter.
minlengthnumberThe minimum number of characters a user can enter.
patternstringA regular expression that the value must match to pass validation.
placeholderstringSets the placeholder value of the element, generally used to provide a hint to the user.
readOnlybooleanWhen true, the control will be immutable by user interaction. See readonly HTML attribute for more information.
sizenumberSets the width of the element to a specified number of characters.
spellcheckbooleanControls whether or not to enable spell checking for the input field, or if the default spell checking configuration should be used.
typeTextFieldTypeAllows setting a type or mode of text.

Methods

MethodModifiersDescription
select()Selects all the text in the text field