如何在JavaScript中转义CSS选择器

注：本文为译文，原为How to escape CSS selectors in JavaScript，发布于2023年9月22日。个别段落翻译不通顺的地方有删减，但是不影响表达整体含义，感兴趣的读者可以阅读英文原文。

这里有一个棘手的问题: 如何在 JavaScript 中选择以下 HTML 元素？

<div id="#">Select me!</div>

奇怪的是，这个元素的 id 是一个 # 。但是据我所知，即使它不常见，它仍然是一个完全有效的 HTML 属性。那么，如何查询这个元素呢？

您肯定可以使用这个优秀的document.getElementById () ...

console.log(document.getElementById('#')); // <div id="#">...

这样好使，但是我很少使用 getElementById，因为它限制了我只能通过 id 选择元素！

另一方面，querySelector 则更加灵活，允许使用 CSS 选择器查询任何 DOM 元素。

但是你能通过一个 CSS 选择器使用 querySelector 来选择这个“ hash id 元素”吗？事实证明你不能：

console.log(document.querySelector('##'));
// SyntaxError: Document.querySelector: '##' is not a valid selector

不幸的是，"##"不是一个有效的 CSS 选择器，我听到您说，“加油 Stefan，转义第二个 # 就可以了!”没错，转义 # 字符是有效的。

console.log(document.querySelector('#\#')); // <div id="#">...

但是，当您想要查询 DOM 元素时，您知道需要转义的所有字符吗？当用于查询 DOM 元素时，大量有效的 HTML 属性字符串将引发异常。

document.querySelector('.a:b');     // throws because of the `:`
document.querySelector('[href=@]'); // throws because of the `@`
document.querySelector('.[jooo]');  // throws because of the `[]`

手动转义字符并不是一个万无一失的解决方案，但是今天我了解到在 CSS JavaScript 命名空间中有一个方便的静态方法可以帮助解决这个问题ーー CSS.escape ()。

escape ()允许您安全地使用包含任何属性值的HTML 。

console.log(`.${CSS.escape('a:b')}`);      // ".a:b"
console.log(`[href=${CSS.escape('@')}]`); // "[href=@]"
console.log(`.${CSS.escape('[jooo]')}`);  // ".[jooo]"

真是太好了！

您可能想知道处理这些不寻常的属性值的频率。举个例子，React 中的useId 钩子的返回值作为id属性的话，那么将是一个无效值，此时就可以使用用转移。这算是一个例子子了，我赶说肯定还有很多！