aboutsummaryrefslogtreecommitdiff
path: root/files/fr/web/api/htmlinputelement/index.md
blob: 7240d27edbb4eb7f053c430fd5a152c617c8bfee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
---
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

<table class="standard-table">
  <caption>
    Properties related to the parent form
  </caption>
  <thead></thead>
  <tbody>
    <tr>
      <td><code>form </code>{{readonlyInline}}</td>
      <td>
        <em>{{domxref("HTMLFormElement")}}<code> object</code>:</em>
        <strong>Returns</strong> a reference to the parent
        {{HtmlElement("form")}} element.
      </td>
    </tr>
    <tr>
      <td><code>formAction</code></td>
      <td>
        <em><code>string</code>: </em><strong>Returns / Sets</strong> 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.
      </td>
    </tr>
    <tr>
      <td><code>formEncType</code></td>
      <td>
        <em><code>string</code>:</em> <strong>Returns / Sets</strong> 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.
      </td>
    </tr>
    <tr>
      <td><code>formMethod</code></td>
      <td>
        <em><code>string</code>:</em> <strong>Returns / Sets</strong> 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.
      </td>
    </tr>
    <tr>
      <td><code>formNoValidate</code></td>
      <td>
        <em>{{jsxref("Boolean")}}:</em>
        <strong>Returns / Sets</strong> 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.
      </td>
    </tr>
    <tr>
      <td><code>formTarget</code></td>
      <td>
        <em><code>string</code>:</em> <strong>Returns / Sets</strong> 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.
      </td>
    </tr>
  </tbody>
</table>

<table class="standard-table">
  <caption>
    Properties that apply to any type of input element that is not hidden
  </caption>
  <tbody>
    <tr>
      <td><code>name</code></td>
      <td>
        <em><code>string</code>:</em> <strong>Returns / Sets</strong> the
        element's {{ htmlattrxref("name", "input") }} attribute,
        containing a name that identifies the element when submitting the form.
      </td>
    </tr>
    <tr>
      <td><code>type</code></td>
      <td>
        <code><em>string</em></code
        >: <strong>Returns / Sets</strong> 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.
      </td>
    </tr>
    <tr>
      <td><code>disabled</code></td>
      <td>
        <em>{{jsxref("Boolean")}}:</em>
        <strong>Returns / Sets</strong> 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") }}
      </td>
    </tr>
    <tr>
      <td><code>autofocus</code></td>
      <td>
        <em>{{jsxref("Boolean")}}:</em>
        <strong>Returns / Sets</strong> 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 <code>hidden</code> (that is, you cannot automatically set focus
        to a hidden control).
      </td>
    </tr>
    <tr>
      <td><code>required</code></td>
      <td>
        <em>{{jsxref("Boolean")}}:</em>
        <strong>Returns / Sets</strong> the element's
        {{ htmlattrxref("required", "input") }} attribute,
        indicating that the user must fill in a value before submitting a form.
      </td>
    </tr>
    <tr>
      <td><code>value</code></td>
      <td>
        <code><em>string</em></code
        ><em>:</em> <strong>Returns / Sets</strong> the current value of the
        control.
        <div>
          <p>
            <strong>Note :</strong> If the user enters a value different from
            the value expected, this may return an empty string.
          </p>
        </div>
      </td>
    </tr>
    <tr>
      <td><code>validity</code> {{readonlyInline}}</td>
      <td>
        <em>{{domxref("ValidityState")}}<code> object</code>:</em>
        <strong>Returns</strong> the element's current validity state.
      </td>
    </tr>
    <tr>
      <td><code>validationMessage</code> {{readonlyInline}}</td>
      <td>
        <code><em>string</em></code
        ><em>:</em> <strong>Returns</strong> 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
        <code>setCustomValidity</code> method.
      </td>
    </tr>
    <tr>
      <td><code>willValidate </code>{{readonlyInline}}</td>
      <td>
        <em>{{jsxref("Boolean")}}:</em> <strong>Returns</strong> whether
        the element is a candidate for constraint validation. It is false if any
        conditions bar it from constraint validation, including: its
        <code>type</code> is <code>hidden</code>, <code>reset</code>, or
        <code>button</code>; it has a
        <a href="/en-US/docs/Web/HTML/Element/datalist">datalist</a> ancestor;
        its <code>disabled</code> property is <code>true</code>.
      </td>
    </tr>
  </tbody>
