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

Added a shortcut + toggle button hidden when less circuits #450

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Sourabh-awasthy
Copy link

@Sourabh-awasthy Sourabh-awasthy commented Feb 1, 2025

Fixes #
-Added a shortcut (Alt+n) to make a new circuit
-Hide the toggle button in the tabs-bar when circuits are less

Screenshots of the changes (If any) -

image

image

Closes #301
Note: Please check Allow edits from maintainers. if you would like us to assist in the PR.

Summary by CodeRabbit

  • New Features

    • Enhanced the interactive tabs bar to seamlessly update its display in real time when users add new circuits. A new keyboard shortcut (Alt + N) has been introduced to simplify and expedite the creation process.
  • Style

    • Updated the tabs bar’s appearance with refined dimensions to improve visual consistency and overall user experience.

Copy link
Contributor

coderabbitai bot commented Feb 1, 2025

Walkthrough

The changes update the TabsBar component. A new DOM reference (tabsBarRef) and height variable (tabsBarHeight) are introduced, along with a function updateTabsBarHeight that recalculates the bar's height. A keyboard event handler (userClickArrowUp) listens for the Alt+N combination to create a new circuit scope. The promise chain on the new circuit button now calls updateTabsBarHeight, and lifecycle hooks manage adding and removing the event listener. Additionally, styling adjustments modify dimensions in the maxHeightStyle class.

Changes

File(s) Change Summary
v0/src/components/.../TabsBar.vue - Added tabsBarRef and tabsBarHeight references.
- Introduced updateTabsBarHeight to recalculate height from the DOM.
- Added userClickArrowUp to handle Alt+N for new circuit scope creation.
- Managed event listeners using onMounted and onBeforeUnmount.
- Updated promise chain for circuit creation to trigger height update.
- Adjusted styling (height/max-height from 30px to 32px).

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant T as TabsBar Component
    participant C as Circuit Scope Manager
    U->>T: Press Alt+N
    T->>T: Handle event (userClickArrowUp)
    T->>C: Request new circuit scope
    C-->>T: Circuit created (promise resolved)
    T->>T: Call updateTabsBarHeight
    T-->>U: UI updated with new height
Loading
sequenceDiagram
    participant U as User
    participant T as TabsBar Component
    participant C as Circuit Scope Manager
    U->>T: Click "New Circuit" button
    T->>C: Initiate new circuit creation (promise chain)
    C-->>T: Circuit created
    T->>T: Call updateTabsBarHeight
    T-->>U: UI updated with adjusted layout
Loading

Assessment against linked issues

Objective Addressed Explanation
Toggle button visibility based on open circuit designs (#301)

Poem

I'm a bunny coding in the night,
Hopping through tabs with pure delight.
Alt+N makes new circuits appear,
Heights adjust as my code draws near.
With every tweak my heart skips a beat,
Celebrating changes with a joyful leap!
🐇🌟


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

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

netlify bot commented Feb 1, 2025

Deploy Preview for circuitverse ready!

Name Link
🔨 Latest commit 3c56b75
🔍 Latest deploy log https://app.netlify.com/sites/circuitverse/deploys/679e17923e868b0008e02ab0
😎 Deploy Preview https://deploy-preview-450--circuitverse.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.

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

🧹 Nitpick comments (3)
v0/src/components/TabsBar/TabsBar.vue (3)

50-52: Consider using a more flexible threshold for toggle button visibility.

The hardcoded 31px threshold might not be ideal across different screen sizes and DPI settings. Consider using a relative measure or making this configurable.

-        <button v-if="tabsBarHeight>=31" class="tabsbar-toggle" @click="toggleHeight">
+        <button v-if="tabsBarHeight >= getMinToggleHeight()" class="tabsbar-toggle" @click="toggleHeight">

Add this helper function:

function getMinToggleHeight(): number {
    // Can be made configurable or calculated based on viewport
    return 31;
}

102-106: Consider improving keyboard shortcut handling.

The current implementation could be enhanced in several ways:

  1. Add a check for macOS Command key support
  2. Consider preventing the default browser behavior
  3. Add proper TypeScript types for the event parameter
-const userClickArrowUp = ({ code,altKey }) => {
+const userClickArrowUp = (event: KeyboardEvent) => {
+    const { code, altKey, metaKey } = event;
+    // Support both Alt and Command (macOS) keys
+    if ((altKey || metaKey) && code === 'KeyN') {
+        event.preventDefault();
         createNewCircuitScope().then(updateTabsBarHeight)
     }
 };

362-363: Consider documenting the height values.

The height values are hardcoded. Consider adding a comment explaining why 32px was chosen or use CSS variables for better maintainability.

 .maxHeightStyle {
-    height: 32px !important;
-    max-height: 32px !important;
+    /* Height increased to 32px to accommodate the circuit tabs and padding */
+    --tabs-max-height: 32px;
+    height: var(--tabs-max-height) !important;
+    max-height: var(--tabs-max-height) !important;
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c0b26c9 and 3c56b75.

📒 Files selected for processing (1)
  • v0/src/components/TabsBar/TabsBar.vue (5 hunks)
🔇 Additional comments (5)
v0/src/components/TabsBar/TabsBar.vue (5)

4-4: LGTM!

The addition of tabsBarRef and class binding looks good.

Also applies to: 6-6


47-49: LGTM!

Good practice to update the height after creating a new circuit.


88-90: LGTM!

Good initialization of state variables with proper TypeScript types.


96-100: LGTM!

The height update function is simple and focused.


108-115: LGTM!

Good practice to:

  • Initialize height on mount
  • Clean up event listeners on unmount

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.

The Toggle button in TabsBar should be hidden when there are less Circuit Designs openned.
1 participant