chore: fix ssr render warning

[zombieJ]

Summary by CodeRabbit

• Refactor
  • 优化了预览状态处理逻辑，使组件在未明确设置预览状态时表现更加一致。
  • 改进了弹出层（Portal）渲染控制，确保弹出效果仅在必要时加载和显示，从而提升界面响应性和用户体验。

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
image	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 18, 2025 3:34am

[coderabbitai]

Walkthrough

本次更改主要包含两个部分。首先，在 ImageInternal 组件中，修改了解构赋值语法，将 open: previewOpen = undefined 改为 open: previewOpen，使得默认值处理略有不同。其次，在 Preview/index.tsx 中新增了状态变量 portalRender 并通过 useLayoutEffect 控制 Portal 组件的渲染，同时调整了 Portal 与 CSSMotion 组件的显示逻辑。此外，还引入了新的 hook 与类型导入。

Changes

文件	更改摘要
src/Image.tsx	修改 ImageInternal 组件中 previewOpen 的解构赋值，调整默认值设置。
src/Preview/index.tsx	新增 portalRender 状态，添加 useLayoutEffect；调整 Portal 与 CSSMotion 的渲染逻辑，并新增 hook 与类型导入。

Sequence Diagram(s)

sequenceDiagram
  participant P as Preview 组件
  participant ULE as useLayoutEffect
  participant S as portalRender 状态
  participant Port as Portal 组件
  participant CM as CSSMotion 组件
  
  P->>ULE: 检测 open prop 为 true
  ULE->>S: 设置 portalRender 为 true
  S->>Port: 触发 Portal 渲染
  Port->>CM: 控制 CSSMotion 的可见性

Loading

Possibly related PRs

• feat: support classnames and styles #376: 针对 ImageInternal 组件中引入新属性（类名与样式）的修改，与本次解构赋值更改有直接关联。
• feat: support classnames and styles #378: 涉及 ImageInternal 组件结构调整，新增类名和样式属性，与本次相关逻辑更新紧密相连。

Poem

我是一只快乐的小兔子，
在代码森林中蹦跃轻盈；
previewOpen 如春风化雨，
portalRender 点亮了新晨曦。
每一行代码，都跳跃出奇迹的节拍！ 🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

src/Image.tsx

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the config "prettier" to extend from. Please check that the name of the config is correct.

The config "prettier" was referenced from the config file in "/.eslintrc.js".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

src/Preview/index.tsx

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the config "prettier" to extend from. Please check that the name of the config is correct.

The config "prettier" was referenced from the config file in "/.eslintrc.js".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fc40ae0 and 17d172c.

📒 Files selected for processing (2)

• src/Image.tsx (1 hunks)
• src/Preview/index.tsx (3 hunks)

🔇 Additional comments (6)

src/Image.tsx (1)

117-117: 优化解构赋值语法

将 open: previewOpen = undefined 改为 open: previewOpen 移除了显式的默认值赋值。这种变化使得 previewOpen 将直接获取 preview 对象中 open 属性的值，如果不存在则为 undefined。这样的修改符合 React 的最佳实践，并且与下文中 useMergedState 的使用更加一致。

src/Preview/index.tsx (5)

4-4: 添加必要的 hook 导入

添加 useLayoutEffect 导入以解决 SSR 渲染警告问题，这是一个合理的改进。useLayoutEffect 会在 DOM 变更后、浏览器绘制前同步执行，这有助于解决客户端水合过程中的渲染不匹配问题。

---

14-14: 导入必要的类型定义

从 ../Image 导入 ImgInfo 类型是一个良好的实践，有助于提高代码类型安全性和可维护性。

---

372-377: 解决 SSR 渲染警告的关键改进

添加 portalRender 状态和 useLayoutEffect 钩子是解决 SSR 渲染警告的核心修改。这种实现确保了 Portal 组件只在客户端渲染时才会被激活，有效避免了服务端渲染与客户端水合时的不匹配问题。

当 open 变为 true 时，useLayoutEffect 会在客户端 DOM 操作后立即将 portalRender 设置为 true，而不会在服务端执行，从而避免了潜在的水合错误。

---

388-388: 优化 Portal 组件的条件渲染

将 Portal 组件的 open 属性从直接使用 open 改为使用 portalRender 是解决 SSR 渲染问题的关键部分。这确保了 Portal 只在客户端必要时才会渲染，避免了服务端渲染时的潜在问题。

---

391-391: 优化动画组件的可见性逻辑

修改 CSSMotion 组件的 visible 属性为 portalRender && open 是一个精确的改进。这确保了只有当 Portal 已渲染且组件应该显示时，才会触发动画效果，避免了在不适当的时机执行动画导致的渲染问题。

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.40%. Comparing base (fc40ae0) to head (17d172c).
Report is 1 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #392   +/-   ##
=======================================
  Coverage   99.40%   99.40%           
=======================================
  Files          17       17           
  Lines         502      506    +4     
  Branches      148      149    +1     
=======================================
+ Hits          499      503    +4     
  Misses          3        3           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.