Skip to main content

fast-text-field

An implementation of a text field as a form-connected web-component. The fast-text-field supports two visual appearances, outline and filled, with the control defaulting to the outline appearance.

note

This component filters out slotted text nodes that are only white space to properly hide the label when the label is not in use.

Setup

import {
provideFASTDesignSystem,
fastTextField
} from "@microsoft/fast-components";

provideFASTDesignSystem()
.register(
fastTextField()
);

Usage

Live Editor
Result
Loading...

Create your own design

import {
TextField,
textFieldTemplate as template,
} from "@microsoft/fast-foundation";
import { textFieldStyles as styles } from "./my-text-field.styles";


export const myTextField = TextField.compose({
baseName: "text-field",
template,
styles,
shadowOptions: {
delegatesFocus: true,
},
});
note

This component is built with the expectation that focus is delegated to the input element rendered into the shadow DOM.

API

class: TextField

Superclass

NameModulePackage
FormAssociatedTextField/src/text-field/text-field.form-associated.js

Fields

NamePrivacyTypeDefaultDescriptionInherited From
readOnlypublicbooleanWhen true, the control will be immutable by user interaction. See readonly HTML attribute for more information.
autofocuspublicbooleanIndicates that this element should get focus after the page finishes loading. See autofocus HTML attribute for more information.
placeholderpublicstringSets the placeholder value of the element, generally used to provide a hint to the user.
typepublicTextFieldType or "email" or "password" or "tel" or "text" or "url"Allows setting a type or mode of text.
listpublicstringAllows associating a datalist to the element by {@link https://developer.mozilla.org/en-US/docs/Web/API/Element/id}.
maxlengthpublicnumberThe maximum number of characters a user can enter.
minlengthpublicnumberThe minimum number of characters a user can enter.
patternpublicstringA regular expression that the value must match to pass validation.
sizepublicnumberSets the width of the element to a specified number of characters.
spellcheckpublicbooleanControls whether or not to enable spell checking for the input field, or if the default spell checking configuration should be used.
proxyFormAssociatedTextField
$presentationpublicComponentPresentation or nullA property which resolves the ComponentPresentation instance for the current component.FoundationElement
templatepublicElementViewTemplate or void or nullSets the template of the element instance. When undefined, the element will attempt to resolve the template from the associated presentation or custom element definition.FoundationElement
stylespublicElementStyles or void or nullSets the default styles for the element instance. When undefined, the element will attempt to resolve default styles from the associated presentation or custom element definition.FoundationElement

Methods

NamePrivacyDescriptionParametersReturnInherited From
templateChangedprotectedvoidFoundationElement
stylesChangedprotectedvoidFoundationElement

Attributes

NameFieldInherited From
readonlyreadOnly
autofocus
placeholderplaceholder
typetype
listlist
maxlength
minlength
patternpattern
size
spellcheck

class: DelegatesARIATextbox


Additional resources