Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add possible to override type of '*.svg' #30060

Closed
wants to merge 5 commits into from
Closed

Add possible to override type of '*.svg' #30060

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
704304b
Add possible to override type of '*.svg'
in19farkt Oct 19, 2021
39481b8
Merge branch 'canary' into patch-1
in19farkt Oct 20, 2021
f939ea7
Merge branch 'canary' into patch-1
in19farkt Oct 22, 2021
a67f150
Remove svg module declaration if config has custom svg loader
in19farkt Oct 22, 2021
c18010c
Merge branch 'canary' into patch-1
in19farkt Oct 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 21 additions & 2 deletions packages/next/image-types/global.d.ts
View file
Open in desktop
Expand Up @@ -16,11 +16,30 @@ declare module '*.png' {

declare module '*.svg' {
/**
* Use `any` to avoid conflicts with
* By default, use `any` to avoid conflicts with
* `@svgr/webpack` plugin or
* `babel-plugin-inline-react-svg` plugin.
*
* If you are not using these plugins, you can override
* the default behavior using a code snippet inside your project
*
* // yourProject/src/global.d.ts
Copy link
Member

@styfle styfle Oct 19, 2021 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We document this as additional.d.ts and it needs to be added to the include array

image

https://nextjs.org/docs/basic-features/typescript

* declare module '*.svg' {
* export interface OverrideDefaultTypeSettings {
* useAny: false;
* }
* }
*/
Copy link
Member

@styfle styfle Oct 19, 2021 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we modify the type when we detect the svg loaders so the user doesn't need to do anything?

For example, see #26281

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll try to figure out how this can be done

const content: any
interface DefaultTypeSettings {
useAny: true;
}

export interface OverrideDefaultTypeSettings {}

type TypeSettings = Omit<DefaultTypeSettings, keyof OverrideDefaultTypeSettings> & OverrideDefaultTypeSettings;
type ContentType = TypeSettings['useAny'] extends true ? any : StaticImageData;

const content: ContentType;

export default content
}
Expand Down