--- title: HTMLInputElement slug: Web/API/HTMLInputElement tags: - API - HTML DOM - Interface - NeedsNewLayout - NeedsTranslation - Reference - TopicStub translation_of: Web/API/HTMLInputElement --- {{ APIRef("HTML DOM") }} The **`HTMLInputElement`** interface provides special properties and methods for manipulating the options, layout, and presentation of {{HtmlElement("input")}} elements. {{InheritanceDiagram(600, 120)}} ## Properties
form {{readonlyInline}} |
{{domxref("HTMLFormElement")}} object :
Returns a reference to the parent
{{HtmlElement("form")}} element.
|
formAction |
string : Returns / Sets the
element's {{ htmlattrxref("formaction", "input") }}
attribute, containing the URI of a program that processes information
submitted by the element. This overrides the
{{ htmlattrxref("action", "form") }} attribute of the parent
form.
|
formEncType |
string : Returns / Sets the
element's {{ htmlattrxref("formenctype", "input") }}
attribute, containing the type of content that is used to submit the
form to the server. This overrides the
{{ htmlattrxref("enctype", "form") }} attribute of the parent
form.
|
formMethod |
string : Returns / Sets the
element's {{ htmlattrxref("formmethod", "input") }}
attribute, containing the HTTP method that the browser uses to submit
the form. This overrides the
{{ htmlattrxref("method", "form") }} attribute of the parent
form.
|
formNoValidate |
{{jsxref("Boolean")}}: Returns / Sets the element's {{ htmlattrxref("formnovalidate", "input") }} attribute, indicating that the form is not to be validated when it is submitted. This overrides the {{ htmlattrxref("novalidate", "form") }} attribute of the parent form. |
formTarget |
string : Returns / Sets the
element's {{ htmlattrxref("formtarget", "input") }}
attribute, containing a name or keyword indicating where to display the
response that is received after submitting the form. This overrides the
{{ htmlattrxref("target", "form") }} attribute of the parent
form.
|
name |
string : Returns / Sets the
element's {{ htmlattrxref("name", "input") }} attribute,
containing a name that identifies the element when submitting the form.
|
type |
string : Returns / Sets the element's
{{ htmlattrxref("type", "input") }} attribute, indicating
the type of control to display. See
{{ htmlattrxref("type", "input") }} attribute of
{{ HTMLElement("input") }} for possible values.
|
disabled |
{{jsxref("Boolean")}}: Returns / Sets the element's {{ htmlattrxref("disabled", "input") }} attribute, indicating that the control is not available for interaction. The input values will not be submitted with the form. See also {{ htmlattrxref("readOnly", "input") }} |
autofocus |
{{jsxref("Boolean")}}:
Returns / Sets the element's
{{ htmlattrxref("autofocus", "input") }} attribute, which
specifies that a form control should have input focus when the page
loads, unless the user overrides it, for example by typing in a
different control. Only one form element in a document can have the
{{htmlattrxref("autofocus","input")}} attribute. It cannot be
applied if the {{htmlattrxref("type","input")}} attribute is
set to hidden (that is, you cannot automatically set focus
to a hidden control).
|
required |
{{jsxref("Boolean")}}: Returns / Sets the element's {{ htmlattrxref("required", "input") }} attribute, indicating that the user must fill in a value before submitting a form. |
value |
string : Returns / Sets the current value of the
control.
Note : If the user enters a value different from the value expected, this may return an empty string. |
validity {{readonlyInline}} |
{{domxref("ValidityState")}} object :
Returns the element's current validity state.
|
validationMessage {{readonlyInline}} |
string : Returns a localized message that describes
the validation constraints that the control does not satisfy (if any).
This is the empty string if the control is not a candidate for
constraint validation
({{htmlattrxref("willValidate","input")}} is false), or it
satisfies its constraints. This value can be set by the
setCustomValidity method.
|
willValidate {{readonlyInline}} |
{{jsxref("Boolean")}}: Returns whether
the element is a candidate for constraint validation. It is false if any
conditions bar it from constraint validation, including: its
type is hidden , reset , or
button ; it has a
datalist ancestor;
its disabled property is true .
|
checked |
{{jsxref("Boolean")}}:
Returns / Sets the current state of the element when
{{htmlattrxref("type","input")}} is checkbox or
radio .
|
defaultChecked |
{{jsxref("Boolean")}}: Returns / Sets the default state of a radio button or checkbox as originally specified in HTML that created this object. |
indeterminate |
{{jsxref("Boolean")}}: Returns whether
the checkbox or radio button is in indeterminate state. For checkboxes,
the effect is that the appearance of the checkbox is obscured/greyed in
some way as to indicate its state is indeterminate (not checked but not
unchecked). Does not affect the value of the
checked attribute, and clicking the checkbox will set the
value to false.
|
alt |
string : Returns / Sets the
element's {{ htmlattrxref("alt", "input") }} attribute,
containing alternative text to use when
{{htmlattrxref("type","input")}} is image.
|
height |
string : Returns / Sets the
element's {{ htmlattrxref("height", "input") }} attribute,
which defines the height of the image displayed for the button, if the
value of {{htmlattrxref("type","input")}} is
image .
|
src |
string : Returns / Sets the element's
{{ htmlattrxref("src", "input") }} attribute, which specifies
a URI for the location of an image to display on the graphical submit
button, if the value of {{htmlattrxref("type","input")}} is
image ; otherwise it is ignored.
|
width |
string : Returns / Sets the document's
{{ htmlattrxref("width", "input") }} attribute, which
defines the width of the image displayed for the button, if the value of
{{htmlattrxref("type","input")}} is image .
|
accept |
string : Returns / Sets the
element's {{ htmlattrxref("accept", "input") }} attribute,
containing comma-separated list of file types accepted by the server
when {{htmlattrxref("type","input")}} is file .
|
allowdirs {{non-standard_inline}} |
{{jsxref("Boolean")}}: Part of the non-standard Directory Upload API; indicates whether or not to allow directories and files both to be selected in the file list. Implemented only in Firefox and is hidden behind a preference. |
files |
Returns/accepts a {{domxref("FileList")}} object, which contains a list of {{domxref("File")}} objects representing the files selected for upload. |
{{domxref("HTMLInputElement.webkitdirectory", "webkitdirectory")}} {{Non-standard_inline}} | {{jsxref("Boolean")}}: Returns the {{htmlattrxref("webkitdirectory", "input")}} attribute; if true, the file system picker interface only accepts directories instead of files. |
{{domxref("HTMLInputElement.webkitEntries", "webkitEntries")}} {{Non-standard_inline}} | Array of {{domxref("FileSystemEntry")}} objects: Describes the currently selected files or directories. |
autocomplete |
string : Returns / Sets the
element's {{htmlattrxref("autocomplete", "input")}}
attribute, indicating whether the value of the control can be
automatically completed by the browser. Ignored if the value of the
{{htmlattrxref("type","input")}} attribute is
hidden , checkbox , radio ,
file , or a button type (button ,
submit , reset , image ). Possible
values are:"on" : the browser can autocomplete the
value using previously stored value"off" : the user
must explicity enter a value
|
max |
string : Returns / Sets the
element's {{ htmlattrxref("max", "input") }} attribute,
containing the maximum (numeric or date-time) value for this item, which
must not be less than its minimum
({{htmlattrxref("min","input")}} attribute) value.
|
maxLength |
long : Returns / Sets the
element's {{ htmlattrxref("maxlength", "input") }}
attribute, containing the
maximum number of characters (in Unicode code points)
that the value can have. (If you set this to a negative number, an
exception will be thrown.)
|
min |
string : Returns / Sets the
element's {{ htmlattrxref("min", "input") }} attribute,
containing the minimum (numeric or date-time) value for this item, which
must not be greater than its maximum
({{htmlattrxref("max","input")}} attribute) value.
|
minLength |
long : Returns / Sets the
element's {{ htmlattrxref("minlength", "input") }}
attribute, containing the
minimum number of characters (in Unicode code points)
that the value can have. (If you set this to a negative number, an
exception will be thrown.)
|
pattern |
string : Returns / Sets the
element's {{ htmlattrxref("pattern", "input") }}
attribute, containing a regular expression that the
control's value is checked against. Use the
{{htmlattrxref("title","input")}} attribute to describe the
pattern to help the user. This attribute applies when the value of the
{{htmlattrxref("type","input")}} attribute is
text , search , tel ,
url or email ; otherwise it is ignored.
|
placeholder |
string : Returns / Sets the
element's {{ htmlattrxref("placeholder", "input") }}
attribute, containing a hint to the user of what can be entered in the
control. The placeholder text must not contain carriage returns or
line-feeds. This attribute applies when the value of the
{{htmlattrxref("type","input")}} attribute is
text , search , tel ,
url or email ; otherwise it is ignored.
|
readOnly |
boolean : Returns / Sets the
element's {{ htmlattrxref("readonly", "input") }}
attribute, indicating that the user cannot modify the value of the
control.{{HTMLVersionInline(5)}}This is ignored if the value of the {{htmlattrxref("type","input")}} attribute is hidden , range , color ,
checkbox , radio , file , or a
button type.
|
selectionStart |
unsigned long : Returns / Sets the
beginning index of the selected text. When nothing is selected, this
returns the position of the text input cursor (caret) inside of the
{{HTMLElement("input")}} element.
|
selectionEnd |
unsigned long : Returns / Sets the
end index of the selected text. When there's no selection, this returns
the offset of the character immediately following the current text input
cursor position.
|
selectionDirection |
string : Returns / Sets the
direction in which selection occurred. Possible values are:forward
if selection was performed in the start-to-end direction of the current
localebackward for the opposite directionnone
if the direction is unknown
|
size |
unsigned long : Returns / Sets the
element's {{ htmlattrxref("size", "input") }} attribute,
containing visual size of the control. This value is in
pixels unless the value of {{htmlattrxref("type","input")}}
is text or password , in which case, it is an
integer number of characters. Applies only when
{{htmlattrxref("type","input")}} is set to
text , search , tel ,
url , email , or password ;
otherwise it is ignored.
|
defaultValue |
string : Returns / Sets the
default value as originally specified in the HTML that created this
object.
|
dirName |
string : Returns / Sets the
directionality of the element.
|
accessKey |
string : Returns a string
containing a single character that switches input focus to the control
when pressed.
|
list {{readonlyInline}} |
{{domxref("HTMLElement")}} object :
Returns the element pointed by the
{{ htmlattrxref("list", "input") }} attribute. The property
may be null if no HTML element found in the same tree.
|
multiple |
{{jsxref("Boolean")}}: Returns / Sets the element's {{ htmlattrxref("multiple", "input") }} attribute, indicating whether more than one value is possible (e.g., multiple files). |
files |
{{domxref("FileList")}} array :
Returns the list of selected files.
|
{{domxref("HTMLInputElement.labels")}} {{readonlyInline}} |
{{domxref("NodeList")}} array :
Returns a list of {{ HTMLElement("label") }}
elements that are labels for this element.
|
step |
string : Returns / Sets the element's
{{ htmlattrxref("step", "input") }} attribute, which works
with {{htmlattrxref("min","input")}} and
{{htmlattrxref("max","input")}} to limit the increments at
which a numeric or date-time value can be set. It can be the string
any or a positive floating point number. If this is not set
to any , the control accepts only values at multiples of the
step value greater than the minimum.
|
valueAsDate |
{{jsxref("Date")}} object :
Returns / Sets the value of the element, interpreted as
a date, or null if conversion is not possible.
|
valueAsNumber |
double : Returns the value of the
element, interpreted as one of the following, in order:
|
autocapitalize {{experimental_inline}} |
string : Defines the capitalization behavior for
user input. Valid values are none , off ,
characters , words , or sentences .
|
inputmode |
Provides a hint to browsers as to the type of virtual keyboard configuration to use when editing this element or its contents. |
{{domxref("HTMLElement.blur()", "blur()")}} | Removes focus from the input element; keystrokes will subsequently go nowhere. |
{{domxref("HTMLElement.click()", "click()")}} | Simulates a click on the input element. |
{{domxref("HTMLElement.focus()", "focus()")}} | Focuses on the input element; keystrokes will subsequently go to this element. |
{{domxref("HTMLInputElement.select()", "select()")}} | Selects all the text in the input element, and focuses it so the user can subsequently replace all of its content. |
{{domxref("HTMLInputElement.setSelectionRange()", "setSelectionRange()")}} | Selects a range of text in the input element (but does not focus it). |
{{domxref("HTMLInputElement.setRangeText()", "setRangeText()")}} | Replaces a range of text in the input element with new text. |
setCustomValidity() |
Sets a custom validity message for the element. If this message is not the empty string, then the element is suffering from a custom validity error, and does not validate. |
checkValidity() |
Returns a {{jsxref("Boolean")}} that is false if the
element is a candidate for constraint validation, and it does not
satisfy its constraints. In this case, it also fires an
{{event("invalid")}} event at the element. It returns
true if the element is not a candidate for constraint
validation, or if it satisfies its constraints.
|
reportValidity() |
Runs the checkValidity() method, and if it returns false
(for an invalid input or no pattern attribute provided), then it reports
to the user that the input is invalid in the same manner as if you
submitted a form.
|