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(input): [input] fix input's autofocus not work #2615

Merged

Conversation

shenjunjian
Copy link
Collaborator

@shenjunjian shenjunjian commented Dec 5, 2024

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • New Features
    • Added dynamic autofocus capability to input fields, allowing them to automatically focus when specified.
  • Bug Fixes
    • Improved user experience by ensuring inputs gain focus immediately upon mounting if the autofocus attribute is present.
  • Style
    • Minor formatting adjustments for better code readability.

Copy link

coderabbitai bot commented Dec 5, 2024

Walkthrough

The pull request introduces enhancements to the autofocus functionality in the Vue components. In packages/renderless/src/input/vue.ts, a conditional check for the autofocus attribute is added within the onMounted lifecycle hook to automatically focus the input element if specified. Additionally, in packages/vue/src/tree/src/tree-node.vue, the autofocus attribute of the <tiny-input> component is changed from a static to a dynamic binding, allowing for reactive behavior. Minor formatting adjustments are also included.

Changes

File Path Change Summary
packages/renderless/src/input/vue.ts Added a conditional check for autofocus in the onMounted hook to call focus() if present.
packages/vue/src/tree/src/tree-node.vue Changed autofocus from a static attribute to a dynamic binding (:autofocus="true").

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • zzcr

Poem

In a field of code, so bright and neat,
A tiny input awaits, oh what a treat!
With autofocus now, it leaps with glee,
Ready to shine, just wait and see!
Hopping through changes, we cheer and play,
A better user journey, hip-hip-hooray! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 5364e56 and 8ef2ab1.

📒 Files selected for processing (2)
  • packages/renderless/src/input/vue.ts (1 hunks)
  • packages/vue/src/tree/src/tree-node.vue (1 hunks)
🔇 Additional comments (2)
packages/renderless/src/input/vue.ts (1)

419-422: LGTM! Proper implementation of autofocus functionality.

The implementation correctly checks for the autofocus attribute and calls the focus() method, which aligns with how native input elements handle autofocus.

packages/vue/src/tree/src/tree-node.vue (1)

124-124: LGTM! Verify keyboard navigation still works as expected.

The dynamic binding of autofocus is correct and improves UX by immediately focusing the input when entering edit mode. However, since this is within a tree component that might support keyboard navigation, it's good to verify that this doesn't interfere with keyboard navigation patterns.

✅ Verification successful

Let me gather more information about keyboard event handling in the tree component.


Let me check the implementation of the edit mode and saveEdit function to understand the complete interaction flow.


Let me try one final check to understand the tree node's edit functionality better.


:autofocus="true" binding is safe for keyboard navigation

Based on the code analysis, the autofocus is properly integrated with other input handlers:

  • The input is wrapped in a conditional template, indicating it only appears in edit mode
  • It has proper event handling with @keyup.enter and @blur for saving edits
  • Event propagation is correctly stopped with @click.stop
  • The input is scoped to the node being edited and doesn't interfere with the tree's overall structure
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if there are any keyboard navigation related code or tests
rg -A 5 "keydown|keyup|keyboard|navigation" packages/vue/src/tree/

Length of output: 554


Script:

#!/bin/bash
# Check for keyboard event handlers and navigation related code in the tree component
ast-grep --pattern 'onKeydown($$$) { $$$ }' packages/vue/src/tree/
ast-grep --pattern 'onKeyup($$$) { $$$ }' packages/vue/src/tree/

# Look for any keyboard-related props or methods
rg -A 3 "keyboard|navigation|key.*down|key.*up" packages/vue/src/tree/

Length of output: 533


Script:

#!/bin/bash
# Check the implementation of saveEdit and edit mode related code
ast-grep --pattern 'saveEdit($$$) { $$$ }' packages/vue/src/tree/src/tree-node.vue

# Look for edit mode related state and transitions
rg -A 5 "edit.*mode|isEdit" packages/vue/src/tree/src/tree-node.vue

Length of output: 154


Script:

#!/bin/bash
# Get more context around the input element and its event handlers
rg -B 5 -A 10 "@keyup\.enter=\"saveEdit" packages/vue/src/tree/src/tree-node.vue

# Look for any state management related to editing
rg -B 3 -A 3 "isEditing|editMode|currentValue" packages/vue/src/tree/src/tree-node.vue

Length of output: 824


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.

@shenjunjian shenjunjian changed the title fix(input): fix input's autofocus not work fix(input): [input] fix input's autofocus not work Dec 5, 2024
Copy link

github-actions bot commented Dec 5, 2024

[e2e-test-warn]
The component to be tested is missing.

The title of the Pull request should look like "fix(vue-renderless): [action-menu, alert] fix xxx bug".

Please make sure you've read our contributing guide

@zzcr zzcr merged commit fcf3016 into opentiny:release-3.18.0 Dec 11, 2024
4 of 5 checks passed
@shenjunjian shenjunjian deleted the release318-fix-input-focus branch January 9, 2025 02:48
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