escape() — tailwindcss Function Reference
Architecture documentation for the escape() function in escape.ts from the tailwindcss codebase.
Entity Profile
Dependency Diagram
graph TD 7cf1fe2b_69a4_05dc_ae13_d3eebe4e10fc["escape()"] 12e584d2_c81a_6aa5_eed4_a926c30c0773["candidate()"] 12e584d2_c81a_6aa5_eed4_a926c30c0773 -->|calls| 7cf1fe2b_69a4_05dc_ae13_d3eebe4e10fc 77d1d37f_6021_dc8c_6d04_0c3b07e3ad19["migrateTheme()"] 77d1d37f_6021_dc8c_6d04_0c3b07e3ad19 -->|calls| 7cf1fe2b_69a4_05dc_ae13_d3eebe4e10fc abaa1198_ca17_6d7e_fe6d_a70c79ad1e3f["removeUnnecessarySpacingKeys()"] abaa1198_ca17_6d7e_fe6d_a70c79ad1e3f -->|calls| 7cf1fe2b_69a4_05dc_ae13_d3eebe4e10fc 387b2b72_8509_7339_6444_0aa98e0581bb["replaceNestedClassNameReferences()"] 387b2b72_8509_7339_6444_0aa98e0581bb -->|calls| 7cf1fe2b_69a4_05dc_ae13_d3eebe4e10fc 70b7448d_fd76_0d4b_e635_18f49f8ba1d6["compileAstNodes()"] 70b7448d_fd76_0d4b_e635_18f49f8ba1d6 -->|calls| 7cf1fe2b_69a4_05dc_ae13_d3eebe4e10fc 95cb326e_6b59_0903_0c96_d221fca5c2b1["parseCss()"] 95cb326e_6b59_0903_0c96_d221fca5c2b1 -->|calls| 7cf1fe2b_69a4_05dc_ae13_d3eebe4e10fc b919f693_c5ab_4ea4_053f_8f9a39ca4199["themeKey()"] b919f693_c5ab_4ea4_053f_8f9a39ca4199 -->|calls| 7cf1fe2b_69a4_05dc_ae13_d3eebe4e10fc style 7cf1fe2b_69a4_05dc_ae13_d3eebe4e10fc fill:#6366f1,stroke:#818cf8,color:#fff
Relationship Graph
Source Code
packages/tailwindcss/src/utils/escape.ts lines 2–73
export function escape(value: string) {
if (arguments.length === 0) {
throw new TypeError('`CSS.escape` requires an argument.')
}
let string = String(value)
let length = string.length
let index = -1
let codeUnit: number
let result = ''
let firstCodeUnit = string.charCodeAt(0)
if (
// If the character is the first character and is a `-` (U+002D), and
// there is no second character, […]
length === 1 &&
firstCodeUnit === 0x002d
) {
return '\\' + string
}
while (++index < length) {
codeUnit = string.charCodeAt(index)
// Note: there’s no need to special-case astral symbols, surrogate
// pairs, or lone surrogates.
// If the character is NULL (U+0000), then the REPLACEMENT CHARACTER
// (U+FFFD).
if (codeUnit === 0x0000) {
result += '\uFFFD'
continue
}
if (
// If the character is in the range [\1-\1F] (U+0001 to U+001F) or is
// U+007F, […]
(codeUnit >= 0x0001 && codeUnit <= 0x001f) ||
codeUnit === 0x007f ||
// If the character is the first character and is in the range [0-9]
// (U+0030 to U+0039), […]
(index === 0 && codeUnit >= 0x0030 && codeUnit <= 0x0039) ||
// If the character is the second character and is in the range [0-9]
// (U+0030 to U+0039) and the first character is a `-` (U+002D), […]
(index === 1 && codeUnit >= 0x0030 && codeUnit <= 0x0039 && firstCodeUnit === 0x002d)
) {
// https://drafts.csswg.org/cssom/#escape-a-character-as-code-point
result += '\\' + codeUnit.toString(16) + ' '
continue
}
// If the character is not handled by one of the above rules and is
// greater than or equal to U+0080, is `-` (U+002D) or `_` (U+005F), or
// is in one of the ranges [0-9] (U+0030 to U+0039), [A-Z] (U+0041 to
// U+005A), or [a-z] (U+0061 to U+007A), […]
if (
codeUnit >= 0x0080 ||
codeUnit === 0x002d ||
codeUnit === 0x005f ||
(codeUnit >= 0x0030 && codeUnit <= 0x0039) ||
(codeUnit >= 0x0041 && codeUnit <= 0x005a) ||
(codeUnit >= 0x0061 && codeUnit <= 0x007a)
) {
// the character itself
result += string.charAt(index)
continue
}
// Otherwise, the escaped character.
// https://drafts.csswg.org/cssom/#escape-a-character
result += '\\' + string.charAt(index)
}
return result
}
Domain
Subdomains
Called By
Source
Frequently Asked Questions
What does escape() do?
escape() is a function in the tailwindcss codebase.
What calls escape()?
escape() is called by 7 function(s): candidate, compileAstNodes, migrateTheme, parseCss, removeUnnecessarySpacingKeys, replaceNestedClassNameReferences, themeKey.
Analyze Your Own Codebase
Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.
Try Supermodel Free