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 : Clear search field when navigating back with browser controls #10777

Open
wants to merge 11 commits into
base: develop
Choose a base branch
from

Conversation

Jeffrin2005
Copy link
Contributor

@Jeffrin2005 Jeffrin2005 commented Feb 23, 2025

Proposed Changes

@ohcnetwork/care-fe-code-reviewers

Merge Checklist

  • Ensure that UI text is kept in I18n files.

  • Prep screenshot or demo video for changelog entry, and attach it to issue.

    v12.mp4

Summary by CodeRabbit

  • New Features
    • Enhanced the search component's interactivity by automatically focusing the input when the autoFocus prop is true.
    • Improved synchronization between the selected option and the displayed search text for a smoother user experience.
    • Added functionality to prevent default actions when the "Backspace" key is pressed with an empty search field.
    • Updated handling of keydown events for better performance and responsiveness.

@Jeffrin2005 Jeffrin2005 requested a review from a team as a code owner February 23, 2025 04:14
Copy link
Contributor

coderabbitai bot commented Feb 23, 2025

Walkthrough

The changes introduce new conditions and hooks in the SearchByMultipleFields component. A condition is added in the handleKeyDown function to prevent the default action for the "Backspace" key when searchValue is empty. The dependency array of an existing useEffect is updated to include searchValue. A new useEffect is added to synchronize searchValue with selectedOption.value when they differ. The previous useEffect focusing on autoFocus, open, and selectedOptionIndex remains unchanged.

Changes

File(s) Change Summary
src/components/Common/SearchByMultipleFields.tsx Added a condition in handleKeyDown to prevent default action for "Backspace" when searchValue is empty. Updated dependency array of existing useEffect to include searchValue. Added a new useEffect for syncing searchValue from selectedOption.value. Previous useEffect focusing on autoFocus, open, and selectedOptionIndex remains unchanged.

Possibly related PRs

Suggested labels

needs testing, changes required

Suggested reviewers

  • rithviknishad
  • Jacobjeevan

Poem

I'm a little rabbit, with code to explore,
Hopping through hooks on a digital floor.
Focusing inputs with a gentle grace,
Syncing states in every interface.
A byte of joy in each line I score! 🐇✨


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 332ce75 and 110cf91.

