useCssModule() — vue Function Reference

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

Function typescript VueCore VDom

Entity Profile

VueCore→ VDom→ useCssModule() — vue Function Reference

Dependency Diagram

graph TD
  6c7bbcce_34bd_bef3_533f_b1a54ab9778f["useCssModule()"]
  ce58cf4d_cc9f_d666_3b1c_eaab6582679e["useCssModule.ts"]
  6c7bbcce_34bd_bef3_533f_b1a54ab9778f -->|defined in| ce58cf4d_cc9f_d666_3b1c_eaab6582679e
  style 6c7bbcce_34bd_bef3_533f_b1a54ab9778f 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
  }
}