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

feat: Added a "Scroll to top" button Matching to Website Design Theme #366

Merged
merged 6 commits into from
Jun 9, 2024

Conversation

MastanSayyad
Copy link
Contributor

@MastanSayyad MastanSayyad commented Jun 8, 2024

Closes #363

Description

Hey @Sanchitbajaj02 I have added Scroll to top button please take a look and review it, Thank You!!

Screenshots

topbtn.mp4

Summary by CodeRabbit

  • New Features
    • Introduced a scroll-to-top button for easier navigation back to the top of the page.

Copy link

vercel bot commented Jun 8, 2024

@MastanSayyad is attempting to deploy a commit to the Sanchit Bajaj's projects Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions github-actions bot added title needs formatting Title of issue or pull request does not match the guidelines wait for reviewers gssoc GSSOC'24 Required Label and removed title needs formatting Title of issue or pull request does not match the guidelines labels Jun 8, 2024
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.

Great job, @MastanSayyad! 🎉 Thank you for submitting your pull request. Your contribution is valuable and we appreciate your efforts to improve our project. Keep being the part of the community!

'We will promptly review your changes and offer feedback. Keep up the excellent work!
Kindly remember to check our Contributing Guidelines'

Copy link
Contributor

coderabbitai bot commented Jun 8, 2024

Walkthrough

The changes introduce a new ScrollToTop component in the project, which provides a button for users to quickly scroll back to the top of the page. This feature is integrated into the RootLayout component and styled to match the website's design theme.

Changes

File/Path Summary
src/app/layout.tsx Added import for ScrollToTop and included the component within the RootLayout function.
src/components/ScrollToTop/scrolltotop.css Introduced styles for the scroll-to-top button, enhancing its appearance and behavior.
src/components/ScrollToTop/scrolltotop.tsx Created a new ScrollToTop component that displays a button for scrolling to the top.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ScrollToTopButton
    participant Page

    User->>Page: Scroll down
    User->>ScrollToTopButton: Click ScrollToTop button
    ScrollToTopButton->>Page: Scroll to top
Loading

Assessment against linked issues

Objective Addressed Explanation
Implement a scroll-to-top button matching the website design theme (#363)

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.
    • @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 as 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.

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.

@github-actions github-actions bot added the title needs formatting Title of issue or pull request does not match the guidelines label Jun 8, 2024
@MastanSayyad MastanSayyad changed the title ✨ Added a "Scroll to top" button Matching to Website Design Theme feat: Added a "Scroll to top" button Matching to Website Design Theme Jun 8, 2024
@github-actions github-actions bot removed the title needs formatting Title of issue or pull request does not match the guidelines label Jun 8, 2024
Copy link
Contributor

@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: 2

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 75a4c5c and 7323213.

Files ignored due to path filters (1)
  • yarn.lock is excluded by !**/*.lock, !**/*.lock
Files selected for processing (3)
  • src/app/layout.tsx (2 hunks)
  • src/components/ScrollToTop/scrolltotop.css (1 hunks)
  • src/components/ScrollToTop/scrolltotop.tsx (1 hunks)
Files skipped from review due to trivial changes (1)
  • src/components/ScrollToTop/scrolltotop.css
Additional context used
Biome
src/components/ScrollToTop/scrolltotop.tsx

[error] 24-24: This hook does not specify all of its dependencies: toggleVisibility (lint/correctness/useExhaustiveDependencies)

This dependency is not specified in the hook dependency list.

This dependency is not specified in the hook dependency list.

Either include them or remove the dependency array


[error] 34-34: Provide an explicit type prop for the button element. (lint/a11y/useButtonType)

The default type of a button is submit, which causes the submission of a form when placed inside a form element. This is likely not the behaviour that you want inside a React application.
Allowed button types are: submit, button or reset

Additional comments not posted (1)
src/app/layout.tsx (1)

6-6: The integration of ScrollToTop component looks good and is correctly placed within the layout.

Also applies to: 67-67

src/components/ScrollToTop/scrolltotop.tsx Outdated Show resolved Hide resolved
@Sanchitbajaj02 Sanchitbajaj02 added ⭐ enhancement Feature enhancement EASY Difficulty Level: Easy level1 10 points and removed wait for reviewers labels Jun 8, 2024
@MastanSayyad
Copy link
Contributor Author

Done @Sanchitbajaj02

Copy link
Contributor

@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: 2

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7323213 and 98e75a2.

Files selected for processing (1)
  • src/components/ScrollToTop/scrolltotop.tsx (1 hunks)
Additional context used
Biome
src/components/ScrollToTop/scrolltotop.tsx

[error] 23-23: This hook does not specify all of its dependencies: toggleVisibility (lint/correctness/useExhaustiveDependencies)

This dependency is not specified in the hook dependency list.

This dependency is not specified in the hook dependency list.

Either include them or remove the dependency array


[error] 33-36: Provide an explicit type prop for the button element. (lint/a11y/useButtonType)

The default type of a button is submit, which causes the submission of a form when placed inside a form element. This is likely not the behaviour that you want inside a React application.
Allowed button types are: submit, button or reset

src/components/ScrollToTop/scrolltotop.tsx Outdated Show resolved Hide resolved
src/components/ScrollToTop/scrolltotop.tsx Outdated Show resolved Hide resolved
@MastanSayyad
Copy link
Contributor Author

Changes Done @Sanchitbajaj02

Copy link
Contributor

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 98e75a2 and 5708291.

Files selected for processing (1)
  • src/components/ScrollToTop/scrolltotop.tsx (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • src/components/ScrollToTop/scrolltotop.tsx

Copy link
Owner

@Sanchitbajaj02 Sanchitbajaj02 left a comment

Choose a reason for hiding this comment

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

LGTM

@Sanchitbajaj02 Sanchitbajaj02 merged commit b640d0b into Sanchitbajaj02:master Jun 9, 2024
4 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
EASY Difficulty Level: Easy ⭐ enhancement Feature enhancement gssoc GSSOC'24 Required Label level1 10 points
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feat ✨: Add Scroll-To-Top Button Matching to Website Design Theme
2 participants