chore: Extracting out showNudge config from screen mode toggle component

[ankitakinger]

Description

Extracting out showNudge config from screen mode toggle component to make this component re-usable in other IDEs.

Fixes #37690

Automation

/ok-to-test tags="@tag.Sanity, @tag.IDE"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/12948269268
Commit: 1a30130
Cypress dashboard.
Tags: @tag.Sanity, @tag.IDE
Spec:

---

Fri, 24 Jan 2025 11:40:32 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

• Yes
• No

Summary by CodeRabbit

• New Features

  • Introduced a new nudge system for side-by-side view functionality in the editor.
  • Enhanced user guidance with a dismissible nudge for screen mode switching.

• Improvements

  • Refined state management for screen mode toggle by utilizing props.
  • Improved component prop handling for better flexibility and interactivity.

[coderabbitai]

Walkthrough

The pull request focuses on refactoring the ScreenModeToggle and EditorTabs components to extract and manage the side-by-side view nudge functionality. The changes introduce a new Props interface and modify how the nudge state is handled, moving from internal state management to prop-based control. This allows for more flexible management of the side-by-side view nudge across the editor interface.

Changes

File	Change Summary
app/client/src/pages/Editor/IDE/EditorTabs/ScreenModeToggle.tsx	- Added Props interface - Updated component to accept showNudge and dismissNudge as props - Removed useShowSideBySideNudge hook import
app/client/src/pages/Editor/IDE/EditorTabs/index.tsx	- Added useShowSideBySideNudge hook - Initialized showNudge and dismissNudge variables - Passed nudge-related props to ScreenModeToggle

Assessment against linked issues

Objective	Addressed	Explanation
Extract right control in section header	❌	The changes do not address the extraction of the right control from the section header component.
Allow flexible right control configuration	❌	The implementation does not provide for the configuration of the right control as null or any ReactNode.
Handle side by side mode logic	✅

Suggested reviewers

• albinAppsmith
• AmanAgarwal041

Poem

Code refactored with grace and might,
Nudge state now dancing in prop's light,
Components sing a modular tune,
Flexibility blooms like a coder's boon! 🚀✨

---

📜 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 f9c8157 and 1a30130.

📒 Files selected for processing (1)

• app/client/src/pages/Editor/IDE/EditorTabs/ScreenModeToggle.tsx (3 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• app/client/src/pages/Editor/IDE/EditorTabs/ScreenModeToggle.tsx

⏰ Context from checks skipped due to timeout of 90000ms (8)

• GitHub Check: perform-test / rts-build / build
• GitHub Check: perform-test / client-build / client-build
• GitHub Check: perform-test / server-build / server-unit-tests
• GitHub Check: client-unit-tests / client-unit-tests
• GitHub Check: client-lint / client-lint
• GitHub Check: client-check-cyclic-deps / check-cyclic-dependencies
• GitHub Check: client-build / client-build
• GitHub Check: client-prettier / prettier-check

---

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

app/client/src/pages/Editor/IDE/EditorTabs/ScreenModeToggle.tsx (1)

19-22: Consider using a more descriptive interface name.
Using a generic Props name for the interface may lead to ambiguity in larger codebases. A more specific name (e.g., ScreenModeToggleProps) could help with clarity.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between efceb1e and f9c8157.

📒 Files selected for processing (2)

• app/client/src/pages/Editor/IDE/EditorTabs/ScreenModeToggle.tsx (1 hunks)
• app/client/src/pages/Editor/IDE/EditorTabs/index.tsx (3 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (5)

• GitHub Check: client-unit-tests / client-unit-tests
• GitHub Check: client-lint / client-lint
• GitHub Check: client-check-cyclic-deps / check-cyclic-dependencies
• GitHub Check: client-build / client-build
• GitHub Check: client-prettier / prettier-check

🔇 Additional comments (4)

app/client/src/pages/Editor/IDE/EditorTabs/ScreenModeToggle.tsx (1)

24-25: Well-structured prop usage.
Destructuring dismissNudge and showNudge from props is clean and easy to read.

app/client/src/pages/Editor/IDE/EditorTabs/index.tsx (3)

13-17: Import organization looks good.
Bringing in the useShowSideBySideNudge hook here helps keep concerns separated and the code maintainable.

---

39-39: Effective custom hook usage.
Destructuring [showNudge, dismissNudge] neatly conveys the hook’s returned values.

---

155-155: Consistent prop passing to ScreenModeToggle.
Passing dismissNudge and showNudge aligns perfectly with the new interface.