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(dialog): 增加 lock-scroll 说明 #3082

Merged
merged 1 commit into from
May 17, 2024
Merged

docs(dialog): 增加 lock-scroll 说明 #3082

merged 1 commit into from
May 17, 2024

Conversation

eiinu
Copy link
Member

@eiinu eiinu commented May 17, 2024

这个 PR 做了什么? (简要描述所做更改)

这个 PR 是什么类型? (至少选择一个)

  • feat: 新特性提交
  • fix: bug 修复
  • docs: 文档改进
  • style: 组件样式/交互改进
  • type: 类型定义更新
  • perf: 性能、包体积优化
  • refactor: 代码重构、代码风格优化
  • test: 测试用例
  • chore(deps): 依赖升级
  • chore(demo): 演示代码改进
  • chore(locale): 国际化改进
  • chore: 其他改动(是关于什么的改动?)

这个 PR 涉及以下平台:

  • NutUI H5 @nutui/nutui
  • NutUI Taro @nutui/nutui-taro

这个 PR 是否已自测:

Summary by CodeRabbit

  • 文档
    • 在文档中新增 lock-scroll 属性,默认情况下允许锁定背景以防止滚动穿透。

Copy link

coderabbitai bot commented May 17, 2024

Walkthrough

此次更新在 src/packages/__VUE/dialog/doc.taro.md 文件中添加了 lock-scroll 属性的文档说明。该属性默认情况下允许锁定背景以防止滚动穿透。

Changes

文件路径 变更摘要
src/packages/__VUE/dialog/doc.taro.md 添加了 lock-scroll 属性的文档说明,允许默认锁定背景以防止滚动穿透。

在代码的世界里,变化如风,
文档更新,功能更丰。
锁定背景,滚动不再,
用户体验,如梦如幻。
🐰✨代码兔,与你共舞!


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

@eiinu eiinu linked an issue May 17, 2024 that may be closed by this pull request
Copy link

codecov bot commented May 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.96%. Comparing base (87f044d) to head (d16eea3).

Additional details and impacted files
@@            Coverage Diff             @@
##               v4    #3082      +/-   ##
==========================================
- Coverage   83.99%   83.96%   -0.04%     
==========================================
  Files         226      226              
  Lines       22939    22939              
  Branches     2476     2478       +2     
==========================================
- Hits        19268    19261       -7     
- Misses       3653     3660       +7     
  Partials       18       18              

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

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

Out of diff range and nitpick comments (2)
src/packages/__VUE/dialog/doc.taro.md (2)

Line range hint 147-148: 请修正属性表中的引号不匹配问题,以确保文档格式正确无误。

- | cancel-text | 取消按钮文案 | string | `”取消“` |
- | ok-text | 确定按钮文案 | string | `”确 定“` |
+ | cancel-text | 取消按钮文案 | string | `"取消"` |
+ | ok-text | 确定按钮文案 | string | `"确 定"` |

110-110: 建议检查文档中的标题层级,确保它们逐级递增,以便读者更好地理解结构。

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 87f044d and d16eea3.
Files selected for processing (1)
  • src/packages/__VUE/dialog/doc.taro.md (1 hunks)
Additional Context Used
LanguageTool (2)
src/packages/__VUE/dialog/doc.taro.md (2)

Near line 147: Unpaired symbol: ‘“’ seems to be missing
Context: ...se| | cancel-text | 取消按钮文案 | string |”取消“| | ok-text | 确定按钮文案 | string |”确...


Near line 148: Unpaired symbol: ‘”’ seems to be missing
Context: ... ”取消“ | | ok-text | 确定按钮文案 | string | ”确 定“ | | cancel-auto-close | 取消按钮是否默认关闭弹窗 |...

Additional comments not posted (2)
src/packages/__VUE/dialog/doc.taro.md (2)

110-132: 新增的 lock-scroll 属性说明和示例清晰明了,能够很好地帮助用户理解如何使用此功能。


Line range hint 183-183: 请确认链接 #/zh-CN/component/configprovider 是否正确,以确保用户能够正确导航到 ConfigProvider 组件的文档。

@eiinu eiinu merged commit 0c84db1 into jdf2e:v4 May 17, 2024
5 of 6 checks passed
@eiinu eiinu deleted the docs-dialog branch May 17, 2024 06:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

vue3编译微信小程序,dialog内容无法滚动
1 participant