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: start tour messages are attached to proper location now #387

Merged
merged 1 commit into from
Jun 19, 2024

Conversation

Amitooo1
Copy link
Contributor

@Amitooo1 Amitooo1 commented Jun 19, 2024

fixes #357

Description

Start tour popups are now aligned properly to a more accurate location.

Screenshots

image
image

Summary by CodeRabbit

  • New Features
    • Enhanced the navigation experience with improved element targeting and styling in the Navbar and HomePage components.
    • Updated tour feature to provide clearer guidance by modifying element selectors.

Copy link

vercel bot commented Jun 19, 2024

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

Copy link
Contributor

coderabbitai bot commented Jun 19, 2024

Walkthrough

In this update, key changes involve modifying the Navbar and HomePage components, along with improvements to the startTour function. Enhanced attribute IDs were added for better styling and element targeting. This ensures more precise control over specific elements, facilitating an improved user experience during site navigation and interaction.

Changes

Files Change Summary
src/components/core/navbar/index.tsx Added id attributes for hamburger menu and theme button.
Wrapped ThemeButton in a new div for better styling.
src/components/pages/home/index.tsx Added id attribute "start-your-journey" to improve element targeting.
src/helper/startTour.ts Updated element selectors for tour steps for clearer guidance.

Sequence Diagram(s)


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 wait for reviewers gssoc GSSOC'24 Required Label labels Jun 19, 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, @Amitooo1! 🎉 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 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)
src/components/core/navbar/index.tsx (1)

Line range hint 131-136: Add explicit type attributes to the button elements to prevent unintended form submissions.

- <button onClick={() => setMenuOpen(!isMenuOpen)} className={`...`}>
+ <button type="button" onClick={() => setMenuOpen(!isMenuOpen)} className={`...`}>

- <button onClick={() => setMenuOpen(!isMenuOpen)} className={`...`}>
+ <button type="button" onClick={() => setMenuOpen(!isMenuOpen)} className={`...`}>

Also applies to: 216-221

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 927e018 and b222f54.

Files selected for processing (3)
  • src/components/core/navbar/index.tsx (2 hunks)
  • src/components/pages/home/index.tsx (1 hunks)
  • src/helper/startTour.ts (2 hunks)
Files skipped from review due to trivial changes (1)
  • src/components/pages/home/index.tsx
Additional context used
Biome
src/components/core/navbar/index.tsx

[error] 131-136: 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


[error] 216-221: 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 (3)
src/helper/startTour.ts (1)

38-38: Updated tour step targets and positions align with the PR's objectives and should improve user experience by ensuring the tour messages are attached to more accurate locations.

Also applies to: 102-103

src/components/core/navbar/index.tsx (2)

127-127: Added an id attribute to improve element targeting for the tour. This change supports the PR's goal to align tour popups correctly.


143-145: The new wrapping div with an id of "theme" around the ThemeButton is consistent with the changes made to improve tour element targeting.

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 added 🪲 bug Something isn't working 🛠 goal: fix The label is related to fixing a bug EASY Difficulty Level: Easy level1 10 points and removed wait for reviewers labels Jun 19, 2024
@Sanchitbajaj02 Sanchitbajaj02 merged commit 3ea8150 into Sanchitbajaj02:master Jun 19, 2024
11 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🪲 bug Something isn't working EASY Difficulty Level: Easy 🛠 goal: fix The label is related to fixing a bug gssoc GSSOC'24 Required Label level1 10 points
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: Start tour popups are misaligned
2 participants