HTML autocorrect attribute #35692

hamishwillee · 2024-09-02T07:29:03Z

The global autocorrect attribute is now part of the standard. This documents it.

Note, in draft because I haven't been able to "see" and autocorrection behaviour in testing. Creating this PR allows me to create something that "may" allow that.

Related docs work in #35593

Go back and fix up BCD. I think I got it wrong for the property of the HTMLElement.

github-actions · 2024-09-02T07:30:25Z

Preview URLs (12 pages)

Flaws (1)

Note! 11 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/API/HTMLElement
Title: HTMLElement
Flaw count: 1

macros:
- /en-US/docs/Web/API/HTMLElement/cancel_event does not exist

(comment last updated: 2024-11-01 00:48:50)

hamishwillee · 2024-09-03T07:39:46Z

A little bit of safari 18 debug:

Password, email, url all return true or false for the value of the autocorrect - not match spec on or off.
Password does not autocorrect, but email and url do (try autocorrectt )
passwordElement.autocorrect=false; works, but "on" and "off" do not.
<input id="userPassword" type="text" autocorrect="off" /> - this turns it off - everything else is on. But the API returns true/false values. i.e. on and off are the values to set in the attribute value.
Form elements get autocorrect enabled by default - you can read it. Always on unless explicitly set to off in HTML or false via API.
- nested elements obey this as per spec (modulo using true/false not on/off)
Div elements get autocorrect and it is on by default, but it is not inherited.
contenteditable is same

files/en-us/web/html/element/input/text/index.md

Co-authored-by: Estelle Weyl <[email protected]>

hamishwillee · 2024-10-22T07:04:37Z

FYI reviewers, I just finished this draft end of day and so have not self-subedited. If you don't wish to review until Friday that would be more than fine.

files/en-us/web/api/htmlelement/autocorrect/index.md

estelle · 2024-10-22T23:53:35Z

files/en-us/web/api/htmlelement/autocorrect/index.md

+- {{htmlelement("textarea")}} elements and {{domxref("HTMLTextAreaElement")}} objects.
+- Any element that has the [`contenteditable`](/en-US/docs/Web/HTML/Global_attributes/contenteditable) attribute set.
+
+Editable text elements (other than the exceptions listed above) have auto-correction enabled by default, except for within a {{htmlelement("form")}} element, where the default value may be inherited from the form.


how about fieldsets? if set to false on the fieldset, is it inherited from that?

Good question. I don't think so.

As I read the spec the fieldset can inherit from the form, but a nested input within that fieldset would also inherit from the form. So even though the fieldset inherits from the form, this has no real impact on anything.

files/en-us/web/html/element/textarea/index.md

files/en-us/web/api/htmlelement/autocorrect/index.md

files/en-us/web/html/element/input/password/index.md

files/en-us/web/html/global_attributes/autocorrect/index.md

Co-authored-by: Estelle Weyl <[email protected]>

files/en-us/web/html/element/input/email/index.md

files/en-us/web/html/element/input/url/index.md

files/en-us/web/html/element/textarea/index.md

estelle

two issues and a suggested very basic example for the HTML attribute page (remove the "end" after the three tic marks if committing my suggestion)

estelle · 2024-10-29T01:23:51Z

files/en-us/web/api/htmlelement/autocorrect/index.md

+
+## Value
+
+`true` if auto-correction is enabled for the element, and `false` otherwise.


Suggested change

`true` if auto-correction is enabled for the element, and `false` otherwise.

`on` if auto-correction is enabled for the element, and `off` otherwise.

>[!NOTE]

> The Safari implementation returns a Boolean; `true` if auto-correction is enabled for the element, and `false` otherwise.

Or something like that: the spec says on/off, but safair does true/false, so 🤷

@estelle I am pretty sure that what I have here is correct. The spec says the HTML element (shown here) is a boolean that sets/gets true/false. The tag attribute takes a string on/off in spec.

See https://html.spec.whatwg.org/multipage/dom.html#htmlelement:

