Skip to content

feature: use keyboard for filter dropdown #2771

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

Open
wants to merge 3 commits into
base: alpha
Choose a base branch
from

Conversation

dblythy
Copy link
Member

@dblythy dblythy commented Apr 27, 2025

New Pull Request Checklist

Issue Description

Closes: #2469

Approach

TODOs before merging

Summary by CodeRabbit

  • Bug Fixes
    • Improved handling of the Enter key in the autocomplete input to ensure more consistent behavior when submitting suggestions.
  • Style
    • Updated the visual appearance of active and hovered suggestion list items with a subtle translucent white background for better user feedback.

Copy link

parse-github-assistant bot commented Apr 27, 2025

🚀 Thanks for opening this pull request! We appreciate your effort in improving the project. Please let us know once your pull request is ready for review.

@parseplatformorg
Copy link
Contributor

parseplatformorg commented Apr 27, 2025

🎉 Snyk checks have passed. No issues have been found so far.

security/snyk check is complete. No issues have been found. (View Details)

Copy link

uffizzi-cloud bot commented Apr 27, 2025

Uffizzi Ephemeral Environment deployment-63192

⌚ Updated Apr 27, 2025, 11:33 UTC

☁️ https://app.uffizzi.com/github.com/parse-community/parse-dashboard/pull/2771

📄 View Application Logs etc.

What is Uffizzi? Learn more

@mtrezza mtrezza closed this Apr 27, 2025
@mtrezza mtrezza reopened this Apr 27, 2025
Copy link

uffizzi-cloud bot commented Apr 27, 2025

Uffizzi Ephemeral Environment deployment-63193

⌚ Updated Apr 27, 2025, 14:16 UTC

☁️ https://app.uffizzi.com/github.com/parse-community/parse-dashboard/pull/2771

📄 View Application Logs etc.

What is Uffizzi? Learn more

Copy link

coderabbitai bot commented Apr 28, 2025

Walkthrough

The changes update the behavior of the autocomplete component and its suggestion list styling. In the autocomplete logic, the Enter key handling is improved for better keyboard accessibility, ensuring that the submission only occurs with a valid user input and that the component state is properly updated after a selection. Additionally, the styling for active and hovered suggestion list items is enhanced with a new background color for clearer visual feedback.

Changes

File(s) Change Summary
src/components/Autocomplete/Autocomplete.react.js Improved Enter key handling: checks both e.key and e.keyCode, ensures onSubmit and non-empty input, updates state after submission, and sets user input to the selected suggestion.
src/components/SuggestionsList/SuggestionsList.scss Added background color styling for .active and .suggestions li:hover to provide a translucent white overlay.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant AutocompleteComponent

    User->>AutocompleteComponent: Keydown (Enter)
    AutocompleteComponent->>AutocompleteComponent: Check if Enter key and input present
    alt onSubmit defined and input non-empty
        AutocompleteComponent->>AutocompleteComponent: Call onSubmit(userInput)
        AutocompleteComponent->>AutocompleteComponent: Update state (active, activeSuggestion, showSuggestions, userInput)
    end
Loading

Assessment against linked issues

Objective Addressed Explanation
Make filters dropdown accessible via arrow keys (#2469)
✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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

@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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between bcce5c5 and f626029.

📒 Files selected for processing (2)
  • src/components/Autocomplete/Autocomplete.react.js (1 hunks)
  • src/components/SuggestionsList/SuggestionsList.scss (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Node 20
  • GitHub Check: Docker linux/amd64
🔇 Additional comments (2)
src/components/SuggestionsList/SuggestionsList.scss (1)

27-33: Improved visual feedback for keyboard navigation and hover states.

Adding the semi-transparent white background provides better visual feedback when navigating through suggestions with keyboard or mouse, aligning with the accessibility improvements in the autocomplete component.

Note: The !important flag is typically discouraged in CSS, but may be necessary here to override conflicting styles. Consider revisiting the specificity hierarchy if time permits.

src/components/Autocomplete/Autocomplete.react.js (1)

254-257: Enhanced Enter key handling with better cross-browser compatibility.

The condition now checks both e.keyCode === 13 and e.key === 'Enter', which is a good practice for cross-browser support. The validation before submission is also improved, ensuring that:

  • userInput exists and is not empty
  • this.props.onSubmit is defined

Comment on lines +258 to +264

this.setState({
active: true,
activeSuggestion: 0,
showSuggestions: false,
userInput: filteredSuggestions[activeSuggestion],
});
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Potential edge case with undefined userInput.

When setting userInput: filteredSuggestions[activeSuggestion], there's a risk of setting userInput to undefined if filteredSuggestions is empty or activeSuggestion is out of bounds.

Consider adding a fallback to preserve the current input when there's no valid suggestion:

this.setState({
  active: true,
  activeSuggestion: 0,
  showSuggestions: false,
-  userInput: filteredSuggestions[activeSuggestion],
+  userInput: filteredSuggestions[activeSuggestion] || userInput,
});

Committable suggestion skipped: line range outside the PR's diff.

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 filters dropdown is currently inaccessible via arrow keys.
3 participants