getClassOrder() — tailwindcss Function Reference

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

Function typescript Oxide PreProcessors calls 1 called by 1

Entity Profile

Oxide→ PreProcessors→ getClassOrder() — tailwindcss Function Reference

Dependency Diagram

graph TD
  da2d4fa4_738d_c7f2_6941_85df06fd5f32["getClassOrder()"]
  e328ae01_a9d9_2f37_36fd_43da9fe10599["sort.ts"]
  da2d4fa4_738d_c7f2_6941_85df06fd5f32 -->|defined in| e328ae01_a9d9_2f37_36fd_43da9fe10599
  e557c8a4_bb27_ee44_c462_9e238157ad04["buildDesignSystem()"]
  e557c8a4_bb27_ee44_c462_9e238157ad04 -->|calls| da2d4fa4_738d_c7f2_6941_85df06fd5f32
  ad08c258_e5c2_4cd4_c935_0925a940458e["compileCandidates()"]
  da2d4fa4_738d_c7f2_6941_85df06fd5f32 -->|calls| ad08c258_e5c2_4cd4_c935_0925a940458e
  style da2d4fa4_738d_c7f2_6941_85df06fd5f32 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/tailwindcss/src/sort.ts lines 4–30

export function getClassOrder(design: DesignSystem, classes: string[]): [string, bigint | null][] {
  // Generate a sorted AST
  let { astNodes, nodeSorting } = compileCandidates(Array.from(classes), design)

  // Map class names to their order in the AST
  // `null` indicates a non-Tailwind class
  let sorted = new Map<string, bigint | null>(classes.map((className) => [className, null]))

  // Assign each class a unique, sorted number
  let idx = 0n

  for (let node of astNodes) {
    let candidate = nodeSorting.get(node)?.candidate
    if (!candidate) continue

    // When multiple rules match a candidate
    // always take the position of the first one
    sorted.set(candidate, sorted.get(candidate) ?? idx++)
  }

  // Pair classes with their assigned sorting number
  return classes.map((className) => [
    //
    className,
    sorted.get(className) ?? null,
  ])
}