📒 Files selected for processing (1)
  • src/components/Common/SearchByMultipleFields.tsx (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/components/Common/SearchByMultipleFields.tsx
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: Redirect rules - care-ohc
  • GitHub Check: Header rules - care-ohc
  • GitHub Check: Pages changed - care-ohc
  • GitHub Check: Test
  • GitHub Check: cypress-run (1)
  • GitHub Check: lint
  • GitHub Check: OSSAR-Scan
  • GitHub Check: CodeQL-Build

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 generate docstrings to generate docstrings for 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

netlify bot commented Feb 23, 2025

Deploy Preview for care-ohc ready!

Name Link
🔨 Latest commit 650a66b
🔍 Latest deploy log https://app.netlify.com/sites/care-ohc/deploys/67caec4650e59b0008d5dbdf
😎 Deploy Preview https://deploy-preview-10777.preview.ohc.network
📱 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: 2

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 327a2b8 and 324600c.

📒 Files selected for processing (1)
  • src/components/Common/SearchByMultipleFields.tsx (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Test
  • GitHub Check: cypress-run (1)

Comment on lines 180 to 184
useEffect(() => {
if (inputRef.current) {
inputRef.current.focus();
}
}, [selectedOptionIndex]);
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Consider consolidating focus management logic.

The new useEffect hook for focusing the input field might conflict with existing focus management code. The component already handles focus in multiple places:

  • When changing options (line 121)
  • When using keyboard shortcuts (line 145)
  • When pressing Escape (line 150)
  • When autoFocus prop changes (line 236)

Consider consolidating focus management into a single location or using a more robust focus management solution to prevent potential issues:

-  useEffect(() => {
-    if (inputRef.current) {
-      inputRef.current.focus();
-    }
-  }, [selectedOptionIndex]);

   const handleOptionChange = useCallback(
     (index: number) => {
       setSelectedOptionIndex(index);
       const option = options[index];
       setSearchValue(option.value || "");
       setFocusedIndex(options.findIndex((op) => op.key === option.key));
       setOpen(false);
-      inputRef.current?.focus();
       setError(false);
       onSearch(option.key, option.value);
       onFieldChange?.(options[index]);
+      // Handle focus in a single place
+      requestAnimationFrame(() => {
+        inputRef.current?.focus();
+      });
     },
     [onSearch],
   );
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
useEffect(() => {
if (inputRef.current) {
inputRef.current.focus();
}
}, [selectedOptionIndex]);
// (Removed the following useEffect hook)
// useEffect(() => {
// if (inputRef.current) {
// inputRef.current.focus();
// }
// }, [selectedOptionIndex]);
const handleOptionChange = useCallback(
(index: number) => {
setSelectedOptionIndex(index);
const option = options[index];
setSearchValue(option.value || "");
setFocusedIndex(options.findIndex((op) => op.key === option.key));
setOpen(false);
// Handle focus in a single place
requestAnimationFrame(() => {
inputRef.current?.focus();
});
setError(false);
onSearch(option.key, option.value);
onFieldChange?.(options[index]);
},
[onSearch],
);

Comment on lines 180 to 184
useEffect(() => {
if (autoFocus) {
inputRef.current?.focus();
}
}, [autoFocus, open, selectedOptionIndex]);
Copy link
Member

Choose a reason for hiding this comment

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

why was this moved to the top? let's keep the diff clean. avoid unnecessary changes. do a self-review

@Jeffrin2005
Copy link
Contributor Author

@rithviknishad @Jacobjeevan Any changes required ?

@github-actions github-actions bot added needs-triage question Further information is requested labels Feb 24, 2025
@Jacobjeevan
Copy link
Contributor

Jacobjeevan commented Feb 25, 2025

@rithviknishad @Jacobjeevan Any changes required ?

Check Rithvik's comment above; checkout files changed tab and modify the files accordingly.

@Jacobjeevan
Copy link
Contributor

@Jeffrin2005
Copy link
Contributor Author

Moved autoFocus useEffect to the top.

@Jacobjeevan
Copy link
Contributor

🤔 Did you click on the link above?

The point was to move useEffect back down to line 223 - 228 😅

@Jacobjeevan
Copy link
Contributor

Jacobjeevan commented Feb 28, 2025

🤔 I'm comparing this to care.ohc.network - what exactly is the difference in behavior here? I thought you were going to completely clear the results on clicking back button.

@Jeffrin2005
Copy link
Contributor Author

@Jacobjeevan In care.ohc.network , When navigating back using the mouse back button,
The search term disappears, and the page refreshes, but the search bar still shows the old search term.
In this video we can see, the search term in still in the search bar

fix-23.mp4

When using the browser's mouse back button, the 'Search Encounter' field should clear as if characters are being deleted one by one.

fix-32.mp4

@Jacobjeevan Jacobjeevan added needs testing needs review and removed question Further information is requested needs-triage labels Feb 28, 2025
@nihal467
Copy link
Member

nihal467 commented Mar 4, 2025

image

  • When searching for something on the Encounter page and pressing the back button, the entered text gets erased one character at a time, which is unusual. Instead, pressing the back button should take the user to the previously accessed page.

@rithviknishad
Copy link
Member

merge checklist not followed;

@Jeffrin2005
Copy link
Contributor Author

@rithviknishad @Jacobjeevan Completed merge checklist, Can we re-open this PR ?

@github-actions github-actions bot added needs-triage question Further information is requested labels Mar 5, 2025
@Jacobjeevan Jacobjeevan reopened this Mar 5, 2025
@Jacobjeevan Jacobjeevan added changes required and removed question Further information is requested needs-triage labels Mar 6, 2025
@bodhish
Copy link
Member

bodhish commented Mar 9, 2025

Whats the status here @Jeffrin2005

@Jeffrin2005
Copy link
Contributor Author

@bodhish I have been working on this for the last three days, but I am unable to fix it. I will update it tomorrow itself.

@Jeffrin2005 Jeffrin2005 reopened this Mar 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Search Term Not Clearing on Page Back Navigation
5 participants