registerLegacyUtilities() — tailwindcss Function Reference

Architecture documentation for the registerLegacyUtilities() function in legacy-utilities.ts from the tailwindcss codebase.

Function typescript Oxide Scanner calls 4 called by 1

Entity Profile

Oxide→ Scanner→ registerLegacyUtilities() — tailwindcss Function Reference

Dependency Diagram

graph TD
  f2b46398_1cac_b0f2_946b_db57178a0090["registerLegacyUtilities()"]
  964be968_c10d_edf8_0061_9ac8db9f9935["legacy-utilities.ts"]
  f2b46398_1cac_b0f2_946b_db57178a0090 -->|defined in| 964be968_c10d_edf8_0061_9ac8db9f9935
  5701b75f_30db_85c0_f5db_cc19be325e05["applyCompatibilityHooks()"]
  5701b75f_30db_85c0_f5db_cc19be325e05 -->|calls| f2b46398_1cac_b0f2_946b_db57178a0090
  1369a6dc_e395_347d_5d24_b88e22c5446d["decl()"]
  f2b46398_1cac_b0f2_946b_db57178a0090 -->|calls| 1369a6dc_e395_347d_5d24_b88e22c5446d
  2b202e81_c79a_bf7e_74f9_fe9a98bbea87["isPositiveInteger()"]
  f2b46398_1cac_b0f2_946b_db57178a0090 -->|calls| 2b202e81_c79a_bf7e_74f9_fe9a98bbea87
  c58cbb33_f3cc_0b4f_844a_15bf66a1dc61["segment()"]
  f2b46398_1cac_b0f2_946b_db57178a0090 -->|calls| c58cbb33_f3cc_0b4f_844a_15bf66a1dc61
  09df19e7_0346_145d_40c4_e93ff14a2ff9["isValidSpacingMultiplier()"]
  f2b46398_1cac_b0f2_946b_db57178a0090 -->|calls| 09df19e7_0346_145d_40c4_e93ff14a2ff9
  style f2b46398_1cac_b0f2_946b_db57178a0090 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/tailwindcss/src/compat/legacy-utilities.ts lines 6–179

export function registerLegacyUtilities(designSystem: DesignSystem) {
  for (let [value, direction] of [
    ['t', 'top'],
    ['tr', 'top right'],
    ['r', 'right'],
    ['br', 'bottom right'],
    ['b', 'bottom'],
    ['bl', 'bottom left'],
    ['l', 'left'],
    ['tl', 'top left'],
  ]) {
    designSystem.utilities.suggest(`bg-gradient-to-${value}`, () => [])
    designSystem.utilities.static(`bg-gradient-to-${value}`, () => [
      decl('--tw-gradient-position', `to ${direction} in oklab`),
      decl('background-image', `linear-gradient(var(--tw-gradient-stops))`),
    ])
  }

  // Legacy `background-position` utilities for compatibility with v4.0 and earlier
  designSystem.utilities.suggest('bg-left-top', () => [])
  designSystem.utilities.static('bg-left-top', () => [decl('background-position', 'left top')])
  designSystem.utilities.suggest('bg-right-top', () => [])
  designSystem.utilities.static('bg-right-top', () => [decl('background-position', 'right top')])
  designSystem.utilities.suggest('bg-left-bottom', () => [])
  designSystem.utilities.static('bg-left-bottom', () => [
    decl('background-position', 'left bottom'),
  ])
  designSystem.utilities.suggest('bg-right-bottom', () => [])
  designSystem.utilities.static('bg-right-bottom', () => [
    decl('background-position', 'right bottom'),
  ])

  // Legacy `object-position` utilities for compatibility with v4.0 and earlier
  designSystem.utilities.suggest('object-left-top', () => [])
  designSystem.utilities.static('object-left-top', () => [decl('object-position', 'left top')])
  designSystem.utilities.suggest('object-right-top', () => [])
  designSystem.utilities.static('object-right-top', () => [decl('object-position', 'right top')])
  designSystem.utilities.suggest('object-left-bottom', () => [])
  designSystem.utilities.static('object-left-bottom', () => [
    decl('object-position', 'left bottom'),
  ])
  designSystem.utilities.suggest('object-right-bottom', () => [])
  designSystem.utilities.static('object-right-bottom', () => [
    decl('object-position', 'right bottom'),
  ])

  designSystem.utilities.suggest('max-w-screen', () => [])
  designSystem.utilities.functional('max-w-screen', (candidate) => {
    if (!candidate.value) return
    if (candidate.value.kind === 'arbitrary') return
    let value = designSystem.theme.resolve(candidate.value.value, ['--breakpoint'])
    if (!value) return
    return [decl('max-width', value)]
  })

  designSystem.utilities.suggest('overflow-ellipsis', () => [])
  designSystem.utilities.static(`overflow-ellipsis`, () => [decl('text-overflow', `ellipsis`)])

  designSystem.utilities.suggest('decoration-slice', () => [])
  designSystem.utilities.static(`decoration-slice`, () => [
    decl('-webkit-box-decoration-break', `slice`),
    decl('box-decoration-break', `slice`),
  ])

  designSystem.utilities.suggest('decoration-clone', () => [])
  designSystem.utilities.static(`decoration-clone`, () => [
    decl('-webkit-box-decoration-break', `clone`),
    decl('box-decoration-break', `clone`),
  ])

  designSystem.utilities.suggest('flex-shrink', () => [])
  designSystem.utilities.functional('flex-shrink', (candidate) => {
    if (candidate.modifier) return

    if (!candidate.value) {
      return [decl('flex-shrink', '1')]
    }

    if (candidate.value.kind === 'arbitrary') {
      return [decl('flex-shrink', candidate.value.value)]
    }