# vite + react + typescript에서 svg를 React 컴포넌트로 import하는 방법

> svg를 컴포넌트로 쓰려고 import하면 Cannot find module ... or its corresponding type declarations(ts2307)가 난다. vite-plugin-svgr 설치만으로는 부족하고 타입 선언까지 갖춰야 하는 이유와, 쿼리 접미사 대소문자가 왜 중요한지 정리한다.

- Source: https://jiny-log.vercel.app/ko/posts/vite-react-typescript-svg-import
- Markdown: https://jiny-log.vercel.app/posts/ko/vite-react-typescript-svg-import.md
- Published: 2024-09-09
- Category: troubleshooting
- Tags: vite, react, typescript, svg, svgr, troubleshooting
- Language: ko

**TL;DR** vite-plugin-svgr를 설치해 vite.config.ts의 plugins에 svgr()를 추가하고, vite-env.d.ts에 vite-plugin-svgr/client 타입 참조를 넣어야 한다. 그래도 ts2307이 남으면 *.svg?react 모듈 선언을 직접 만든다. 접미사는 소문자 ?react 여야 하며 ?React로 쓰면 플러그인이 잡지 못한다. 선언 파일을 src 밖에 두면 tsconfig의 include에 경로를 추가해야 한다.

---
현재 진행하는 프로젝트에서 소셜 로그인의 svg 파일을 넣고 싶은데 계속 아래와 같은 에러가 났다.

![VS Code에서 GoogleImg를 ../image/GoogleImg.svg?React 경로로 import한 줄에 빨간 밑줄이 그려지고, Cannot find module '../image/GoogleImg.svg?React' or its corresponding type declarations. ts(2307) 툴팁이 표시된 화면](/images/vite-react-typescript-svg-import/01.png)

`import` 경로를 ...svg?react 로 변경해봐도 같은 에러가 나서 처음부터 천천히 다시 해보기로 한다.

참고
https://www.npmjs.com/package/vite-plugin-svgr


## 1. vite-plugin-svgr 설치
```bash
# npm
npm install --save-dev vite-plugin-svgr
```

## 2. `vite-env.d.ts` 파일에 `reference types` 추가
`vite-env.d.ts`
```typescript
/// <reference types="vite-plugin-svgr/client" />
```

## 3. `vite.config.ts` plugins 에 svgr() 추가
`vite.config.ts`
```typescript
import { defineConfig } from "vite";
import react from "@vitejs/plugin-react";
import svgr from "vite-plugin-svgr";

// https://vitejs.dev/config/
export default defineConfig({
  plugins: [react(), svgr()],
});
```

## 4. `svg.d.ts` 파일 작성
`svg.d.ts`
```typescript
declare module "*.svg?react" {
  import { FC, SVGProps } from "react";
  const ReactComponent: FC<SVGProps<SVGSVGElement>>;
  export default ReactComponent;
}
```
- `svg.d.ts` 파일이 root 경로에 있다면 `tsconfig.json` > includ에 경로를 명시해주어야함 (나의 경우 src 안에 만들었기 때문에 해당x)


![같은 import 문을 ../assets/GoogleImg.svg?react 로 고친 뒤 에디터가 module "*.svg?react" 로 타입을 인식해 에러가 사라진 화면](/images/vite-react-typescript-svg-import/02.png)

에러 없이 import 잘 되는 것 확인!!

![적용 결과 화면. '로그인을 해주세요' 제목 아래에 Google 로고가 들어간 Sign in with Google 버튼이 정상 렌더링되어 있다](/images/vite-react-typescript-svg-import/03.png)

이미지도 잘 나온다