Also the description

The autocorrect getter steps are: return true if the element's used autocorrection state is on and false if the element's used autocorrection state is off.

The setter sets the attribute to "on"/"off", which I take this to mean that if you output the doc as HTML you'd see the attribute as the string form.

So Safari correctly returns true/false for the HTMLElement.autocorrect, but incorrectly uses the string 'true", "false" instead of "on"/"off".

estelle · 2024-10-29T01:28:34Z

files/en-us/web/api/htmlelement/index.md

  - : A string that represents the element's capitalization behavior for user input. Valid values are: `none`, `off`, `on`, `characters`, `words`, `sentences`.
 - {{domxref("HTMLElement.autofocus")}}
  - : A boolean value reflecting the [`autofocus`](/en-US/docs/Web/HTML/Element/select#autofocus) HTML global attribute, which indicates whether the control should be focused when the page loads, or when dialog or popover become shown if specified in an element inside {{htmlelement("dialog")}} elements or elements whose popover attribute is set.
+- {{domxref("HTMLElement.autocorrect")}}
+  - : A boolean that represents whether or not text input by a user should be automatically corrected.


Suggested change

- : A boolean that represents whether or not text input by a user should be automatically corrected.

- : A string that represents whether or not text input by a user should be automatically corrected.

only implementation is safari, which incorrectly has values of true/false (instead of on/off).

I don't think so, as per #35692 (comment)

files/en-us/web/html/global_attributes/autocorrect/index.md

Co-authored-by: Estelle Weyl <[email protected]>

files/en-us/web/html/global_attributes/autocorrect/index.md

estelle

Thanks @hamishwillee, and thanks for clearifying the on/off / true/false. That was confusing!

hamishwillee · 2024-11-01T22:39:35Z

Yes, so very confusing! Thanks for the review.

github-actions bot added Content:HTML Hypertext Markup Language docs size/m [PR only] 51-500 LoC changed labels Sep 2, 2024

estelle reviewed Sep 11, 2024

View reviewed changes

files/en-us/web/html/element/input/text/index.md Outdated Show resolved Hide resolved

hamishwillee and others added 4 commits October 22, 2024 14:00

HTML autocorrect attribute

60e09dc

Update files/en-us/web/html/element/input/text/index.md

118bab1

Co-authored-by: Estelle Weyl <[email protected]>

tidy

689f2c0

Add HTMLElement update

0308881

hamishwillee force-pushed the element_autocorrect branch from 2735f40 to 0308881 Compare October 22, 2024 05:22

github-actions bot added Content:WebAPI Web API docs size/l [PR only] 501-1000 LoC changed and removed size/m [PR only] 51-500 LoC changed labels Oct 22, 2024

Improve example

1149859

github-actions bot added size/m [PR only] 51-500 LoC changed and removed size/l [PR only] 501-1000 LoC changed labels Oct 22, 2024

hamishwillee added 2 commits October 22, 2024 17:09

Fix up autocorrect example following testing

10a2f13

Fixup the example for the autocorrect attribute

e4aa1a8

hamishwillee marked this pull request as ready for review October 22, 2024 07:02

hamishwillee requested review from a team as code owners October 22, 2024 07:02

hamishwillee requested review from sideshowbarker and estelle and removed request for a team October 22, 2024 07:02

sideshowbarker removed their request for review October 22, 2024 07:39

estelle reviewed Oct 23, 2024

View reviewed changes

hamishwillee and others added 2 commits October 25, 2024 15:02

Commit easy review suggestions.

c4308d9

Co-authored-by: Estelle Weyl <[email protected]>

Update files/en-us/web/api/htmlelement/autocorrect/index.md

fb6670d

Co-authored-by: Estelle Weyl <[email protected]>

hamishwillee and others added 2 commits October 25, 2024 15:46

DRY example

bb253bc

Update files/en-us/web/api/htmlelement/autocorrect/index.md

0deda46

Co-authored-by: Estelle Weyl <[email protected]>

hamishwillee commented Oct 25, 2024

View reviewed changes

files/en-us/web/html/element/input/email/index.md Outdated Show resolved Hide resolved

hamishwillee commented Oct 25, 2024

View reviewed changes

files/en-us/web/html/element/input/url/index.md Outdated Show resolved Hide resolved

Add note about autocorrect on password, email, url

9d34e48

hamishwillee commented Oct 25, 2024

View reviewed changes

files/en-us/web/html/element/textarea/index.md Outdated Show resolved Hide resolved

hamishwillee commented Oct 25, 2024

View reviewed changes

files/en-us/web/html/element/textarea/index.md Outdated Show resolved Hide resolved

hamishwillee added 3 commits October 25, 2024 16:37

Apply suggestions from code review

a094deb

Update files/en-us/web/html/global_attributes/autocorrect/index.md

5e87ab0

REduce HTMLElement.autocorrect

440e0f8

hamishwillee requested a review from estelle October 25, 2024 05:58

hamishwillee mentioned this pull request Oct 27, 2024

HTMLElement.autocorrect full implementation mdn/browser-compat-data#24834

Merged

estelle reviewed Oct 29, 2024

View reviewed changes

Update files/en-us/web/html/global_attributes/autocorrect/index.md

218ebb0

Co-authored-by: Estelle Weyl <[email protected]>

github-actions bot reviewed Nov 1, 2024

View reviewed changes

remove end tag and prettier

1d3fa43

hamishwillee requested a review from estelle November 1, 2024 00:49

estelle approved these changes Nov 1, 2024

View reviewed changes

estelle merged commit 709d3a5 into mdn:main Nov 1, 2024
8 checks passed

hamishwillee deleted the element_autocorrect branch November 1, 2024 22:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

HTML autocorrect attribute #35692

HTML autocorrect attribute #35692

hamishwillee commented Sep 2, 2024 •

edited

Loading

github-actions bot commented Sep 2, 2024 •

edited

Loading

hamishwillee commented Sep 3, 2024

hamishwillee commented Oct 22, 2024

estelle Oct 22, 2024

hamishwillee Oct 25, 2024

estelle left a comment

estelle Oct 29, 2024

hamishwillee Nov 1, 2024 •

edited

Loading

estelle Oct 29, 2024

hamishwillee Nov 1, 2024

estelle left a comment

hamishwillee commented Nov 1, 2024


		## Value

		`true` if auto-correction is enabled for the element, and `false` otherwise.

-`true` if auto-correction is enabled for the element, and `false` otherwise.
+`on` if auto-correction is enabled for the element, and `off` otherwise.
+>[!NOTE]
+> The Safari implementation returns a Boolean; `true` if auto-correction is enabled for the element, and `false` otherwise.

	- : A boolean that represents whether or not text input by a user should be automatically corrected.
	- : A string that represents whether or not text input by a user should be automatically corrected.

HTML autocorrect attribute #35692

HTML autocorrect attribute #35692

Conversation

hamishwillee commented Sep 2, 2024 • edited Loading

github-actions bot commented Sep 2, 2024 • edited Loading

hamishwillee commented Sep 3, 2024

hamishwillee commented Oct 22, 2024

estelle Oct 22, 2024

Choose a reason for hiding this comment

hamishwillee Oct 25, 2024

Choose a reason for hiding this comment

estelle left a comment

Choose a reason for hiding this comment

estelle Oct 29, 2024

Choose a reason for hiding this comment

hamishwillee Nov 1, 2024 • edited Loading

Choose a reason for hiding this comment

estelle Oct 29, 2024

Choose a reason for hiding this comment

hamishwillee Nov 1, 2024

Choose a reason for hiding this comment

estelle left a comment

Choose a reason for hiding this comment

hamishwillee commented Nov 1, 2024

hamishwillee commented Sep 2, 2024 •

edited

Loading

github-actions bot commented Sep 2, 2024 •

edited

Loading

hamishwillee Nov 1, 2024 •

edited

Loading