</table>

<table class="standard-table">
  <caption>
    Properties that apply only to elements of type
    <code>"checkbox"</code>
    or
    <code>"radio"</code>
  </caption>
  <tbody>
    <tr>
      <td><code>checked</code></td>
      <td>
        <em>{{jsxref("Boolean")}}:</em>
        <strong>Returns / Sets</strong> the current state of the element when
        {{htmlattrxref("type","input")}} is <code>checkbox</code> or
        <code>radio</code>.
      </td>
    </tr>
    <tr>
      <td><code>defaultChecked</code></td>
      <td>
        <em>{{jsxref("Boolean")}}:</em>
        <strong>Returns / Sets</strong> the default state of a radio button or
        checkbox as originally specified in HTML that created this object.
      </td>
    </tr>
    <tr>
      <td><code>indeterminate</code></td>
      <td>
        <em>{{jsxref("Boolean")}}:</em> <strong>Returns</strong> 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
        <code>checked</code> attribute, and clicking the checkbox will set the
        value to false.
      </td>
    </tr>
  </tbody>
</table>

<table class="standard-table">
  <caption>
    Properties that apply only to elements of type
    <code>"image"</code>
  </caption>
  <tbody>
    <tr>
      <td><code>alt</code></td>
      <td>
        <em><code>string</code>: </em><strong>Returns / Sets</strong> the
        element's {{ htmlattrxref("alt", "input") }} attribute,
        containing alternative text to use when
        {{htmlattrxref("type","input")}} is <code>image.</code>
      </td>
    </tr>
    <tr>
      <td><code>height</code></td>
      <td>
        <em><code>string</code>: </em><strong>Returns / Sets</strong> 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
        <code>image</code>.
      </td>
    </tr>
    <tr>
      <td><code>src</code></td>
      <td>
        <code><em>string</em></code
        ><em>:</em> <strong>Returns / Sets</strong> 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
        <code>image</code>; otherwise it is ignored.
      </td>
    </tr>
    <tr>
      <td><code>width</code></td>
      <td>
        <code><em>string</em></code
        ><em>:</em> <strong>Returns / Sets</strong> 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 <code>image</code>.
      </td>
    </tr>
  </tbody>
</table>

<table class="standard-table">
  <caption>
    Properties that apply only to elements of type
    <code>"file"</code>
  </caption>
  <tbody>
    <tr>
      <td><code>accept</code></td>
      <td>
        <em><code>string</code>: </em><strong>Returns / Sets</strong> the
        element's {{ htmlattrxref("accept", "input") }} attribute,
        containing comma-separated list of file types accepted by the server
        when {{htmlattrxref("type","input")}} is <code>file</code>.
      </td>
    </tr>
    <tr>
      <td><code>allowdirs</code> {{non-standard_inline}}</td>
      <td>
        <em>{{jsxref("Boolean")}}:</em> Part of the non-standard
        Directory Upload API; <strong>indicates</strong> 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.
      </td>
    </tr>
    <tr>
      <td><code>files</code></td>
      <td>
        <strong>Returns/accepts</strong> a {{domxref("FileList")}}
        object, which contains a list of {{domxref("File")}} objects
        representing the files selected for upload.
      </td>
    </tr>
    <tr>
      <td>
        {{domxref("HTMLInputElement.webkitdirectory", "webkitdirectory")}}
        {{Non-standard_inline}}
      </td>
      <td>
        <em>{{jsxref("Boolean")}}:</em><strong> Returns</strong> the
        {{htmlattrxref("webkitdirectory", "input")}} attribute;
        if true, the file system picker interface only accepts directories
        instead of files.
      </td>
    </tr>
    <tr>
      <td>
        {{domxref("HTMLInputElement.webkitEntries", "webkitEntries")}}
        {{Non-standard_inline}}
      </td>
      <td>
        <em>Array of {{domxref("FileSystemEntry")}} objects:</em>
        <strong>Describes</strong> the currently selected files or directories.
      </td>
    </tr>
  </tbody>
</table>

<table class="standard-table">
  <caption>
    Properties that apply only to
    <code>text/number</code
    >-containing or elements
  </caption>
  <tbody>
    <tr>
      <td><code>autocomplete</code></td>
      <td>
        <em><code>string</code>: </em><strong>Returns / Sets</strong> 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
        <code>hidden</code>, <code>checkbox</code>, <code>radio</code>,
        <code>file</code>, or a button type (<code>button</code>,
        <code>submit</code>, <code>reset</code>, <code>image</code>). Possible
        values are:<br /><code>"on"</code>: the browser can autocomplete the
        value using previously stored value<br /><code>"off"</code>: the user
        must explicity enter a value
      </td>
    </tr>
    <tr>
      <td><code>max</code></td>
      <td>
        <em><code>string</code>:</em> <strong>Returns / Sets</strong> 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.
      </td>
    </tr>
    <tr>
      <td><code>maxLength</code></td>
      <td>
        <em><code>long</code>:</em> <strong>Returns / Sets</strong> the
        element's {{ htmlattrxref("maxlength", "input") }}
        attribute, containing the
        <strong>maximum number of characters</strong> (in Unicode code points)
        that the value can have. (If you set this to a negative number, an
        exception will be thrown.)
      </td>
    </tr>
    <tr>
      <td><code>min</code></td>
      <td>
        <em><code>string</code>:</em> <strong>Returns / Sets</strong> 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.
      </td>
    </tr>
    <tr>
      <td><code>minLength</code></td>
      <td>
        <em><code>long</code>:</em> <strong>Returns / Sets</strong> the
        element's {{ htmlattrxref("minlength", "input") }}
        attribute, containing the
        <strong>minimum number of characters</strong> (in Unicode code points)
        that the value can have. (If you set this to a negative number, an
        exception will be thrown.)
      </td>
    </tr>
    <tr>
      <td><code>pattern</code></td>
      <td>
        <em><code>string</code>:</em> <strong>Returns / Sets</strong> the
        element's {{ htmlattrxref("pattern", "input") }}
        attribute, containing a <strong>regular expression</strong> 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
        <code>text</code>, <code>search</code>, <code>tel</code>,
        <code>url</code> or <code>email</code>; otherwise it is ignored.
      </td>
    </tr>
    <tr>
      <td><code>placeholder</code></td>
      <td>
        <em><code>string</code>: </em><strong>Returns / Sets </strong>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
        <code>text</code>, <code>search</code>, <code>tel</code>,
        <code>url</code> or <code>email</code>; otherwise it is ignored.
      </td>
    </tr>
    <tr>
      <td><code>readOnly</code></td>
      <td>
        <em><code>boolean</code>:</em><strong> Returns / Sets</strong> the
        element's {{ htmlattrxref("readonly", "input") }}
        attribute, indicating that the user cannot modify the value of the
        control.<br />{{HTMLVersionInline(5)}}This is ignored if the
        value of the {{htmlattrxref("type","input")}} attribute is
        <code>hidden</code>, <code>range</code>, <code>color</code>,
        <code>checkbox</code>, <code>radio</code>, <code>file</code>, or a
        button type.
      </td>
    </tr>
    <tr>
      <td><code>selectionStart</code></td>
      <td>
        <em><code>unsigned long</code>:</em> <strong>Returns / Sets</strong> 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.
      </td>
    </tr>
    <tr>
      <td><code>selectionEnd</code></td>
      <td>
        <em><code>unsigned long</code>:</em> <strong>Returns / Sets </strong>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.
      </td>
    </tr>
    <tr>
      <td><code>selectionDirection</code></td>
      <td>
        <em><code>string</code>:</em> <strong>Returns / Sets</strong> the
        direction in which selection occurred. Possible values are:<br /><code
          >forward</code
        >
        if selection was performed in the start-to-end direction of the current
        locale<br /><code>backward</code> for the opposite direction<br /><code
          >none</code
        >
        if the direction is unknown
      </td>
    </tr>
    <tr>
      <td><code>size</code></td>
      <td>
        <em><code>unsigned long</code>:</em> <strong>Returns / Sets </strong>the
        element's {{ htmlattrxref("size", "input") }} attribute,
        containing <strong>visual size of the control</strong>. This value is in
        pixels unless the value of {{htmlattrxref("type","input")}}
        is <code>text</code> or <code>password</code>, in which case, it is an
        integer number of characters. Applies only when
        {{htmlattrxref("type","input")}} is set to
        <code>text</code>, <code>search</code>, <code>tel</code>,
        <code>url</code>, <code>email</code>, or <code>password</code>;
        otherwise it is ignored.
      </td>
    </tr>
  </tbody>
</table>

<table class="standard-table">
  <caption>
    Properties not yet categorized
  </caption>
  <tbody>
    <tr>
      <td><code>defaultValue</code></td>
      <td>
        <em><code>string</code>:</em> <strong>Returns / Sets</strong> the
        default value as originally specified in the HTML that created this
        object.
      </td>
    </tr>
    <tr>
      <td><code>dirName</code></td>
      <td>
        <em><code>string</code>:</em> <strong>Returns / Sets </strong>the
        directionality of the element.
      </td>
    </tr>
    <tr>
      <td><code>accessKey</code></td>
      <td>
        <em><code>string</code>: </em><strong>Returns</strong> a string
        containing a single character that switches input focus to the control
        when pressed.
      </td>
    </tr>
    <tr>
      <td><code>list</code> {{readonlyInline}}</td>
      <td>
        <em>{{domxref("HTMLElement")}}<code> object</code>:</em>
        <strong>Returns</strong> the element pointed by the
        {{ htmlattrxref("list", "input") }} attribute. The property
        may be <code>null</code> if no HTML element found in the same tree.
      </td>
    </tr>
    <tr>
      <td><code>multiple</code></td>
      <td>
        <em>{{jsxref("Boolean")}}:</em>
        <strong>Returns / Sets</strong> the element's
        {{ htmlattrxref("multiple", "input") }} attribute,
        indicating whether more than one value is possible (e.g., multiple
        files).
      </td>
    </tr>
    <tr>
      <td><code>files</code></td>
      <td>
        <em>{{domxref("FileList")}}<code> array</code>:</em>
        <strong>Returns</strong> the list of selected files.
      </td>
    </tr>
    <tr>
      <td>
        {{domxref("HTMLInputElement.labels")}}
        {{readonlyInline}}
      </td>
      <td>
        <em>{{domxref("NodeList")}}<code> array</code>:</em>
        <strong>Returns</strong> a list of {{ HTMLElement("label") }}
        elements that are labels for this element.
      </td>
    </tr>
    <tr>
      <td><code>step</code></td>
      <td>
        <code><em>string</em></code
        ><em>:</em> <strong>Returns / Sets</strong> the element's
        {{ htmlattrxref("step", "input") }} attribute, which works
        with<strong> </strong>{{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
        <code>any</code> or a positive floating point number. If this is not set
        to <code>any</code>, the control accepts only values at multiples of the
        step value greater than the minimum.
      </td>
    </tr>
    <tr>
      <td><code>valueAsDate</code></td>
      <td>
        <em>{{jsxref("Date")}}<code> object</code>:</em>
        <strong>Returns / Sets</strong> the value of the element, interpreted as
        a date, or <code>null</code> if conversion is not possible.
      </td>
    </tr>
    <tr>
      <td><code>valueAsNumber</code></td>
      <td>
        <em><code>double</code>:</em> <strong>Returns</strong> the value of the
        element, interpreted as one of the following, in order:
        <ul>
          <li>A time value</li>
          <li>A number</li>
          <li><code>NaN</code> if conversion is impossible</li>
        </ul>
      </td>
    </tr>
    <tr>
      <td><code>autocapitalize</code> {{experimental_inline}}</td>
      <td>
        <code><em>string</em></code
        ><em>:</em> <strong>Defines</strong> the capitalization behavior for
        user input. Valid values are <code>none</code>, <code>off</code>,
        <code>characters</code>, <code>words</code>, or <code>sentences</code>.
      </td>
    </tr>
    <tr>
      <td><code>inputmode</code></td>
      <td>
        Provides a hint to browsers as to the type of virtual keyboard
        configuration to use when editing this element or its contents.
      </td>
    </tr>
  </tbody>
</table>

- {{domxref("HTMLInputElement.align")}} {{obsolete_inline}}
  - : `string`_:_ **Represents** the alignment of the element. _Use CSS instead._
- {{domxref("HTMLInputElement.useMap")}} {{ obsolete_inline }}
  - : `string`_:_ **Represents** a client-side image map.

## Methods

<table class="standard-table">
  <tbody>
    <tr>
      <td>{{domxref("HTMLElement.blur()", "blur()")}}</td>
      <td>
        Removes focus from the input element; keystrokes will subsequently go
        nowhere.
      </td>
    </tr>
    <tr>
      <td>{{domxref("HTMLElement.click()", "click()")}}</td>
      <td>Simulates a click on the input element.</td>
    </tr>
    <tr>
      <td>{{domxref("HTMLElement.focus()", "focus()")}}</td>
      <td>
        Focuses on the input element; keystrokes will subsequently go to this
        element.
      </td>
    </tr>
    <tr>
      <td>
        {{domxref("HTMLInputElement.select()", "select()")}}
      </td>
      <td>
        Selects all the text in the input element, and focuses it so the user
        can subsequently replace all of its content.
      </td>
    </tr>
    <tr>
      <td>
        {{domxref("HTMLInputElement.setSelectionRange()", "setSelectionRange()")}}
      </td>
      <td>
        Selects a range of text in the input element (but does not focus it).
      </td>
    </tr>
    <tr>
      <td>
        {{domxref("HTMLInputElement.setRangeText()", "setRangeText()")}}
      </td>
      <td>Replaces a range of text in the input element with new text.</td>
    </tr>
    <tr>
      <td><code>setCustomValidity()</code></td>
      <td>
        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.
      </td>
    </tr>
    <tr>
      <td><code>checkValidity()</code></td>
      <td>
        Returns a {{jsxref("Boolean")}} that is <code>false</code> 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
        <code>true</code> if the element is not a candidate for constraint
        validation, or if it satisfies its constraints.
      </td>
    </tr>
    <tr>
      <td><code>reportValidity()</code></td>
      <td>
        Runs the <code>checkValidity()</code> 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.
      </td>
    </tr>
  </tbody>
</table>

- {{domxref("HTMLInputElement.stepDown()")}}

  - : Decrements the {{htmlattrxref("value","input")}} by ({{htmlattrxref("step","input")}} \* n), where n defaults to 1 if not specified. Throws an INVALID_STATE_ERR exception:

    - if the method is not applicable to for the current {{htmlattrxref("type","input")}} value,
    - if the element has no {{htmlattrxref("step","input")}} value,
    - if the {{htmlattrxref("value","input")}} cannot be converted to a number,
    - if the resulting value is above the {{htmlattrxref("max","input")}} or below the {{htmlattrxref("min","input")}}.

- {{domxref("HTMLInputElement.stepUp()")}}

  - : Increments the {{htmlattrxref("value","input")}} by ({{htmlattrxref("step","input")}} \* n), where n defaults to 1 if not specified. Throws an INVALID_STATE_ERR exception:

    - if the method is not applicable to for the current {{htmlattrxref("type","input")}} value.,
    - if the element has no {{htmlattrxref("step","input")}} value,
    - if the {{htmlattrxref("value","input")}} cannot be converted to a number,
    - if the resulting value is above the {{htmlattrxref("max","input")}} or below the {{htmlattrxref("min","input")}}.

- {{domxref("HTMLInputElement.mozSetFileArray()")}} {{non-standard_inline}}
  - : Sets the files selected on the input to the given array of {{domxref("File")}} objects. This is an alternative to `mozSetFileNameArray()` which can be used in frame scripts: a chrome script can [open files as File objects](/en-US/docs/Extensions/Using_the_DOM_File_API_in_chrome_code) and send them via [message manager](/en-US/Firefox/Multiprocess_Firefox/The_message_manager).
- {{domxref("HTMLInputElement.mozGetFileNameArray()")}} {{non-standard_inline}}
  - : Returns an array of all the file names from the input.
- {{domxref("HTMLInputElement.mozSetFileNameArray()")}} {{non-standard_inline}}
  - : Sets the filenames for the files selected on the input. Not for use in [frame scripts](/en-US/Firefox/Multiprocess_Firefox/Limitations_of_frame_scripts), because it accesses the file system.

## Events

Listen to these events using [`addEventListener()`](/en-US/docs/Web/API/EventTarget/addEventListener) or by assigning an event listener to the `oneventname` property of this interface:

- [`input`](/en-US/docs/Web/API/HTMLElement/input_event)
  - : Fires when the `value` of an {{HTMLElement("input")}}, {{HTMLElement("select")}}, or {{HTMLElement("textarea")}} element has been changed. Note that this is actually fired on the {{domxref("HTMLElement")}} interface and also applies to [`contenteditable`](/en-US/docs/Web/HTML/Global_attributes/contenteditable) elements, but we've listed it here because it is most commonly used with form input elements.
    Also available via the [`oninput`](/en-US/docs/Web/API/GlobalEventHandlers/oninput) event handler property.
- [`invalid`](/en-US/docs/Web/API/HTMLElement/invalid_event)
  - : Fired when an element does not satisfy its constraints during constraint validation.
    Also available via the [`oninvalid`](/en-US/docs/Web/API/GlobalEventHandlers/oninvalid) event handler property.
- [`search`](/en-US/docs/Web/API/HTMLInputElement/search_event)
  - : Fired when a search is initiated on an {{HTMLElement("input")}} of `type="search"`.
    Also available via the [`onsearch`](/en-US/docs/Web/API/GlobalEventHandlers/onsearch) event handler property.

## Specifications

| Specification                                                                                            | Status                           | Comment                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| -------------------------------------------------------------------------------------------------------- | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| {{SpecName('HTML WHATWG', "#htmlinputelement", "HTMLInputElement")}}             | {{Spec2('HTML WHATWG')}} |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| {{SpecName('HTML5 W3C', "forms.html#the-input-element", "HTMLInputElement")}} | {{Spec2('HTML5 W3C')}}     | Technically, the `tabindex` and `accesskey` properties, as well as the `blur()`, `click()`, and `focus()` methods, are now defined on {{domxref("HTMLElement")}}. The following properties are now obsolete: `align` and `useMap`. The following properties have been added: `autocomplete`, `autofocus`, `dirName`, `files`, `formAction`, `formEncType`, `formMethod`, `formNoValidate`, `formTarget`, `height`, `indeterminate`, `labels`, `list`, `max`, `min`, `multiple`, `pattern`, `placeholder`, `required`, `selectionDirection`, `selectionEnd`, `selectionStart`, `step`, `validationMessage`, `validity`, `valueAsDate`, `valueAsNumber`, `width`, and `willValidate`. The following methods have been added: `checkValidity()`, `setCustomValidity()`, `setSelectionRange()`, `stepUp()`, and `stepDown()`. |
| {{SpecName('DOM2 HTML', 'html.html#ID-6043025', 'HTMLInputElement')}}             | {{Spec2('DOM2 HTML')}}     | The `size` property is now an `unsigned long`. The `type` property must be entirely given in lowercase characters.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| {{SpecName('DOM1', 'level-one-html.html#ID-6043025', 'HTMLInputElement')}}     | {{Spec2('DOM1')}}         | Initial definition.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |

## Browser compatibility

{{Compat("api.HTMLInputElement")}}

## See also

- HTML element implementing this interface: {{ HTMLElement("input") }}