Indicates whether the validator accepts the current text value. If you don't use validator the value can be overridden with a custom validation binding.

 import Sailfish.Silica 1.0

 TextField {
     acceptableInput: text.length > 6
 }

This is true if no validator has been set.

See also validator.

Holds whether the text field will automatically scroll the Flickable that contains it to ensure visibility, when the text field gains active focus and when input is provided.

The default is true.

The Component to use to draw the background of the text field.

Style to use for the editor background.

Possible values

• TextEditor.UnderlineBackground - The text editor is rendered with an underline.
• TextEditor.FilledBackground - The text editor is rendered with a filled background.
• TextEditor.NoBackground - No background is rendered for the editor.

The default value is underlined background.

The color of the text.

The character position of the cursor within the text.

The value ranges from 0 to the number of characters in text.

A longer text to display below the label, e.g. hint text or error message that provides some additional detail on what kind of input is expected.

The default value is an empty string.

See also text, label, and placeholderText.

Controls how entered text is displayed. This is one of:

• TextInput.Normal - displays all text as entered (the default value)
• TextInput.Password - displays asterisks in place of entered text
• TextInput.PasswordEchoOnEdit - displays text as entered when the item has active focus and the text is being modified; otherwise, displays asterisks in place of entered text
• TextInput.NoEcho - entered text is not displayed

True if the text field should be highlighted to indicate that the current text input is invalid.

This defaults to the inverse value of acceptableInput, except when the user hasn't modified the content of the TextField yet.

True if the displayed text is rendered in bold, otherwise false.

Holds the capitalization formatting that is applied to the displayed text. This is one of:

• Font.MixedCase - no capitalization is applied (the default value)
• Font.AllUppercase - all text is rendered in uppercase
• Font.AllLowercase - all text is rendered in lowercase
• Font.SmallCaps - text is rendered in small caps
• Font.Capitalize - the first letter of each word is rendered with a capital letter

The name of the font family for rendering the displayed text.

True if the displayed text is rendered in italics, otherwise false.

Controls the spacing (in pixels) between letters in the displayed text.

Specifying a positive value increases the default spacing between letters, and specifying a negative value decreases this spacing.

The size of the displayed text, in pixels.

The size of the displayed text, in points.

True if the displayed text is rendered with a strikeout style, otherwise false.

True if the displayed text is rendered with an underline, otherwise false.

Holds the weight value for rendering the displayed text.

This is one of the following (listed from lightest to heaviest):

• Font.Light
• Font.Normal (the default value)
• Font.DemiBold
• Font.Bold
• Font.Black

Controls the spacing (in pixels) between words in the displayed text.

Specifying a positive value increases the default spacing between words, and specifying a negative value decreases this spacing.

The horizontal alignment of the text within the text field's width and height.

By default, the text alignment follows the natural alignment of the text, for example text that is read from left to right will be aligned to the left.

Valid values are:

• TextInput.AlignLeft (default)
• TextInput.AlignRight
• TextInput.AlignHCenter
• TextInput.AlignJustify

When using the attached property LayoutMirroring::enabled to mirror application layouts, the horizontal alignment of text will also be mirrored. However, the property horizontalAlignment will remain unchanged. To query the effective horizontal alignment of TextField, use the property LayoutMirroring::enabled.

Holds the hints to the input panel about the nature of the input this field expects. The input panel will display an input method suitable for the hints provided. The hints may be OR'ed together:

 TextField {
     inputMethodHints: Qt.ImhEmailCharactersOnly | Qt.ImhNoPredictiveText
 }

The supported input method hints are:

• Qt.ImhDialableCharactersOnly - Phone numbers
• Qt.ImhDigitsOnly - Integer numbers
• Qt.ImhEmailCharactersOnly - Email field
• Qt.ImhFormattedNumbersOnly - Decimal numbers
• Qt.ImhNoPredictiveText - Disable prediction
• Qt.ImhUrlCharactersOnly - Web address
• Qt.ImhNoAutoUppercase - Disable switch to uppercase at beginning of sentences

See also softwareInputPanelEnabled.

Text to display below the text entry field when text is not empty. This is useful for providing a description of the information to be entered in the text field. It is typically used in conjunction with placeholderText.

The default value is an empty string.

See also text, placeholderText, description, and labelVisible.

Holds whether the label text will be displayed below the input field when text is not empty.

Setting to false hides the label and releases the space reserved for the label.

The default value is true.

See also label.

Use leftItem to inject an item to the left side of the displayed text. The most common use case is to add an icon that helps user identify the field

Note the left item is vertically centered to the one-line text field, where as the right item is vertically centered to the first line of the visible text.

 import QtQuick 2.2
 import Sailfish.Silica 1.0

 TextField {
     label: "Email"
     leftItem: Icon {
         source: "image://theme/icon-m-mail"
     }
 }

The color of the placeholderText.

By default, the color is Theme.secondaryHighlightColor when the text field has active focus, and Theme.secondaryColor otherwise.

See also placeholderText.

The text to be displayed when text is empty. This is useful for providing an indication of the information to be entered in the text field. It is typically used in conjunction with label.

