Now in the year 2021, all you need to do is add a src/Globals.d.ts to your project with these lines:
declare module "*.module.css";
declare module "*.module.scss";
// and so on for whatever flavor of css you're using
Then install and add
{
"compilerOptions": {
"plugins": [{ "name": "typescript-plugin-css-modules" }]
}
}
to your tsconfig.
Example of this correctly functioning in VS code after making that simple change (root is a class defined in my stylesheet):
Webpack and tsc also compile correctly on the command line.
Answer from Matt Wonlaw on Stack Overflow
» npm install typescript-plugin-css-modules
What's the best way to get typescript support for css module imports in next?
TIL there is a typescript plugin for css modules
Typescript + CSS Modules + Rollup
Using CSS Modules with CRA+Typescript
Consider using something like emotion or styled components instead.
More on reddit.comVideos
Now in the year 2021, all you need to do is add a src/Globals.d.ts to your project with these lines:
declare module "*.module.css";
declare module "*.module.scss";
// and so on for whatever flavor of css you're using
Then install and add
{
"compilerOptions": {
"plugins": [{ "name": "typescript-plugin-css-modules" }]
}
}
to your tsconfig.
Example of this correctly functioning in VS code after making that simple change (root is a class defined in my stylesheet):
Webpack and tsc also compile correctly on the command line.
A) As you are saying, there is one simplest (not best) option to use require:
const css = require('./component.css')
- We need to have typings for
requireas it's not standard feature in typescript. Simplest typing for this specific require may be:
declare function require(name: string): string;Webpack will then compile typescript and use modules properly - BUT without any IDE help and class names checks for build.
B) There is better solution to use standard import:
import * as css from './component.css'
- enables full class names IntelliSense
- requires types definition for each css file, otherwise
tsccompiler will fail
For proper IntelliSense, Webpack needs to generate types definition for each css file:
Use webpack typings-for-css-modules-loader
webpackConfig.module.loaders: [ { test: /\.css$/, loader: 'typings-for-css-modules?modules' } { test: /\.scss$/, loader: 'typings-for-css-modules?modules&sass' } ];Loader will generate
*.css.d.tsfiles for each of css files in your codebase- Typescript compiler will understand that css import will be module with properties (class names) of type string.
Mentioned typings-for-css-loader contains a bug and because of types file generation delay, it's best to declare global *.css type in case our *.css.d.ts file is not generated yet.
That little bug scenario:
- Create css file
component.css - Include it in component
import * as css from './component.css' - Run
webpack - Typescript compiler will try to compile code (ERROR)
- Loader will generate Css modules typings file (
component.css.d.ts), but it's late for typescript compiler to find new typings file - Run
webpackagain will fix build error.
Easy fix is to create global definition (eg. file called typings.d.ts in your source root) for importing CSS Modules:
declare module '*.css' {
interface IClassNames {
[className: string]: string
}
const classNames: IClassNames;
export = classNames;
}
This definition will be used if there is no css file generated (eg. you have added new css file). Otherwise will be used generated specific (needs to be in same folder and named same as source file + .d.ts extension), eg. component.css.d.ts definition and IntelliSense will work perfectly.
Example of component.css.d.ts:
export const wrapper: string;
export const button: string;
export const link: string;
And if you don't want to see generated css typings you may setup filter in IDE to hide all files with extension .css.d.ts in your sources.
» npm install @types/css-modules
We use next.js with typescript and css modules, but when we import style objects from a css module that style object just has a type of:
{
readonly [key: string]: string;
}
We'd like to improve on that so we can actually see what classes are supported through the style object and also get additional type safety by having the compiler check if a class exists.
We found a few projects that can do this, one is a typescript plugin that doesn't support compile time errors, but does support IDE hints, and the other one is a webpack plugin that generates typescript declarations for the module files.
I'm curious if anyone has experience adding this kind of functionality on top of next js and what approach works best.
» npm install typed-css-modules
» npm install css-modules-typescript-loader