KC's Workspace
    Preparing search index...

    Interface CSSModulesOptions

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

    Whether to include global class names in the export.

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

    Pattern or function to generate scoped class names. When using transformer: 'lightningcss', only string patterns are supported.

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

    Callback to receive the generated class name mappings.

    globalModulePaths?: RegExp[]

    File paths matching these patterns will use global scoping.

    hashPrefix?: string

    Prefix added to hashes when generating scoped names.

    localsConvention?: "camelCase" | "camelCaseOnly" | "dashes" | "dashesOnly"

    Transform convention for exported class names.

    scopeBehaviour?: "global" | "local"

    Controls the scoping behavior.

    'local'

    Settings
    Member Visibility

    On This Page
    Properties