用神奇的 form 验证 API 来优化你的表单验证

前言

鱼头曾在 『极限版』不掺水,用纯 CSS 来实现超飒的表单验证功能 一文中分享过一个花里胡哨的 纯 CSS 的表单验证功能 。虽然仅仅依赖 CSS 是无法满足我们的日常开发需求的,但是配合着各种原生的 form 验证 API ,情况又不一样了。

下面就让我们来了解一下 。

相关的 API

ValidityState

每一个原生的表单组件都会有一个用于描述元素的验证状态的对象 —— ValidityState

代码如下:

账号:<input data-title="账号" placeholder="请输入正确的账号" pattern="\w{6,10}" name="account" type="text" required  id="input-text" />
<script>
  'use strict';
  const inputText = document.querySelector('#input-text');
  inputText.addEventListener('input', event => {
    console.table(inputText.validity);
  });
</script>

输出如下:

具体属性如下:

属性可选值说明
valueMissing(只读)true / false当表单元素设置了 required 属性,且 value 为空时则为 true ,否则为 false 。此属性关联伪类 :valid / :invalid
typeMismatch(只读)true / false当表单元素输入的值与类型不匹配时为 true ,否则为 false 。此属性关联伪类 :valid / :invalid
patternMismatch(只读)true / false当表单元素输入的值与 pattern 属性的规则不匹配时为 true ,否则为 false 。此属性关联伪类 :valid / :invalid
tooLong(只读)true / false当表单元素输入的值长度超过 maxlength 属性时 为 true ,否则为 false 。此属性关联伪类 :valid / :invalid
tooShort(只读)true / false当表单元素输入的值长度少于 minlength 属性时 为 true ,否则为 false 。此属性关联伪类 :valid / :invalid 以及 :in-range / :out-of-range
rangeUnderflow(只读)true / false当表单元素输入的值少于 min 属性时 为 true ,否则为 false 。此属性关联伪类 :valid / :invalid 以及 :in-range / :out-of-range
rangeOverflow(只读)true / false当表单元素输入的值大于 max 属性时 为 true ,否则为 false 。此属性关联伪类 :valid / :invalid 以及 :in-range / :out-of-range
stepMismatch(只读)true / false当表单元素输入的值与 step 的值不匹配 时为 true ,否则为 false 。此属性关联伪类 :valid / :invalid 以及 :in-range / :out-of-range
badInput(只读)true / false当表单元素输入的值不完整且 UA 认为当前状态的表单不应该被提交时为 true,否则为 false
customError(只读)true / false当表单元素的错误信息是由 setCustomValidity() 方法调用展示时为 true,否则为 false
valid(只读)true / false当表单元素验证通过时为 true ,否则为 false 。此属性关联伪类 :valid / :invalid

validationMessage

当表单元素验证正确时则返回 '',否则则返回默认或者经由setCustomValidity() 方法设置的错误信息。

效果如下:

代码如下:

账号:<input data-title="账号" placeholder="请输入正确的账号" pattern="\w{6,10}" name="account" type="text" required  id="input-text" />
<script>
    'use strict';
    const inputText = document.querySelector('#input-text');
    inputText.addEventListener('input', event => {
      console.table(inputText.validationMessage); // 验证错误时则返回 “请与所请求的格式保持一致。”
    });
</script>

willValidate

一个只读属性,当表单元素需要验证时返回 true ,否则则为 false

效果如下:

代码如下:

账号:<input data-title="账号" placeholder="请输入正确的账号" pattern="\w{6,10}" name="account" type="text" required  id="input-text" />
<script>
    'use strict';
    const inputText = document.querySelector('#input-text');
    inputText.addEventListener('input', event => {
      console.table(inputText.willValidate); // true
    });
</script>

setCustomValidity()

setCustomValidity() 用于设置表单元素 validationMessage 的值。当设置 setCustomValidity() 之后,validity.customError 就会变成 true 。如果需要重置,则输入空字符串即可。

我们看看效果图:

代码如下:

<form class="form" id="form" method="get" action="/api/form">
      账号:
    <input id="account" data-title="账号" placeholder="请输入正确的账号" pattern="\w{6,10}" name="account" type="text" required />
    <input id="submit" name="button" type="submit" value="提交" />
</form>

<script>
    'use strict';
    account.setCustomValidity('自定义错误!');
    form.addEventListener('submit', event => {
          event.preventDefault();
    });
</script>

checkValidity()

checkValidity() 用于检查当前表单元素或整个表单的值是否通过验证,如果是则为 true,否则则为 false

效果如下:

代码如下:

账号:<input data-title="账号" placeholder="请输入正确的账号" pattern="\w{6,10}" name="account" type="text" required  id="input-text" />
<script>
    'use strict';
    const inputText = document.querySelector('#input-text');
    inputText.addEventListener('input', event => {
          console.table(inputText.checkValidity());
    });
</script>

reportValidity()

reportValidity() 用于触发以及检查表单元素的值是否通过验证,如果是则为 true,否则则为 false

效果如下:

代码如下:

