Importing images in TypeScript React - "Cannot find module"
ReactjsTypescriptVisual Studio-CodeBundlerParceljsReactjs Problem Overview
I am trying to import images to use inside a React component with TypeScript. The bundler I'm using is Parcel (not Webpack).
I have created a .d.ts
file inside the project with the image file extension, and included it inside tsconfig.json
. However, when I try to import an image, TS yells at me about Cannot find module
.
My project structure:
+ src
+ assets
- image.jpg
+ components
- Box.tsx
- App.tsx
- index.d.ts
- index.html
- index.tsx
- tsconfig.json
- tslint.json
I tried to import the image in App.tsx
like this. VS Code underlined '../assets/image.jpg'
and said Cannot find module '../assets/image.jpg'
.
import * as React from 'react';
import * as img from '../assets/image.jpg';
const Box = props => {
// do things...
}
export default Box;
The discussions I found online point to the need of defining a .d.ts
file myself, so I created that index.d.ts
file with this line.
declare module '*.jpg';
Then added "include": ["./src/index.d.ts"]
inside tsconfig.json
, after "compilerOptions" : {...}
.
What did I miss? How can I fix the error TS is throwing?
Reactjs Solutions
Solution 1 - Reactjs
create index.d.ts
file in folder src
,and add this line
declare module '*.jpg';
Solution 2 - Reactjs
If you literally wrote "include": ["./src/index.d.ts"]
in tsconfig.json
and you don't have a "files"
setting, that means the project defined by tsconfig.json
includes only the single file ./src/index.d.ts
. When you open any other file in VS Code, VS Code uses a separate language service instance that doesn't use your tsconfig.json
. Adjust your "include"
setting to match all the .ts
and .tsx
files in your project, or just delete it and rely on the default behavior of including all files under the directory containing tsconfig.json
.
Round 2
TypeScript is ignoring index.d.ts
because it assumes that index.d.ts
is generated from index.tsx
and index.tsx
is more likely to be up to date. Name your index.d.ts
file something else, e.g., declaration.d.ts
.
Solution 3 - Reactjs
Create module/type
# src/types/images.d.ts
declare module '*.jpg';
declare module '*.jpeg';
Change tsconfig.json
{
"compilerOptions": {
"typeRoots" : ["node_modules/@types", "src/types"]
}
}
Solution 4 - Reactjs
there is a work around to it for example,
import logo from "../../assets/logo.png"
change this to
const logo = require("../../assets/logo.png")
Solution 5 - Reactjs
This took me about an hour so I'm going to leave the solution that worked for me.
Matt McCutchen's solution half-worked for me, but I was still facing a VSCode error. To combat this, I moved my tsconfig.json and index.d.ts to the root directory, NOT the src. Now you want your tsconfig.json to look like this:
"include": ["src", "index.d.ts"]
And for your index.d.ts, this:
declare module '*.png';
declare module '*.jpg';
(^ tweak to your typing needs)
Solution 6 - Reactjs
There should be a file called "react-app-env.d.ts" that is created when you use create-react-app. This file classes all types of image files and many more as modules that can be imported. inside the file there should be the following:
/// <reference types="react-scripts" />
Solution 7 - Reactjs
I've pasted:
/// <reference types="react-scripts" />
from an older project in my: react-app-env.d.ts
and it worked.
In the latest versions of CRA
(when TS
is the chosen language), this file is automatically added to the src folder and contains the single line shown above. It is a directive to reference types from react-scripts
.
Solution 8 - Reactjs
This is worked for me
declare module "*.png" {
const src: string
export default src
}
Solution 9 - Reactjs
I declared multiple image types, and had to put them in separate .d.ts files to make VS Code happy:
src/types/image.jpg.d.ts:
declare module '*.jpg' {
import { ImageSourcePropType } from 'react-native'
const content: ImageSourcePropType
export default content
}
src/types/image.png.d.ts:
declare module '*.png' {
import { ImageSourcePropType } from 'react-native'
const content: ImageSourcePropType
export default content
}
src/types/image.svg.d.ts:
declare module '*.svg' {
import React from 'react'
import { SvgProps } from 'react-native-svg'
const content: React.FC<SvgProps>
export default content
}
No tweaks to tsconfig, etc required.
Solution 10 - Reactjs
This error happens when you not included react-app-env.d.ts file in your src folder
becoz you need two line of code for get rid of this error ==>
<reference types="react-scripts" />
Solution 11 - Reactjs
Create a global.d.ts file inside your src directory or any rootDir
declare module "*.png" {
export default "" as string
}
This will make use of an asset, in this case png image and also clear a vscode error