HTML attribute: pattern

pattern 属性规定了一个表单控件的值应该匹配的 正则表达式。 如果一个非 null 值不满足 pattern 值设置的约束,ValidityState 对象的只读 patternMismatch (en-US) 属性将为真。

pattern 属性是 text, tel, email, url, passwordsearch 等输入类型的属性。

pattern 属性被定义为一个正则表达式,输入的 value 必须与之匹配,以便该值能够通过 约束验证 (en-US)。它必须是一个有效的 JavaScript 正则表达式,如 RegExp 类型,并且如同我们的 正则表达式指南 中所述:在编译正则表达式时指定 'u' 标志,以便将该模式作为 Unicode,而不是 ASCII。模式文本周围不应指定正斜杠。

如果没有指定模式或无效,则不应用正则表达式,此属性被忽略。

注意: 请使用 title 属性来指定大多数浏览器将作为工具提示显示的文本,以解释匹配该模式的要求是什么。你 不能 仅仅依靠工具提示来进行解释。关于可用性的更多信息见下文。

一些支持 pattern 属性的输入类型,特别是 emailurl,有必须匹配的预期值语法。如果 pattern 属性不存在,并且值不符合该值类型的预期语法, ValidityState 对象的只读 typeMismatch (en-US) 属性将为真。

可用性

当包括一个 pattern 时,在控件附近的可见文本中提供对模式的描述。此外,包括一个 title 属性,对该模式进行描述。用户代理可以在约束验证期间使用标题内容来告诉用户该模式不匹配。一些浏览器会显示标题内容的工具提示,以提高视力障碍者的可用性。此外,当控件获得焦点时,辅助技术可能会大声朗读标题,但这不应该是无障碍的依据。

约束验证

如果输入的值不是空字符串,并且该值与整个正则表达式不匹配,那么 ValidityState 对象的 patternMismatch (en-US) 属性为真,就会出现违反约束条件的现象。

模式的正则表达式在与值匹配时,其开始部分必须确定在字符串的开始部分,其结束部分必须确定在字符串的结束部分,这与 JavaScript 正则表达式略有不同:在模式属性的情况下,我们是与整个字符串匹配,而不仅仅是任何子集,就像在模式的开始部分隐含一个 ^(? :,而在结束部分隐含 )$

例子

匹配一个电话号

考虑到以下情况:

<p>
 <label>输入如下格式的电话号 (123) - 456 - 7890
  (<input name="tel1" type="tel" pattern="[0-9]{3}" placeholder="###" aria-label="3-digit area code" size="2"/>) -
   <input name="tel2" type="tel" pattern="[0-9]{3}" placeholder="###" aria-label="3-digit prefix" size="2"/> -
   <input name="tel3" type="tel" pattern="[0-9]{4}" placeholder="####" aria-label="4-digit number" size="3"/>
 </label>
</p>

在这里,我们有 3 个部分,用于一个北美的电话号码,其隐含的标签包含了电话号码的所有三个组成部分,分别期望 3 位数、3 位数和 4 位数,这是由 pattern 属性设定的。

如果数值太长或太短,或包含不是数字的字符,patternMismatch 将为真。当真时,该元素与 :invalid CSS 伪类匹配。

input:invalid {
  border: red solid 3px;
}

如果我们用 minlength (en-US)maxlength (en-US) 属性代替,我们可能会看到 validityState.tooLong (en-US)validityState.tooShort (en-US) 为真。

指定一种模式

你可以使用 pattern 属性来指定一个正则表达式,输入的值必须与之匹配,才能被视为有效(参见 根据正则表达式进行验证)了解关于使用正则表达式来验证输入的简单速成课程)。

下面的例子将该值限制为 4-8 个字符,并要求它只包含小写字母。

<form>
  <div>
    <label for="uname">选择一个用户名:</label>
    <input type="text" id="uname" name="name" required size="45"
           pattern="[a-z]{4,8}" title="4 到 8 个小写字母">
    <span class="validity"></span>
    <p>用户名必须为小写字母,且长度为 4-8 个字符</p>
  </div>
  <div>
    <button>提交</button>
  </div>
</form>

这将渲染为如下形式:

无障碍注意事项

当一个控件有一个 pattern 属性时,如果使用 title 属性,则必须用于描述该模式。依靠 title 属性来显示文本内容通常是不可取的,因为许多用户代理并不以可访问的方式暴露该属性。一些浏览器在悬停带有标题的元素时显示工具提示,但这就排除了只用键盘和只用触摸的用户。这就是你必须包括告知用户如何填写控件以符合要求的几个原因之一。

虽然 title 被一些浏览器用来填充错误信息,但由于浏览器有时也会在悬停时将标题显示为文本,因此在非错误情况下也会显示,所以要注意不要将标题写成发生了错误的样子。

规范

Specification
HTML Standard
# attr-input-pattern

浏览器兼容性

BCD tables only load in the browser

参见