Home / Function/ buildCustomContainerUtilityRules() — tailwindcss Function Reference

buildCustomContainerUtilityRules() — tailwindcss Function Reference

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

Entity Profile

Dependency Diagram

graph TD
  bd84428d_2ac4_b86f_d49f_6939ec1e5898["buildCustomContainerUtilityRules()"]
  340330a5_8048_84e2_77ad_8f6da2f8b8d0["container.ts"]
  bd84428d_2ac4_b86f_d49f_6939ec1e5898 -->|defined in| 340330a5_8048_84e2_77ad_8f6da2f8b8d0
  e26bfad3_530e_6523_7463_161205321110["migrateTheme()"]
  e26bfad3_530e_6523_7463_161205321110 -->|calls| bd84428d_2ac4_b86f_d49f_6939ec1e5898
  f59e7dd4_a3cb_6597_a215_767fbff2baf8["registerContainerCompat()"]
  f59e7dd4_a3cb_6597_a215_767fbff2baf8 -->|calls| bd84428d_2ac4_b86f_d49f_6939ec1e5898
  c203f636_607a_d332_b4c5_6a40c108f778["decl()"]
  bd84428d_2ac4_b86f_d49f_6939ec1e5898 -->|calls| c203f636_607a_d332_b4c5_6a40c108f778
  0015fc82_ad3f_130f_e7fe_1e92f2f624a1["compareBreakpoints()"]
  bd84428d_2ac4_b86f_d49f_6939ec1e5898 -->|calls| 0015fc82_ad3f_130f_e7fe_1e92f2f624a1
  f9b19679_c1f0_28d6_4d1a_31a10c52e42d["atRule()"]
  bd84428d_2ac4_b86f_d49f_6939ec1e5898 -->|calls| f9b19679_c1f0_28d6_4d1a_31a10c52e42d
  style bd84428d_2ac4_b86f_d49f_6939ec1e5898 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/tailwindcss/src/compat/container.ts lines 22–120

export function buildCustomContainerUtilityRules(
  {
    center,
    padding,
    screens,
  }: {
    center?: boolean
    padding?: string | {}
    screens?: {}
  },
  designSystem: DesignSystem,
): AstNode[] {
  let rules = []
  let breakpointOverwrites: null | Map<string, AtRule> = null

  if (center) {
    rules.push(decl('margin-inline', 'auto'))
  }

  if (
    typeof padding === 'string' ||
    (typeof padding === 'object' && padding !== null && 'DEFAULT' in padding)
  ) {
    rules.push(
      decl('padding-inline', typeof padding === 'string' ? padding : (padding.DEFAULT as string)),
    )
  }

  if (typeof screens === 'object' && screens !== null) {
    breakpointOverwrites = new Map()

    // When setting the `screens` in v3, you were overwriting the default
    // screens config. To do this in v4, you have to manually unset all core
    // screens.

    let breakpoints = Array.from(designSystem.theme.namespace('--breakpoint').entries())
    breakpoints.sort((a, z) => compareBreakpoints(a[1], z[1], 'asc'))
    if (breakpoints.length > 0) {
      let [key] = breakpoints[0]
      // Unset all default breakpoints
      rules.push(
        atRule('@media', `(width >= --theme(--breakpoint-${key}))`, [decl('max-width', 'none')]),
      )
    }

    for (let [key, value] of Object.entries(screens)) {
      if (typeof value === 'object') {
        if ('min' in value) {
          value = value.min
        } else {
          continue
        }
      }

      // We're inlining the breakpoint values because the screens configured in
      // the `container` option do not have to match the ones defined in the
      // root `screen` setting.
      breakpointOverwrites.set(
        key,
        atRule('@media', `(width >= ${value})`, [decl('max-width', value)]),
      )
    }
  }

  if (typeof padding === 'object' && padding !== null) {
    let breakpoints = Object.entries(padding)
      .filter(([key]) => key !== 'DEFAULT')
      .map(([key, value]) => {
        return [key, designSystem.theme.resolveValue(key, ['--breakpoint']), value]
      })
      .filter(Boolean) as [string, string, string][]
    breakpoints.sort((a, z) => compareBreakpoints(a[1], z[1], 'asc'))

    for (let [key, , value] of breakpoints) {
      if (breakpointOverwrites && breakpointOverwrites.has(key)) {
        let overwrite = breakpointOverwrites.get(key)!
        overwrite.nodes.push(decl('padding-inline', value))
      } else if (breakpointOverwrites) {
        // The breakpoint does not exist in the overwritten breakpoints list, so
        // we skip rendering it.
        continue

Subdomains

Frequently Asked Questions

What does buildCustomContainerUtilityRules() do?
buildCustomContainerUtilityRules() is a function in the tailwindcss codebase, defined in packages/tailwindcss/src/compat/container.ts.
Where is buildCustomContainerUtilityRules() defined?
buildCustomContainerUtilityRules() is defined in packages/tailwindcss/src/compat/container.ts at line 22.
What does buildCustomContainerUtilityRules() call?
buildCustomContainerUtilityRules() calls 3 function(s): atRule, compareBreakpoints, decl.
What calls buildCustomContainerUtilityRules()?
buildCustomContainerUtilityRules() is called by 2 function(s): migrateTheme, registerContainerCompat.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free