Scroll to top on callout creation.

[bobbykolev]

fixes #7331

Summary by CodeRabbit

• New Features
  • Enhanced user experience by automatically scrolling to the top of the page after a new callout is created.

[coderabbitai]

Walkthrough

The pull request introduces a modification to the CalloutCreationDialog component by adding a scrollToTop() utility function call after successfully creating a callout. This change ensures that the user is automatically scrolled to the top of the page immediately after a new callout is created, improving the overall user interaction and navigation experience.

Changes

File	Change Summary
src/domain/collaboration/callout/creationDialog/CalloutCreationDialog.tsx	Added scrollToTop() utility import and called within handleSaveCallout function after callout creation
src/core/ui/utils/scrollToTop	New utility method for scrolling to the top of the page

Assessment against linked issues

Objective	Addressed	Explanation
Move page to top on callout creation [#7331]	✅

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request.

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 88e457f and b2adb4a.

📒 Files selected for processing (1)

• src/domain/collaboration/callout/creationDialog/CalloutCreationDialog.tsx (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

src/domain/collaboration/callout/creationDialog/CalloutCreationDialog.tsx (1)

Pattern src/**/*.{ts,tsx,js}: Review the React.js/TypeScript/JavaScript code for best practices and potential bugs.
Ensure that the code adheres to TypeScript's typing system and modern standards.
Use the following code guide documentation in the codebase: 'docs/code-guidelines.md'.
Ensure sufficient error handling and logging is present, but note:

• We have a global error handler in place. So local try/catch blocks are not required unless they provide value beyond what the global error handler already covers.
• Avoid flagging the absence of local error handling in cases where the global error handler suffices.
• Avoid flagging the absence of logging in cases where the global logger is already in place (graphql usage).

Inform about the recommendation of not using non-null assertion,
except on GraphQL queries where the variable is asserted non-null and followed by a
skip: with the same variable.
Examples:

• Not Required: there's a skip
  {
  variables: { templateId: templateId! },
  skip: !templateId,
  }

Check for common security vulnerabilities such as:

• SQL Injection
• XSS (Cross-Site Scripting)
• CSRF (Cross-Site Request Forgery)
• Insecure dependencies
• Sensitive data exposure

📓 Learnings (1)

📓 Common learnings

Learnt from: bobbykolev
PR: alkem-io/client-web#7278
File: src/domain/collaboration/callout/creationDialog/CalloutCreationDialog.tsx:154-154
Timestamp: 2024-12-04T12:56:29.595Z
Learning: When implementing `scrollToTop()` in `CalloutCreationDialog.tsx`, ensure it is only called after a successful callout creation and not executed in the event of an error.

🔇 Additional comments (2)

src/domain/collaboration/callout/creationDialog/CalloutCreationDialog.tsx (2)

154-154: LGTM: Correct placement of scrollToTop call

The scrollToTop() call is correctly placed within the try block after successful callout creation, ensuring it only executes after success. This aligns with the previous learning and improves user experience by automatically scrolling to the top after creating a callout.

---

34-34: LGTM: Clean import of scrollToTop utility

The import statement follows the project's import organization pattern.

Let's verify the scrollToTop utility import:

✅ Verification successful

Import of scrollToTop utility is correctly implemented

The utility exists at the expected path and exports a properly implemented scroll function with smooth behavior.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify the scrollToTop utility exists and is exported correctly
rg -l "export.*scrollToTop" "src/core/ui/utils/"

Length of output: 82

---

Script:

#!/bin/bash
# Check the implementation of scrollToTop utility
cat src/core/ui/utils/scrollToTop.tsx

Length of output: 174

---

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

• 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.
  • 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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.

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.