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: allow project renaming directly from navbar (#276) #385

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Cypher-CP0
Copy link

@Cypher-CP0 Cypher-CP0 commented Oct 10, 2024

Feature #276

Allow project renaming directly from navbar

Describe the changes you have made in this PR:

  • Implemented direct project renaming functionality in the navbar
  • Updated Navbar.vue component to include an editable input for the project name
  • Added click-to-edit functionality for the project name in the navbar
  • Ensured changes are reflected in the projectStore
  • Maintained existing functionality: when Properties component is expanded, clicking the project name focuses the input in project properties
  • Improved user experience by providing a more convenient way to rename projects without needing to open the properties modal

Implementation details:

  • Added new isEditing, editedProjectName, and projectNameInput refs in Navbar.vue
  • Implemented startEditing and finishEditing functions to manage the editing state
  • Updated the template to conditionally render either an editable input or the project name text
  • Added styling to make the editable input seamless with the navbar design

Behavior:

  • When Properties component is collapsed:
    • Clicking the project name in the navbar allows inline editing
    • Pressing Enter or clicking outside the input saves the new name
  • When Properties component is expanded:
    • Clicking the project name focuses the input in project properties (existing behavior)

Screenshots of the changes (If any):

#276(1)
#276

Summary by CodeRabbit

  • New Features

    • Introduced an editable project name in the navbar, allowing users to modify the project name directly.
    • Added input field for editing the project name with improved focus and state management.
  • Bug Fixes

    • Removed unused imports to streamline the code.
  • Style

    • Added new CSS class for styling the input field in the navbar.

Copy link
Contributor

coderabbitai bot commented Oct 10, 2024

Walkthrough

The changes in src/components/Navbar/Navbar.vue introduce an editing feature for the project name in the navbar. The template now conditionally displays an input field when the isEditing state is true, allowing users to modify the project name. New reactive variables manage the editing state and the input value. Functions for starting and finishing the editing process have been added, along with the removal of unused imports and the addition of a new CSS class for styling.

Changes

File Change Summary
src/components/Navbar/Navbar.vue - Introduced isEditing and editedProjectName reactive variables.
- Added startEditing and finishEditing methods.
- Modified template to conditionally render an input field for editing project name.
- Removed unused imports and added new CSS class for input styling.

Poem

In the navbar bright, a change takes flight,
A project name now shines so right.
With a click, it’s yours to edit,
A new style, a fresh credit!
Hop along, let’s make it neat,
With every name, our joy’s complete! 🐇✨


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 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 Oct 10, 2024

Deploy Preview for circuitverse ready!

Name Link
🔨 Latest commit 73cfe1c
🔍 Latest deploy log https://app.netlify.com/sites/circuitverse/deploys/6742cb583f2e710008465440
😎 Deploy Preview https://deploy-preview-385--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

🧹 Outside diff range and nitpick comments (3)
src/components/Navbar/Navbar.vue (3)

18-26: Add aria-label to the input field for accessibility

To enhance accessibility, consider adding an aria-label attribute to the input element to describe its purpose to screen readers.


18-26: Consider handling the Escape key to cancel editing

To improve user experience, allow users to cancel editing by pressing the Escape key. You can add an event handler for the keyup.esc event:

@keyup.esc="cancelEditing"

Then implement the cancelEditing method accordingly.


75-84: Consider using relative units for input width to improve responsiveness

The input field currently has a fixed width of 200px. To enhance responsiveness on different screen sizes, consider using relative units or allowing the width to adjust:

width: 100%;
max-width: 200px;

This approach ensures the input field adapts to the available space while maintaining a maximum width.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 51766f2 and c1e8dd1.

📒 Files selected for processing (1)
  • src/components/Navbar/Navbar.vue (3 hunks)
🧰 Additional context used
🔇 Additional comments (4)
src/components/Navbar/Navbar.vue (4)

14-16: LGTM!

The updates to the class bindings and the @click handler correctly implement the editing functionality.


48-50: LGTM!

The reactive variables isEditing, editedProjectName, and projectNameInput are appropriately declared.


52-59: LGTM!

The startEditing function correctly sets up the editing state and focuses the input element.


60-65: LGTM!

The finishEditing function correctly updates the project name if the input is not empty.

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.

2 participants