Skip to content

feat(new-webui): Enable query submission via Enter key (resolves #943).#957

Merged
davemarco merged 7 commits into
y-scope:mainfrom
davemarco:form
Jun 10, 2025
Merged

feat(new-webui): Enable query submission via Enter key (resolves #943).#957
davemarco merged 7 commits into
y-scope:mainfrom
davemarco:form

Conversation

@davemarco

@davemarco davemarco commented Jun 2, 2025

Copy link
Copy Markdown
Contributor

Description

When user hits enter, the query will now submit. Resolves #943

Implementation is just to wrap the search controls in a form, and prevent default behaviour from triggering page load.

I also explicitly removed behaviour for cancel button, I think this is better. I think on old webui enter would also cancel query.

Checklist

  • The PR satisfies the contribution guidelines.
  • This is a breaking change and that has been indicated in the PR title, OR this isn't a
    breaking change.
  • Necessary docs have been updated, OR no docs need to be updated.

Validation performed

Tested enter submits query.

Summary by CodeRabbit

Summary by CodeRabbit

  • Refactor
    • Updated search controls to use a form element with proper submit and cancel button types for improved accessibility and consistent behaviour.

@davemarco davemarco requested a review from a team as a code owner June 2, 2025 19:43
@coderabbitai

coderabbitai Bot commented Jun 2, 2025

Copy link
Copy Markdown
Contributor

"""

Walkthrough

The changes wrap the SearchControls component in a form element, add an onSubmit handler to prevent default form submission, and explicitly set the HTML button types for the CancelButton and SubmitButton components. No other logic or control flow is altered.

Changes

File(s) Change Summary
.../SearchPage/SearchControls/SearchButton/CancelButton.tsx, .../SearchButton/SubmitButton.tsx Explicitly set htmlType prop on Button components to "button" and "submit" respectively.
.../SearchPage/SearchControls/index.tsx Wrapped content in a <form> with onSubmit={e => e.preventDefault()}; no changes to children.

Assessment against linked issues

Objective Addressed Explanation
Wrap search input in a form with an onSubmit handler (#943)
Make the Enter key start a search query (#943)

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes detected.

Possibly related PRs

Suggested reviewers

  • junhaoliao
    """

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2d9485a and dfeec64.

📒 Files selected for processing (1)
  • components/log-viewer-webui/client/src/pages/SearchPage/SearchControls/index.tsx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.{cpp,hpp,java,js,jsx,tpp,ts,tsx}`: - Prefer `false == ` rather than `!`.

**/*.{cpp,hpp,java,js,jsx,tpp,ts,tsx}: - Prefer false == <expression> rather than !<expression>.

  • components/log-viewer-webui/client/src/pages/SearchPage/SearchControls/index.tsx
🧬 Code Graph Analysis (1)
components/log-viewer-webui/client/src/pages/SearchPage/SearchControls/index.tsx (1)
components/webui/imports/ui/SearchView/SearchControls/index.jsx (1)
  • SearchControls (46-161)
🔇 Additional comments (2)
components/log-viewer-webui/client/src/pages/SearchPage/SearchControls/index.tsx (2)

7-14: LGTM! Clean form submission handler implementation.

The handleSubmit function correctly prevents default form submission behaviour to avoid page reloads, and the function placement outside the component is efficient since it doesn't need to be recreated on each render.


23-29: LGTM! Proper semantic form implementation.

Wrapping the search controls in a <form> element with the onSubmit handler enables the desired Enter key submission functionality while maintaining proper HTML semantics. This pattern aligns well with the related button component updates mentioned in the summary.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.

@davemarco davemarco requested review from hoophalab and junhaoliao June 2, 2025 19:43
@davemarco davemarco changed the title feat(new-webui): Add support to start query by pressing Enter key (Resolves #943). feat(new-webui): Add support to start query by pressing Enter key (resolves #943). Jun 2, 2025

@junhaoliao junhaoliao left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Implementation is just to wrap the search controls in a form

nice

I also explicitly removed behaviour for cancel button, I think this is better. I think on old webui enter would also cancel query.

sure. i think once we add better support real time ingestion, while a search is progressing, we could also restart searches when a user hits the Return key. anyways we don't need this for now

for the PR title, do you think this is more concise?

feat(new-webui): Enable query submission via Enter key (resolves #943).

Comment on lines +15 to +17
onSubmit={(e) => {
e.preventDefault();
}}

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

let's extract this and use useCallback to wrap the definition

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I just moved it out of component. The effect should be the same just without useCallback

@davemarco davemarco requested a review from junhaoliao June 3, 2025 20:11
Comment thread components/log-viewer-webui/client/src/pages/SearchPage/SearchControls/index.tsx Outdated
…Controls/index.tsx

Co-authored-by: Junhao Liao <junhao@junhao.ca>
@davemarco davemarco requested a review from junhaoliao June 9, 2025 17:24
@davemarco davemarco changed the title feat(new-webui): Add support to start query by pressing Enter key (resolves #943). feat(new-webui): Enable query submission via Enter key (resolves #943). Jun 9, 2025
@davemarco davemarco merged commit 682de3b into y-scope:main Jun 10, 2025
7 checks passed
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.

[new-webui] Make the Enter key start a search query.

2 participants