Merge pull request #42 from stefanpl/adjust-readme-for-typescript

hints for using with typescript
jacobmischka · Sep 30, 2020 · 69d5722 · 69d5722
2 parents bc355a3 + b947cdc
commit 69d5722
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -86,6 +86,19 @@ In styles file:
 }
 ```
 
+## Using with typescript
+
+To use SVGs with Typescript, create a custom type definition like this:
+
+```typescript
+declare module "*.svg" {
+  const content: any;
+  export default content;
+}
+```
+
+Make sure the file is contained in your `tsconfig.json` `include`.
+
 ### SVG-React-Loader options
 
 Any of the svg-react-loader [query parameters](https://github.com/jhamlet/svg-react-loader#query-params) can be passed down via the webpack config by including an `options` prop within the `rule` prop.