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.

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

docs: popup 增加 taro ios 兼容 faq #2943

Merged
merged 1 commit into from
Jan 15, 2025

Conversation

xiaoyatong
Copy link
Collaborator

@xiaoyatong xiaoyatong commented Jan 15, 2025

🤔 这个变动的性质是?

  • 新特性提交
  • 日常 bug 修复
  • 站点、文档改进
  • 演示代码改进
  • 组件样式/交互改进
  • TypeScript 定义更新
  • 包体积优化
  • 性能优化
  • 功能增强
  • 国际化改进
  • 重构
  • 代码风格优化
  • 测试用例
  • 分支合并
  • 其他改动(是关于什么的改动?)

🔗 相关 Issue

💡 需求背景和解决方案

☑️ 请求合并前的自查清单

⚠️ 请自检并全部勾选全部选项⚠️

  • 文档已补充或无须补充
  • 代码演示已提供或无须提供
  • TypeScript 定义已补充或无须补充
  • fork仓库代码是否为最新避免文件冲突
  • Files changed 没有 package.json lock 等无关文件

Summary by CodeRabbit

  • 文档
    • 为弹出组件文档添加了 FAQ 部分
    • 提供了关于 lockScroll 属性在 iOS 设备上使用的解决方案建议

Copy link

coderabbitai bot commented Jan 15, 2025

变更概览

遍历

文档 src/packages/popup/doc.taro.md 中新增了一个 FAQ 部分,专门针对 iOS 设备上 lockScroll 属性的使用提供指导。该部分解释了在 iOS 设备上可能遇到的滚动锁定问题,并建议通过修改宿主页面样式作为解决方案。

变更

文件 变更摘要
src/packages/popup/doc.taro.md 新增 FAQ 部分,说明 iOS 设备上 lockScroll 属性的使用注意事项

可能相关的 PR

建议的审阅者

  • oasis-cloud

诗歌

兔子窝里的代码精灵,
iOS 弹窗有了新秘诀,
滚动锁定不再是难题,
样式调整,妙手回春,
用户体验更加圆润!🐰✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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. (Beta)
  • @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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/packages/popup/doc.taro.md (1)

139-141: 建议完善 FAQ 内容

为了使文档更加清晰和实用,建议:

  1. 添加具体的代码示例,展示如何实现样式的添加和移除
  2. 解释在 iOS 上出现此问题的原因
  3. 说明此问题影响的 iOS 版本范围

建议按如下方式扩展内容:

 ## FAQ
 
-在 iOS 下,有时候 `lockScroll` 可能不生效,此刻在打开 `popup` 时,可将宿主页面的样式增加 `overflow: hidden;`,关闭弹层时,再重置样式。
+### iOS 下 lockScroll 失效问题
+
+在 iOS 系统中,某些版本下 `lockScroll` 属性可能会失效。这是由于 iOS WebView 对 overflow 处理机制的特殊性导致的。
+
+#### 解决方案
+
+可以通过手动控制宿主页面的样式来解决此问题:
+
+```tsx
+const App = () => {
+  const [visible, setVisible] = useState(false)
+  
+  const handlePopupOpen = () => {
+    document.body.style.overflow = 'hidden'
+    setVisible(true)
+  }
+  
+  const handlePopupClose = () => {
+    document.body.style.overflow = 'auto'
+    setVisible(false)
+  }
+  
+  return (
+    <Popup
+      visible={visible}
+      onOpen={handlePopupOpen}
+      onClose={handlePopupClose}
+    >
+      弹窗内容
+    </Popup>
+  )
+}
+```
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 52f39ac and a03f877.

📒 Files selected for processing (1)
  • src/packages/popup/doc.taro.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build
🔇 Additional comments (1)
src/packages/popup/doc.taro.md (1)

139-141: 很好的补充说明!

FAQ 部分的添加对于解决 iOS 设备上的特定问题很有帮助。

@Alex-huxiyang Alex-huxiyang merged commit 16fb6e5 into jdf2e:next Jan 15, 2025
4 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Jan 15, 2025
20 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants