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 : Patient search bar auto focus on visiting #10736

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

Conversation

Mahendar0701
Copy link
Contributor

@Mahendar0701 Mahendar0701 commented Feb 20, 2025

Proposed Changes

search.mp4

@ohcnetwork/care-fe-code-reviewers

Merge Checklist

  • Add specs that demonstrate bug / test a new feature.
  • Update product documentation.
  • Ensure that UI text is kept in I18n files.
  • Prep screenshot or demo video for changelog entry, and attach it to issue.
  • Request for Peer Reviews
  • Completion of QA

Summary by CodeRabbit

  • New Features
    • Enhanced search inputs now automatically receive focus upon rendering, allowing users to start typing immediately for a smoother and more efficient experience.
    • Introduced keyboard shortcut functionality for creating a new patient, improving user interaction and workflow efficiency.

@Mahendar0701 Mahendar0701 requested a review from a team as a code owner February 20, 2025 18:05
Copy link
Contributor

coderabbitai bot commented Feb 20, 2025

Walkthrough

The changes introduce an autoFocus prop to the PhoneInput component within the SearchByMultipleFields component, allowing it to automatically receive focus upon rendering. This modification is reflected in the updated interface. Additionally, the PatientIndex component now utilizes this prop, implementing a new useEffect hook to manage keyboard shortcuts for creating patients, enhancing the component's functionality.

Changes

File(s) Change Summary
src/components/Common/SearchByMultipleFields.tsx Added the autoFocus prop in the interface and applied it to the PhoneInput component within renderSearchInput.
src/components/Patient/PatientIndex.tsx Integrated the autoFocus property into the SearchByMultipleFields component call and replaced useKeyboardShortcut with a new useEffect for keyboard events.

Sequence Diagram(s)

sequenceDiagram
    participant PI as PatientIndex
    participant SMB as SearchByMultipleFields
    participant PIComp as PhoneInput

    PI->>SMB: Render component (autoFocus=true)
    SMB->>PIComp: Pass autoFocus prop
    PIComp-->>SMB: Auto-focus on render
Loading

Possibly related PRs

Suggested labels

needs review, needs testing

Suggested reviewers

  • rithviknishad
  • nihal467
  • Jacobjeevan

Poem

I am a coding rabbit,
Hopping through lines so neat,
With autoFocus magic,
Our inputs now compete.
A little hop of joy in every beat! 🐰✨

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.

📜 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 100cd57 and cce4beb.

📒 Files selected for processing (1)
  • src/components/Patient/PatientIndex.tsx (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/components/Patient/PatientIndex.tsx
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: cypress-run (1)

🪧 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 20, 2025

Deploy Preview for care-ohc ready!

Name Link
🔨 Latest commit cce4beb
🔍 Latest deploy log https://app.netlify.com/sites/care-ohc/deploys/67d590622107e500081a4292
😎 Deploy Preview https://deploy-preview-10736.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.

@Mahendar0701 Mahendar0701 changed the title Patient name update in patient switcher | Patient search bar auto focus Fixed : Newly Added Patient Is Not Instantly Visible in the patient-switcher | Patient search bar auto focus Feb 20, 2025
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: 0

🧹 Nitpick comments (1)
src/pages/PublicAppointments/PatientRegistration.tsx (1)

185-185: Consider adding error handling for localStorage operations.

While storing the selected patient follows the existing pattern, it's good practice to wrap localStorage operations in try-catch blocks to handle potential errors (e.g., when storage is full or disabled).

-      localStorage.setItem("selectedPatient", JSON.stringify(data));
+      try {
+        localStorage.setItem("selectedPatient", JSON.stringify(data));
+      } catch (error) {
+        console.error("Failed to store selected patient:", error);
+      }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 39f79e2 and 189b6ab.

📒 Files selected for processing (2)
  • src/components/Common/SearchByMultipleFields.tsx (1 hunks)
  • src/pages/PublicAppointments/PatientRegistration.tsx (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Test
  • GitHub Check: cypress-run (1)
  • GitHub Check: CodeQL-Build
🔇 Additional comments (4)
src/components/Common/SearchByMultipleFields.tsx (3)

39-51: LGTM! Interface update is well-defined.

The autoFocus prop is correctly added as an optional boolean to the SearchByMultipleFieldsProps interface.


191-199: LGTM! PhoneInput enhancement is properly implemented.

The autoFocus prop is correctly passed to the PhoneInput component.


224-228: LGTM! Focus management is properly handled.

The useEffect hook correctly manages focus based on the autoFocus prop changes.

src/pages/PublicAppointments/PatientRegistration.tsx (1)

181-183: LGTM! Cache invalidation is properly implemented.

The cache invalidation ensures that the patients list is refreshed after creating a new patient.

Copy link
Member

Choose a reason for hiding this comment

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

pass inputRef to the component instead. autoFocus behaviour is manually controlled based on other states and side effects.

rithviknishad
rithviknishad previously approved these changes Feb 23, 2025
Copy link
Contributor

Choose a reason for hiding this comment

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

@Mahendar0701 In the deploy preview I cannot enter any phone number in entire care

cc:@rithviknishad
Screenshot_2025_0224_103514

@nihal467
Copy link
Member

@Mahendar0701 @rithviknishad the entire patient creation is broken since patient number aren't allow to enter in your PR

Comment on lines 52 to 54
inputComponent={(inputProps) => (
<InputComponent {...inputProps} ref={inputRef} />
)}
Copy link
Member

Choose a reason for hiding this comment

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

i don't think this is a good idea. Have you checked if inputComponent itself is passing the ref? if so, we can't override it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

And if i pass inputRef as prop in phone-input then a type mismatch error is coming

image

I think the below approach works fine, what you think? should i do this?

cc : @Jacobjeevan

            <PhoneInput
              id={id}
              name={selectedOption.key}
              placeholder={selectedOption.placeholder}
              value={searchValue}
              onChange={(value) => setSearchValue(value)}
              className={inputClassName}
              autoFocus={autoFocus}
            />
            

@nihal467
Copy link
Member

nihal467 commented Mar 4, 2025

@Mahendar0701 fix the cypress failure

@Jacobjeevan
Copy link
Contributor

@Mahendar0701 Phone number is still broken.

@rithviknishad
Copy link
Member

merge checklist not followed;

@Mahendar0701
Copy link
Contributor Author

Mahendar0701 commented Mar 8, 2025

@rithviknishad @Jacobjeevan can you reopen this PR i followed merge checklist

@nihal467
Copy link
Member

@Mahendar0701, the cypress is still not fixed. can you share the EOD for this PR?

@nihal467 nihal467 added the question Further information is requested label Mar 10, 2025
@Mahendar0701
Copy link
Contributor Author

Mahendar0701 commented Mar 10, 2025

@nihal467 all tests passing

Self review:
Used autofocus prop instead of inputRef as this is causing type mismatch error everytime

cc @rithviknishad

End date : today itself if everything goes well

@nihal467
Copy link
Member

image

  • now the element is always focus on the search bar, the shift + P shortcut is not at all working, how are you planning to handle that issue caused by this PR ?

@Mahendar0701
Copy link
Contributor Author

image

  • now the element is always focus on the search bar, the shift + P shortcut is not at all working, how are you planning to handle that issue caused by this PR ?

@nihal467 SHIFT + P works when search bar gets unfocused by clicking outside.

If it is a requirement to get SHIFT+P work even on focus , then i will proceed to update this PR with that

Can you plz confirm it ??

@Jacobjeevan
Copy link
Contributor

image

  • now the element is always focus on the search bar, the shift + P shortcut is not at all working, how are you planning to handle that issue caused by this PR ?

@nihal467 SHIFT + P works when search bar gets unfocused by clicking outside.

If it is a requirement to get SHIFT+P work even on focus , then i will proceed to update this PR with that

Can you plz confirm it ??

Since we are auto-focusing on the input, shortcut should work regardless, yes.

@Jacobjeevan Jacobjeevan removed question Further information is requested needs-triage labels Mar 13, 2025
@Mahendar0701
Copy link
Contributor Author

@rithviknishad @Jacobjeevan i have updated the PR can you once take a look. Now keyboard shortcut works even if search bar is focused

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.

Patient search should get autofocused upon visiting patient search tab
6 participants