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

fix(anchor): [anchor] fixed the bug that querySelect cannot select sp… #2620

Merged
merged 1 commit into from
Dec 6, 2024

Conversation

zzcr
Copy link
Member

@zzcr zzcr commented Dec 6, 2024

…ecial id

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

    • Updated the version of the @opentiny/vue-renderless package to 3.20.3.
  • Bug Fixes

    • Corrected element retrieval logic for selectors starting with #.
    • Improved scrolling behavior for horizontal anchor points when links are clicked.

Copy link

coderabbitai bot commented Dec 6, 2024

Walkthrough

The pull request includes an update to the version number of the @opentiny/vue-renderless package from 3.20.2 to 3.20.3 in the package.json file. Additionally, it modifies the getEleMentBySelect function in the anchor/index.ts file to correctly retrieve elements based on selectors starting with #, and enhances the linkClick function with a comment clarifying scrolling behavior adjustments.

Changes

File Change Summary
packages/renderless/package.json Updated version number from 3.20.2 to 3.20.3.
packages/renderless/src/anchor/index.ts Fixed element retrieval in getEleMentBySelect for selectors starting with #; added comment in linkClick for clarity on scrolling behavior.

Possibly related PRs

Suggested labels

bug

🐇 In the meadow, a change did bloom,
A version updated, dispelling gloom.
Anchors now find their way with ease,
Scrolling to the top, like a gentle breeze.
With every click, the links do flow,
A hop, a skip, and off we go! 🌼


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

@github-actions github-actions bot added the bug Something isn't working label Dec 6, 2024
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

🧹 Outside diff range and nitpick comments (1)
packages/renderless/src/anchor/index.ts (1)

Line range hint 208-211: Enhance documentation and test coverage for horizontal scrolling fix

The comment about fixing horizontal anchor scrolling could be more descriptive. Additionally, we should ensure this fix is properly tested.

Consider improving the comment to better explain the issue and solution:

-        props.offsetTop // 修复横向锚点无法滚动到顶部
+        props.offsetTop // Subtracts offsetTop to ensure proper alignment when scrolling to anchors in horizontal layouts

Would you like me to help create test cases for horizontal scrolling scenarios? This could include:

  • Testing with different offsetTop values
  • Verifying scroll behavior with horizontal layouts
  • Checking alignment precision in various container sizes
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 678ab67 and 57a1c2b.

📒 Files selected for processing (2)
  • packages/renderless/package.json (1 hunks)
  • packages/renderless/src/anchor/index.ts (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • packages/renderless/package.json
🔇 Additional comments (1)
packages/renderless/src/anchor/index.ts (1)

15-17: Consider improving the element selection logic

While the fix correctly handles ID-based selection, there are a few potential improvements to consider:

  1. The function assumes the parent parameter is needed for non-ID selectors, but it might be redundant when using document-wide selectors.
  2. The optional chaining is only applied to the selector parameter, but not to the subsequent operations.

Consider this more robust implementation:

-const getEleMentBySelect = (parent, selector) =>
-  selector?.startsWith('#') ? document.getElementById(selector.slice(1)) : parent.querySelector(selector)
+const getEleMentBySelect = (parent, selector) => {
+  if (!selector) return null;
+  return selector.startsWith('#') 
+    ? document.getElementById(selector.slice(1))
+    : (parent || document).querySelector(selector);
+}

Let's verify the usage patterns of this function:

@zzcr zzcr merged commit 490ad10 into release-3.20.0 Dec 6, 2024
5 of 7 checks passed
kagol pushed a commit that referenced this pull request Dec 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant