Home / Function/ escape() — tailwindcss Function Reference

escape() — tailwindcss Function Reference

Architecture documentation for the escape() function in escape.ts from the tailwindcss codebase.

Entity Profile

Dependency Diagram

graph TD
  22e232f7_919c_8490_d3d0_2af2fca034d5["escape()"]
  9d0d9b17_966f_d612_352b_4f788e460f5e["candidate()"]
  9d0d9b17_966f_d612_352b_4f788e460f5e -->|calls| 22e232f7_919c_8490_d3d0_2af2fca034d5
  0e91912d_5423_6991_60b0_8afbca30e459["migrateTheme()"]
  0e91912d_5423_6991_60b0_8afbca30e459 -->|calls| 22e232f7_919c_8490_d3d0_2af2fca034d5
  c8623640_b79b_0216_79ed_a099482fb629["removeUnnecessarySpacingKeys()"]
  c8623640_b79b_0216_79ed_a099482fb629 -->|calls| 22e232f7_919c_8490_d3d0_2af2fca034d5
  9508f2e7_ca66_c4bb_0665_b6dc278d127a["replaceNestedClassNameReferences()"]
  9508f2e7_ca66_c4bb_0665_b6dc278d127a -->|calls| 22e232f7_919c_8490_d3d0_2af2fca034d5
  3ea56425_6e9f_0dc3_e68f_304ee638d53d["compileAstNodes()"]
  3ea56425_6e9f_0dc3_e68f_304ee638d53d -->|calls| 22e232f7_919c_8490_d3d0_2af2fca034d5
  26086ff1_0d4f_fdb2_3fc4_d0c999f90a8c["parseCss()"]
  26086ff1_0d4f_fdb2_3fc4_d0c999f90a8c -->|calls| 22e232f7_919c_8490_d3d0_2af2fca034d5
  63d678ab_e176_afe3_714c_c0d55120dc20["themeKey()"]
  63d678ab_e176_afe3_714c_c0d55120dc20 -->|calls| 22e232f7_919c_8490_d3d0_2af2fca034d5
  style 22e232f7_919c_8490_d3d0_2af2fca034d5 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
}

Subdomains

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