feat(popeditor): [popeditor] add attribute lock-scroll

[James-9696]

PR

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our Commit Message Guidelines
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

• Bugfix
• Feature
• Code style update (formatting, local variables)
• Refactoring (no functional changes, no api changes)
• Build related changes
• CI related changes
• Documentation content changes
• Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

• Yes
• No

Other information

Summary by CodeRabbit

• New Features

  • Introduced a new property to the popeditor component that allows users to control whether scrolling is locked when a pop-up window appears. This property is enabled by default and can be configured as needed.

• Documentation

  • Updated demo descriptions to include information about the new scroll lock configuration option.

• Tests

  • Added test coverage to verify scroll lock behavior when the new property is set.

[coderabbitai]

Walkthrough

A new boolean property, lock-scroll/lockScroll, was introduced to the pop-editor component and its related documentation, demos, and tests. This property controls whether scrolling is locked when the pop-up editor is active, with a default value of true. Demo and test files were updated to showcase and verify this new behavior.

Changes

File(s)	Change Summary
examples/sites/demos/apis/popeditor.js	Added lock-scroll boolean prop to pop-editor component props with default true and documentation.
packages/vue/src/popeditor/src/index.ts	Added lockScroll boolean prop (default true) to popeditorProps.
packages/vue/src/popeditor/src/pc.vue	Registered lockScroll prop and passed it to <tiny-dialog-box>.
examples/sites/demos/pc/app/popeditor/condition-layout.vue .../condition-layout-composition-api.vue	Bound :lock-scroll="false" to <tiny-popeditor> in demo templates.
examples/sites/demos/pc/app/popeditor/condition-layout.spec.ts	Added test assertion to check that scroll lock class is not present when lock-scroll is false.
examples/sites/demos/pc/app/popeditor/webdoc/popeditor.js	Updated demo descriptions to mention the new lock-scroll attribute in Chinese and English.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PopEditor
    participant DialogBox

    User->>PopEditor: Open pop-editor (with lock-scroll prop)
    PopEditor->>DialogBox: Open dialog (pass lockScroll)
    alt lockScroll is true
        DialogBox->>Document: Add scroll lock class
    else lockScroll is false
        DialogBox->>Document: Do not add scroll lock class
    end
    User->>PopEditor: Close pop-editor
    PopEditor->>DialogBox: Close dialog
    DialogBox->>Document: Remove scroll lock class (if present)

Loading

Poem

🐇
A hop, a scroll, a pop appears,
Now locked or free, as the user steers.
With lock-scroll set, the page stands still,
Or let it flow, if that's your will.
Demos updated, tests in tow—
The popeditor’s ready, let scrolls come or go!
🌱

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.

examples/sites/demos/pc/app/popeditor/condition-layout.spec.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-vue".

(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-vue@latest --save-dev

The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

examples/sites/demos/pc/app/popeditor/webdoc/popeditor.js

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-vue".

(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-vue@latest --save-dev

The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

examples/sites/demos/apis/popeditor.js

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-vue".

(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-vue@latest --save-dev

The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

• 4 others

---

📜 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 1e33249 and 49bdd9b.

📒 Files selected for processing (7)

• examples/sites/demos/apis/popeditor.js (1 hunks)
• examples/sites/demos/pc/app/popeditor/condition-layout-composition-api.vue (1 hunks)
• examples/sites/demos/pc/app/popeditor/condition-layout.spec.ts (1 hunks)
• examples/sites/demos/pc/app/popeditor/condition-layout.vue (1 hunks)
• examples/sites/demos/pc/app/popeditor/webdoc/popeditor.js (1 hunks)
• packages/vue/src/popeditor/src/index.ts (1 hunks)
• packages/vue/src/popeditor/src/pc.vue (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: PR E2E Test (pnpm test:e2e3)

🔇 Additional comments (8)

examples/sites/demos/pc/app/popeditor/condition-layout.vue (1)

11-11: LGTM! Clean implementation of the new lock-scroll feature.

The demo correctly demonstrates the new lock-scroll attribute by setting it to false, which allows users to see the scroll lock behavior can be disabled.

examples/sites/demos/pc/app/popeditor/condition-layout-composition-api.vue (1)

11-11: LGTM! Consistent implementation across API styles.

The composition API demo correctly implements the same lock-scroll="false" attribute, maintaining consistency with the options API version.

examples/sites/demos/pc/app/popeditor/condition-layout.spec.ts (1)

14-14: Excellent test coverage for the new feature.

The test correctly verifies that when lock-scroll="false" is set, the <body> element does not receive the scroll lock CSS class. The assertion is well-positioned and uses an appropriate regex pattern to match the expected class name.

packages/vue/src/popeditor/src/index.ts (1)

186-189: Well-implemented prop definition with thoughtful defaults.

The lockScroll property is properly typed as Boolean with a sensible default value of true that maintains backward compatibility. The implementation follows established patterns in the codebase.

examples/sites/demos/pc/app/popeditor/webdoc/popeditor.js (1)

40-43: Documentation update looks good!

The descriptions accurately document the new lock-scroll feature in both Chinese and English, clearly explaining its purpose for controlling scrollbar behavior when the pop-up appears.

examples/sites/demos/apis/popeditor.js (1)

347-360: Comprehensive API documentation for the new feature.

The property definition is complete with proper typing, default value, bilingual descriptions, and version tracking. Good practice including the demo reference for condition-layout.

packages/vue/src/popeditor/src/pc.vue (2)

398-398: Prop correctly added to component definition.

The lockScroll prop is properly added to the props array following the established pattern in this component.

---

100-100: Proper prop binding to dialog component.

The lock-scroll prop is correctly passed down to the tiny-dialog-box component using proper kebab-case naming in the template. This ensures the scroll locking behavior is handled by the underlying dialog component.

✨ 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.