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: fixed duplicate scroll button Issue in safari browser #3392

Closed

Conversation

Prathamesh-V-Kirad
Copy link

@Prathamesh-V-Kirad Prathamesh-V-Kirad commented Nov 13, 2024

Description

  • Changed conditional rendering of button in ScrollButton.tsx
Screen.Recording.2024-11-13.at.9.30.59.PM.mov

Related issue(s)

Fixes #3197

Summary by CodeRabbit

  • New Features
    • Improved the ScrollButton component for better visibility and interactivity as users scroll.
  • Bug Fixes
    • Enhanced the rendering logic to ensure the button is always present, improving user experience.

Copy link

coderabbitai bot commented Nov 13, 2024

Walkthrough

The ScrollButton component has been updated to improve its rendering logic. Previously, the button's visibility was conditional based on the backToTopButton state, which could lead to multiple instances appearing on the page. The new implementation ensures the button is always rendered in the DOM, with its visibility and interactivity controlled through CSS classes, enhancing the component's structure.

Changes

File Change Summary
components/buttons/ScrollButton.tsx Modified rendering logic to always render the button, controlling visibility with CSS classes.

Assessment against linked issues

Objective Addressed Explanation
Prevent multiple "Top of Page" buttons from appearing (3197)

Possibly related PRs

  • fix: updated CSS for tools/generator page buttons #3294: The changes in this PR involve modifications to button rendering logic and CSS classes, which is conceptually similar to the updates made in the ScrollButton component regarding visibility and interactivity management through CSS.

Suggested labels

ready-to-merge, bounty

Suggested reviewers

  • derberg
  • magicmatatjahu
  • sambhavgupta0705
  • anshgoyalevil

Poem

🐰 In the land of scrolls, where buttons play,
A single friend will guide the way.
With CSS magic, it dances bright,
No more duplicates in sight!
So hop along, let's celebrate,
A tidy code, oh what a fate! 🌟


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.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

Copy link

netlify bot commented Nov 13, 2024

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 81acc9f
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/6734ce27689c920008d88fcb
😎 Deploy Preview https://deploy-preview-3392--asyncapi-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@asyncapi-bot
Copy link
Contributor

⚡️ Lighthouse report for the changes in this PR:

Category Score
🔴 Performance 46
🟢 Accessibility 98
🟢 Best practices 92
🟢 SEO 100
🔴 PWA 33

Lighthouse ran on https://deploy-preview-3392--asyncapi-website.netlify.app/

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)
components/buttons/ScrollButton.tsx (1)

30-35: Consider these accessibility and UX improvements.

While the fix works, we can enhance the implementation with:

  1. Accessibility improvements
  2. Smooth transitions
 <button
-  className={`rounded-full bg-white shadow-md  ${backToTopButton ? 'visible' : 'pointer-events-none invisible'}`}
+  className={`rounded-full bg-white shadow-md transition-opacity duration-200 ${
+    backToTopButton ? 'visible opacity-100' : 'pointer-events-none invisible opacity-0'
+  }`}
+  aria-hidden={!backToTopButton}
+  aria-label="Scroll to top of page"
   onClick={scrollUp}
 >
-  <img src={scrollImage} alt='scroll to top' />
+  <img src={scrollImage} alt="" role="presentation" />
 </button>
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 6f15381 and 81acc9f.

📒 Files selected for processing (1)
  • components/buttons/ScrollButton.tsx (1 hunks)
🔇 Additional comments (2)
components/buttons/ScrollButton.tsx (2)

30-35: LGTM! The visibility control fix should resolve the Safari issue.

The switch from conditional rendering to CSS-based visibility control is a good approach to prevent duplicate buttons from appearing during scroll events in Safari.


30-35: Verify the fix across different Safari versions.

Let's ensure the solution works consistently across various Safari versions and scroll behaviors.

</button>
)}
<button
className={`rounded-full bg-white shadow-md ${backToTopButton ? 'visible' : 'pointer-events-none invisible'}`}
Copy link
Member

Choose a reason for hiding this comment

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

Kind of confused as how these changes are leading to fix the error in safari?

Copy link
Author

Choose a reason for hiding this comment

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

The issue was due to an empty true condition, which led to unexpected behavior, img copies in DOM, By updating this condition to execute a specific action when true, we effectively resolved the issue as highlighted by codeRabbit. The issue and solution videos illustrate this difference clearly.

Copy link
Author

Choose a reason for hiding this comment

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

@sambhavgupta0705
Copy link
Member

closing this as not relevant

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] Multiple "Top of Page" buttons are visible while scrolling (Safari specific)
4 participants