HTMLButtonElement

The HTMLButtonElement interface provides properties and methods (beyond the regular HTMLElement interface it also has available to it by inheritance) for manipulating <button> elements.

Properties

Inherits properties from its parent, HTMLElement.

HTMLButtonElement.accessKey

Is a DOMString indicating the single-character keyboard key to give access to the button.

HTMLButtonElement.autofocus

Is a boolean value indicating whether or not the 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-associated element in a document can have this attribute specified.

HTMLButtonElement.disabled

Is a boolean value indicating whether or not the control is disabled, meaning that it does not accept any clicks.

HTMLButtonElement.form Read only

Is a HTMLFormElement reflecting the form that this button is associated with. If the button is a descendant of a form element, then this attribute is the ID of that form element. If the button is not a descendant of a form element, then the attribute can be the ID of any form element in the same document it is related to, or the null value if none matches.

HTMLButtonElement.formAction

Is a DOMString reflecting the URI of a resource that processes information submitted by the button. If specified, this attribute overrides the action attribute of the <form> element that owns this element.

HTMLButtonElement.formEnctype

Is a DOMString reflecting the type of content that is used to submit the form to the server. If specified, this attribute overrides the enctype attribute of the <form> element that owns this element.

HTMLButtonElement.formMethod

Is a DOMString reflecting the HTTP method that the browser uses to submit the form. If specified, this attribute overrides the method attribute of the <form> element that owns this element.

HTMLButtonElement.formNoValidate

Is a boolean value indicating that the form is not to be validated when it is submitted. If specified, this attribute overrides the novalidate attribute of the <form> element that owns this element.

HTMLButtonElement.formTarget

Is a DOMString reflecting a name or keyword indicating where to display the response that is received after submitting the form. If specified, this attribute overrides the target attribute of the <form> element that owns this element.

HTMLButtonElement.labels Read only

Is a NodeList that represents a list of <label> elements that are labels for this button.

HTMLButtonElement.menu

Is a HTMLMenuElement representing the menu element to be displayed if the button is clicked and is of type="menu".

HTMLButtonElement.name

Is a DOMString representing the name of the object when submitted with a form. If specified, it must not be the empty string.

HTMLButtonElement.tabIndex

Is a long that represents this element's position in the tabbing order.

HTMLButtonElement.type

Is a DOMString indicating the behavior of the button. This is an enumerated attribute with the following possible values:

  • submit: The button submits the form. This is the default value if the attribute is not specified, or if it is dynamically changed to an empty or invalid value.
  • reset: The button resets the form.
  • button: The button does nothing.
  • menu: The button displays a menu.
HTMLButtonElement.willValidate Read only

Is a boolean value indicating whether the button is a candidate for constraint validation. It is false if any conditions bar it from constraint validation, including: its type property is reset or button; it has a <datalist> ancestor; or the disabled property is set to true.

HTMLButtonElement.validationMessage Read only

Is a DOMString representing the localized message that describes the validation constraints that the control does not satisfy (if any). This attribute is the empty string if the control is not a candidate for constraint validation (willValidate is false), or it satisfies its constraints.

HTMLButtonElement.validity Read only

Is a ValidityState representing the validity states that this button is in.

HTMLButtonElement.value

Is a DOMString representing the current form control value of the button.

Methods

Inherits methods from its parent, HTMLElement

Name Return Type Description
checkValidity() A boolean value Not supported for reset or button elements.
reportValidity() A boolean value Not supported for reset or button elements.
setCustomValidity(in DOMString error) void Not supported for reset or button elements.

With Gecko-based browser, use the :-moz-submit-invalid pseudo-class to style submit buttons based on the validation of a form.

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
HTMLButtonElement
1
12
1
5.5
≤12.1
3
1
18
4
≤12.1
1
1.0
checkValidity
4
12
4
10
≤12.1
5
≤37
18
4
≤12.1
5
1.0
disabled
1
12
1
5.5
≤12.1
3
1
18
4
≤12.1
1
1.0
form
1
12
1
5.5
≤12.1
3
1
18
4
≤12.1
1
1.0
formAction
9
12
4
In Firefox 56, the implementation has been updated so that the formAction property returns the correct form submission URL, as per spec, when the associated button is being used to submit a form (bug 1366361).
10
≤12.1
5.1
≤37
18
4
In Firefox 56, the implementation has been updated so that the formAction property returns the correct form submission URL, as per spec, when the associated button is being used to submit a form (bug 1366361).
≤12.1
5
1.0
formEnctype
9
12
4
10
≤12.1
5.1
≤37
18
4
≤12.1
5
1.0
formMethod
9
12
4
10
≤12.1
5.1
≤37
18
4
≤12.1
5
1.0
formNoValidate
4
12
4
10
≤12.1
5
≤37
18
4
≤12.1
4
1.0
formTarget
9
12
4
10
≤12.1
5.1
≤37
18
4
≤12.1
5
1.0
labels
6
18
56
No
≤12.1
5.1
≤37
18
56
≤12.1
5
1.0
name
1
12
1
5.5
≤12.1
3
1
18
4
≤12.1
1
1.0
reportValidity
40
17
49
No
27
10.1
40
40
64
27
10.3
4.0
setCustomValidity
4
12
4
10
≤12.1
5
≤37
18
4
≤12.1
5
1.0
type
1
12
1
5.5
≤12.1
3
1
18
4
≤12.1
1
1.0
validationMessage
5
12
4
10
≤12.1
5
≤37
18
4
≤12.1
4
1.0
validity
3
12
4
10
≤12.1
5
≤37
18
4
≤12.1
4
1.0
value
1
12
1
5.5
≤12.1
3
1
18
4
≤12.1
1
1.0
willValidate
1
12
4
10
≤12.1
4
≤37
18
4
≤12.1
3
1.0

See also

  • HTML element implementing this interface: <button>

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLButtonElement