useCssModule() — vue Function Reference

Architecture documentation for the useCssModule() function in useCssModule.ts from the vue codebase.

Function typescript CompilerSFC StyleProcessor

Entity Profile

CompilerSFC→ StyleProcessor→ useCssModule() — vue Function Reference

Dependency Diagram

graph TD
  07fb514d_5f4d_b318_4023_a2d958cc1ffe["useCssModule()"]
  9fcee175_ab8d_e74c_35e3_8e0384ff40a2["useCssModule.ts"]
  07fb514d_5f4d_b318_4023_a2d958cc1ffe -->|defined in| 9fcee175_ab8d_e74c_35e3_8e0384ff40a2
  style 07fb514d_5f4d_b318_4023_a2d958cc1ffe fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/v3/sfc-helpers/useCssModule.ts lines 4–24

export function useCssModule(name = '$style'): Record<string, string> {
  /* istanbul ignore else */
  if (!__GLOBAL__) {
    if (!currentInstance) {
      __DEV__ && warn(`useCssModule must be called inside setup()`)
      return emptyObject
    }
    const mod = currentInstance[name]
    if (!mod) {
      __DEV__ &&
        warn(`Current instance does not have CSS module named "${name}".`)
      return emptyObject
    }
    return mod as Record<string, string>
  } else {
    if (__DEV__) {
      warn(`useCssModule() is not supported in the global build.`)
    }
    return emptyObject
  }
}