By default the placeholder text value follows label text value.

See also text, placeholderColor, label, and description.

Holds whether the text field is in read-only mode.

If set to true, the user cannot edit the text.

Use rightItem to inject an item to the right side of the displayed text. The most common use case is to introduce an action (e.g. clear text, show password, etc.) as an icon button next to the field.

Note the right item is vertically centered to the first line of the visible text, where as as the left item is vertically centered to the one-line text field.

 import QtQuick 2.2
 import Sailfish.Silica 1.0

 TextField {
     id: clearableField
     rightItem: IconButton {
         onClicked: clearableField.text = ""

         width: icon.width
         height: icon.height
         icon.source: "image://theme/icon-m-input-clear"
         opacity: clearableField.text.length > 0 ? 1.0 : 0.0
         Behavior on opacity { FadeAnimation {} }
     }
 }

If you haven't defined the right item and set errorHighlight to true the property will implicitly be changed to display an error icon.

The text that is currently selected.

The position of the end of the selected text.

This is a readonly property. The user can modify the selection by double tapping the text and moving the handles. The selection can be set programmatically via the select(), selectAll() or selectWord() functions.

See also select() and selectedText.

Holds how text should be selected when dragging a selection handle. This is one of:

• TextInput.SelectCharacters - The selection is updated character by character. (Default)
• TextInput.SelectWords - The selection is updated word by word.

The position of the start of the selected text.

This is a readonly property. The user can modify the selection by double tapping the text and moving the handles. The selection can be set programmatically via the select(), selectAll() or selectWord() functions.

See also select() and selectedText.

Holds whether the on-screen key input panel is displayed when the text field gains active focus.

The default is true.

Toggles the default Qt validation behaviour. When true, users can't type any characters that the validator considers invalid. When false, the TextField will show error, but allow the user to input invalid characters. Strict validation is often too restrictive, blocking text composition, text prediction and clipboard paste even if one character is wrong.

The default value is false.

The displayed text. Contrary to Qt text editors includes preedit text.

The margin to the left of the displayed text, within the bounds of the text field.

By default this follows textMargin, but also takes the width of leftItem if defined into account. The left item needs to have non-zero opacity to be counted in the default value.

The margin to the left and the right of the displayed text, within the bounds of the text field.

This can be overridden by textLeftMargin and textRightMargin.

The margin to the right of the displayed text, within the bounds of the text field.

By default this follows textMargin, but also takes the width of rightItem if defined into account. The right item needs to have non-zero opacity to be counted in the default value.

The vertical offset from top of the text field to the center of the actual editor element. This property can be used for centering e.g. an icon with the editor element:

 import QtQuick 2.2
 import Sailfish.Silica 1.0

 Page {
     TextField {
         id: textField
     }

     Image {
         anchors {
             left: textField.right
             verticalCenter: textField.top
             verticalCenterOffset: textField.textVerticalCenterOffset
         }
     }
 }

The object that validates any entered text. By default, a text field does not have a validator.

A validator is used to detect if user attempts to input unacceptable text. For example, the IntValidator below ensures that the user may only enter a number between 1-10 into the text field:

 import QtQuick 2.6
 import Sailfish.Silica 1.0

 TextField {
     placeholderText: "Single digit"
     validator: IntValidator { bottom: 0; top: 9 }
 }

See also acceptableInput and strictValidation.

Holds the mode used to wrap the text to the width of the text field. The text will only wrap if an explicit width has been set.

• TextInput.NoWrap - no wrapping will be performed. If the width of the text goes over the width of the text field the user needs to scroll the field to see the truncated parts. Wrapping is recommended as then user can often see the text in full.
• TextInput.WordWrap - wrapping is done on word boundaries only. If a word is too long, implicitWidth will exceed a set width.
• TextInput.WrapAnywhere - wrapping is done at any point on a line, even if it occurs in the middle of a word.
• TextInput.Wrap - if possible, wrapping occurs at a word boundary; otherwise it will occur at the appropriate point on the line, even in the middle of a word.

The default is TextInput.NoWrap.

This signal handler is called when the text field is clicked. The mouse parameter provides information about the click.

This signal handler is called when there is a long press on the text field. The mouse parameter provides information about the press.

Copies the currently selected text and places it in the clipboard.

See also select() and paste().

Removes the currently selected text and places it in the clipboard.

See also select() and paste().

Removes the text selection. The text remains unchanged.

See also select().

Forces active focus on the text field.

When an item has Item::activeFocus, it becomes the item that receives keyboard input.

If there is a selection then the selection will be replaced with the contents of the clipboard; otherwise inserts the contents of the clipboard into the text at the cursorPosition.

Returns the character position closest to the point at (x, y).

Returns a rectangle of the geometry where the cursor position would be if it was placed at the specified character position.

Selects the text from start to end.

If either start or end is out of range, the selection is not changed.

After calling select(), selectionStart will become the lesser and selectionEnd will become the greater (regardless of the order passed to this method).

See also selectionStart, selectionEnd, and selectedText.

Selects all of the text.

See also select().

Selects the word nearest the cursorPosition.

See also select().