Interface CSSModulesOptions

interface CSSModulesOptions {
    exportGlobals?: boolean;
    generateScopedName?: string | ((name, filename, css) => string);
    getJSON?: ((cssFileName, json, outputFileName) => void);
    globalModulePaths?: RegExp[];
    hashPrefix?: string;
    localsConvention?: "camelCase" | "camelCaseOnly" | "dashes" | "dashesOnly" | ((originalClassName, generatedClassName, inputFile) => string);
    scopeBehaviour?: "local" | "global";
}

Properties

exportGlobals? generateScopedName? getJSON? globalModulePaths? hashPrefix? localsConvention? scopeBehaviour?

Properties

Optional exportGlobals

exportGlobals?: boolean

Optional generateScopedName

generateScopedName?: string | ((name, filename, css) => string)

Type declaration

    • (name, filename, css): string

    • Parameters

      • name: string
      • filename: string
      • css: string

      Returns string

Optional getJSON

getJSON?: ((cssFileName, json, outputFileName) => void)

Type declaration

    • (cssFileName, json, outputFileName): void

    • Parameters

      • cssFileName: string
      • json: Record<string, string>
      • outputFileName: string

      Returns void

Optional globalModulePaths

globalModulePaths?: RegExp[]

Optional hashPrefix

hashPrefix?: string

Optional localsConvention

localsConvention?: "camelCase" | "camelCaseOnly" | "dashes" | "dashesOnly" | ((originalClassName, generatedClassName, inputFile) => string)

default: undefined

Type declaration

    • (originalClassName, generatedClassName, inputFile): string

    • Parameters

      • originalClassName: string
      • generatedClassName: string
      • inputFile: string

      Returns string

Optional scopeBehaviour

scopeBehaviour?: "local" | "global"

Settings

Member Visibility

Theme

On This Page

exportGlobalsgenerateScopedNamegetJSONglobalModulePathshashPrefixlocalsConventionscopeBehaviour