Skip to content

docs: document that plugin-ideal-image changes imported image types#12130

Merged
slorber merged 1 commit into
facebook:mainfrom
MasterIfeanyi:docs/plugin-ideal-image-type-change
Jun 12, 2026
Merged

docs: document that plugin-ideal-image changes imported image types#12130
slorber merged 1 commit into
facebook:mainfrom
MasterIfeanyi:docs/plugin-ideal-image-type-change

Conversation

@MasterIfeanyi

@MasterIfeanyi MasterIfeanyi commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

This change addresses issue #8684, which reported that plugin-ideal-image changes the type of imported images but this behavior was not clearly documented. This PR adds a warning block in the Usage section to make this behavior explicit for users.

Test Plan

This is a documentation-only change. I verified the changes locally by running pnpm start and navigating to the plugin ideal-image docs page to confirm the warning renders correctly.

Test links

Deploy preview: https://deploy-preview-_____--docusaurus-2.netlify.app/

Related issues/PRs

Closes #8684

@meta-cla meta-cla Bot added the CLA Signed Signed Facebook CLA label Jun 9, 2026
@netlify

netlify Bot commented Jun 9, 2026

Copy link
Copy Markdown

[V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit 7fe3291
🔍 Latest deploy log https://app.netlify.com/projects/docusaurus-2/deploys/6a283edad30e9e000850b300
😎 Deploy Preview https://deploy-preview-12130--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@slorber slorber added the pr: ignore This PR is not meaningful enough to appear in the changelog. label Jun 12, 2026
@slorber slorber merged commit b7963e3 into facebook:main Jun 12, 2026
14 of 15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed Signed Facebook CLA pr: ignore This PR is not meaningful enough to appear in the changelog.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

It is not documentated that plugin-ideal-image changes the types of and the usage in React components of supported imported images

2 participants