7

Note: to the best of my knowledge this question is not a duplicate question of the following:


Overview

Given a field that:

  • Has pattern attribute set for validation, for example "[a-f,0-9]{4}" for a 4 character hex string input.
  • Has oninvalid set with setCustomValidity('...some message...') to define a custom validation message
  • Has oninput set with setCustomValidity('') to reset on input

Here is an example showing this:

/* jshint esnext: true */
const form   = document.querySelector("#form");
const field  = document.querySelector("#field");
const output = document.querySelector("#output");

form.addEventListener('submit', (e) => {
  console.log("SUBMIT");
  output.textContent = field.value;
  e.preventDefault(); // Prevent default POST request
});

field.oninvalid = (event) => {
  console.log("INVALID");
  event.target.setCustomValidity('must be valid 4 hex characters');
}

field.oninput = (event) => {
  console.log("INPUT");
  event.target.setCustomValidity('');
}
Output: <span id="output">No output</span>
<form id="form">
  <label for="field">Enter 4 character hex code: </label>
  <input id="field" type="text" pattern="[a-f,0-9]{4}" autocomplete=off>
</form>

Validation works almost as desired, except when the user enters an invalid entry and then proceeds to try and edit it, where their following input states are still invalid:

enter image description here

At this point, neither the custom setCustomValidity message defined in oninvalid is used, nor the empty one defined in onInput.

Instead, as long as the field is in an invalid state and not blurred, the default Please match the requested format. message appears.


Question

What is going on here? Looking at the console, the oninput event is called each time, and therefore event.target.setCustomValidity(''); is called each time.

So why is it that we are still seeing the generic default validation message? Shouldn't setCustomValidity('') disable that?

An acceptable answer here should exhibit the following:

  • The parameter field is respected for validation.
  • Any validation message appears if and only if the user attempts to submit an invalid field and not when they modify the input immediately afterward.
  • The default Please match the requested format. message never appears at all.
Johannes
  • 6,232
  • 9
  • 43
  • 59
  • What browser are you using? I've tested your Bin in Chrome and Safari on a Mac and I cannot reproduce the issue in the animated GIF. The correct message shows and only when the input is invalid – Randy Casburn Apr 08 '18 at 23:51
  • Chrome on Windows: `Version 65.0.3325.181 (Official Build) (64-bit)`. Chances that this is a bug? – Johannes Apr 08 '18 at 23:53
  • Yep. Related? https://stackoverflow.com/questions/49646085/javascript-setcustomvalidity-does-not-work-on-chrome-version-65 – Randy Casburn Apr 08 '18 at 23:57
  • Seems like it, though their issue is slightly different as their recommended workaround (using this pattern attribute) is something I'm already doing. Different use-case, but likely related. – Johannes Apr 08 '18 at 23:59
  • There was a time early on with Chrome on Windows where the custom validation message would not show without a `title` attribute. In case you don't know, you can "title" your custom message in some browsers. Try to add a title to the input and see if that changes things. – Randy Casburn Apr 09 '18 at 00:08
  • Interesting. It appends the title below the default message whenever it shows it. Not what I need here, but good to know! – Johannes Apr 09 '18 at 00:10
  • Yep...file a bug or backport the browser. – Randy Casburn Apr 09 '18 at 00:12
  • Figured out a workaround. removing the `pattern` attribute in `oninput` and re-adding it in `onchange` gives me the desired behavior. – Johannes Apr 09 '18 at 00:19
  • Glad you got it sorted! Awesome. – Randy Casburn Apr 09 '18 at 00:26

2 Answers2

6

It appears that this is a bug with Chrome 65 in windows.

using setCustomValidity('') in oninput should disable the default validation messages appearing on input.

The following workaround works for me:

/* jshint esnext: true */
const form   = document.querySelector("#form");
const field  = document.querySelector("#field");
const output = document.querySelector("#output");

const pattern = field.getAttribute("pattern");

form.addEventListener('submit', (e) => {
  console.log("SUBMIT");
  output.textContent = `User submitted: ${field.value}`;
  e.preventDefault(); // Prevent default POST request
});

field.oninvalid = (event) => {
  console.log("INVALID");
  event.target.setCustomValidity('must be valid 4 hex characters');
}

field.oninput = (event) => {
  console.log("INPUT");
  event.target.setCustomValidity('');
  event.target.removeAttribute("pattern");
}

field.onchange = (event) => {
  console.log("CHANGE");
  event.target.setAttribute("pattern", pattern);
}
  Output: <span id="output">No output</span>
  <form id="form">
    <label for="field">Enter 4 character hex code: </label>
    <input id="field" type="text" pattern="[a-f,0-9]{4}" autocomplete=off>
  </form>
Johannes
  • 6,232
  • 9
  • 43
  • 59
0

setCustomValidity is meant to be used when multiple inputs, in combination are invalid. That is why it has to be reset to the empty string manually after. Other wise the title attribute should be used.

Trying to hide the validation error after editing the input is understandable but it is against the HTML5 form philosophy. It is meant to be shown as long as the input is invalid.

Adding maxlength can help the user to not cross the upper limit.

If you really want your bullet points to be satisfied feel free to not use HTML5 form validation but something custom instead.

So the reason a tooltip is shown even when setCustomValidity is set to empty string is because the input element is still invalid as per pattern attribute.

<form id="form">
  <label for="field">Enter 4 character hex code: </label>
  <input id="field" type="text" pattern="[a-f,0-9]{4}" maxlength="4" minlength="4" autocomplete="off" title="must be valid 4 hex characters">
</form>

JS

const form   = document.querySelector("#form");
const field  = document.querySelector("#field");
const output = document.querySelector("#output");

form.addEventListener('submit', (e) => {
  console.log("SUBMIT");
  output.textContent = field.value;
  e.preventDefault(); // Prevent default POST request
});

field.oninvalid = (event) => {
  console.log("INVALID");
}

field.oninput = (event) => {
  console.log("INPUT");
}
Walle Cyril
  • 3,087
  • 4
  • 23
  • 55