fix: clear the input box when closing the search

[aonoa]

Description

Fixes: #4464

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

• If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
• Run the tests with pnpm test.
• Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

• New Features

  • Enhanced modal behavior to automatically clear the search keyword when the modal is closed.

• Bug Fixes

  • Ensured consistent functionality of the modal closing process by resetting the keyword value.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 19d37d5

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

The changes in this pull request focus on enhancing the modal behavior within the global-search.vue component. A new callback function, onOpenChange, is introduced to reset the search keyword to an empty string when the modal is closed. Additionally, the declarations for keyword and searchInputRef have been repositioned in the code for better organization, while the existing functionality of the handleClose function remains intact.

Changes

File Path	Change Summary
packages/effects/layouts/src/widgets/global-search/global-search.vue	Added onOpenChange callback to reset keyword on modal close; reorganized declaration of keyword and searchInputRef.

Assessment against linked issues

Objective	Addressed	Explanation
Clear the search input when the modal is reopened (#[4464])	✅

Possibly related PRs

• fix: when the form is opened repeatedly, the state is unexpectedly stroyed #4406: This PR also modifies the onOpenChange method of a modal, focusing on resetting the state when the modal is opened.

Suggested labels

bug

Suggested reviewers

• vince292007

Poem

In the meadow, a search was made,
A keyword lingered, a mistake displayed.
With a hop and a click, the modal's reset,
Now fresh and clear, no need to fret!
A happy search, with no past to weigh,
Just bunnies and blooms on a bright sunny day! 🐇✨

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 31f6cc6 and 19d37d5.

Files selected for processing (1)

• packages/effects/layouts/src/widgets/global-search/global-search.vue (1 hunks)

Additional comments not posted (2)

packages/effects/layouts/src/widgets/global-search/global-search.vue (2)

33-35: LGTM!

Moving the declarations of keyword and searchInputRef to a higher position in the code improves readability without affecting functionality.

---

40-44: The change addresses the issue by clearing the search input when the modal is closed.

The addition of the onOpenChange callback function, which resets the keyword value when the modal is closed, aligns with the PR objective and resolves the reported issue.

To verify if the issue is fully resolved, please run the following manual test:

1. Open the search modal.
2. Enter a search keyword and perform a search.
3. Close the search modal.
4. Reopen the search modal.
5. Verify that the search input is cleared and does not retain the previous search keyword.

Please confirm if the above test passes and the issue is fully resolved.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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.