账号:<input data-title="账号" placeholder="请输入正确的账号" pattern="\w{6,10}" name="account" type="text" required  id="input-text" />
<script>
    'use strict';
    const inputText = document.querySelector('#input-text');
    console.log(inputText.reportValidity());
</script>

以上 API 兼容性如下:

图片来自:https://caniuse.com/constrain...

一个简单的 form 提交例子

我们看效果:

代码如下:

<style>
    .form > input {
          margin-bottom: 10px;
    }
</style>
<form class="form" id="form" method="get" action="/api/form">
    账号:
    <input id="account" data-message="请输入正确的账号" data-title="账号" placeholder="请输入正确的账号" pattern="\w{6,10}" name="account" type="text" required />
    <br />
    密码:
    <input id="password" data-message="请输入正确的密码" data-title="密码" placeholder="请输入正确的密码" pattern="\w{6,10}" name="password" type="password" required />
    <br />
    <input id="submit" name="button" type="submit" value="提交" />
</form>
<script>
  'use strict';
  const inputs = [account, password];
  inputs.forEach(input => {
      input.addEventListener('input', () => {
          input.setCustomValidity('');
          input.checkValidity();
      });
      input.addEventListener('invalid', event => {
          const { message } = event.target.dataset;
          const { validity: { valid } } = input;
          input.setCustomValidity('');
          if (!valid) {
                input.setCustomValidity(message);
          };
      });
  });
</script>

以上例子可以在鱼头的 Codepenhttps://codepen.io/krischan77... 上查看。

鱼头注:Mmmmm,功能倒是挺好的,如果不是原生的组件样式太丑,不同浏览器的表现不一致,而且样式还不能修改,我想用原生 API 开发的人应该会很多。。。搞不懂为啥 W3C 不暴露出样式修改的属性。。。

参考资料

  1. 『极限版』不掺水,用纯 CSS 来实现超飒的表单验证功能
  2. 『真香警告』这33个超级好用的CSS选择器,你可能见都没见过。
  3. form-control-infrastructure
  4. ValidityState
  5. HTMLFormElement
  6. Constraint validation API

鱼头的Web海洋
鱼头的Web海洋

Kris不只是一只鱼头

959 声望
3.1k 粉丝
0 条评论
推荐阅读
单文件组件下的vue,可以擦出怎样的火花
与时俱进吧,看着 vue3 和 vite,虽然不会用,但还是心痒痒,然后就把原先基于 vue@2 的实现做了重构。不周之处,大家见谅!下面关于过期的内容,我就用删除线标记了。

leftstick64阅读 45.1k评论 18

从零搭建 Node.js 企业级 Web 服务器(零):静态服务
过去 5 年,我前后在菜鸟网络和蚂蚁金服做开发工作,一方面支撑业务团队开发各类业务系统,另一方面在自己的技术团队做基础技术建设。期间借着 Node.js 的锋芒做了不少 Web 系统,有的至今生气蓬勃、有的早已夭折...

乌柏木140阅读 11.9k评论 10

从零搭建 Node.js 企业级 Web 服务器(十五):总结与展望
总结截止到本章 “从零搭建 Node.js 企业级 Web 服务器” 主题共计 16 章内容就更新完毕了,回顾第零章曾写道:搭建一个 Node.js 企业级 Web 服务器并非难事,只是必须做好几个关键事项这几件必须做好的关键事项就...

乌柏木60阅读 5.9k评论 16

再也不学AJAX了!(二)使用AJAX ① XMLHttpRequest
「再也不学 AJAX 了」是一个以 AJAX 为主题的系列文章,希望读者通过阅读本系列文章,能够对 AJAX 技术有更加深入的认识和理解,从此能够再也不用专门学习 AJAX。本篇文章为该系列的第二篇,最近更新于 2023 年 1...

libinfs39阅读 6.1k评论 12

封面图
从零搭建 Node.js 企业级 Web 服务器(一):接口与分层
分层规范从本章起,正式进入企业级 Web 服务器核心内容。通常,一块完整的业务逻辑是由视图层、控制层、服务层、模型层共同定义与实现的,如下图:从上至下,抽象层次逐渐加深。从下至上,业务细节逐渐清晰。视图...

乌柏木39阅读 7k评论 6

CSS 绘制一只思否猫
欢迎关注我的公众号:前端侦探练习 CSS 有一个比较有趣的方式,就是发挥想象,绘制各式各样的图案,比如来绘制一只思否猫?思否猫,SegmentFault 思否的吉祥物,是一只独一无二、特立独行、热爱自由的(&gt;^ω^&lt...

XboxYan41阅读 2.8k评论 14

封面图
还在用 JS 做节流吗?CSS 也可以防止按钮重复点击
举个例子:一个保存按钮,为了避免重复提交或者服务器考虑,往往需要对点击行为做一定的限制,比如只允许每300ms提交一次,这时候我想大部分同学都会到网上直接拷贝一段throttle函数,或者直接引用lodash工具库

XboxYan34阅读 2.2k评论 2

封面图

Kris不只是一只鱼头

959 声望
3.1k 粉丝
宣传栏