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: UI Issues in Data Fetch Scroll, Text Area Overflow, and User Profile Navigation in notes tab #9919

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

Conversation

shauryag2002
Copy link
Contributor

@shauryag2002 shauryag2002 commented Jan 12, 2025

Proposed Changes

  • Fixes UI Issues in Data Fetch Scroll, Text Area Overflow, and User Profile Navigation #9918

  • Scroll Behavior on Data Fetch:

    • Current Behavior: When scrolling up, the loading skeleton appears, and the component automatically scrolls back to the bottom.
    • Fixed Behavior: The Loading... appears without forcing the component to scroll to the bottom.
      Image
  • Resizable Input Text Area Overflow:

    • Current Behavior: The input text area can be expanded infinitely, causing layout overflow.
    • Image
    • Fixed Behavior: The text area now has a height limit, preventing overflow.
    • Image
  • Unresponsive User Avatar and Username:

    • Current Behavior: Clicking the user avatar or username does nothing.
    • Fixed Behavior: Clicking the user avatar or username now correctly navigates to the user's profile.
      Image

@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
    • Added ability to navigate to user profiles by clicking on avatar or username in messages.
    • Improved message list scrolling behavior.
  • User Experience
    • Enhanced loading state for messages with a new loading indicator.
    • Refined navigation within the encounter notes section.

@shauryag2002 shauryag2002 requested a review from a team as a code owner January 12, 2025 17:21
Copy link
Contributor

coderabbitai bot commented Jan 12, 2025

Walkthrough

The pull request introduces enhancements to the EncounterNotesTab component, focusing on improving user interaction and navigation. The changes include adding a navigateToUser function that allows users to click on avatars or usernames to navigate to their profiles. The implementation also refines message scrolling behavior, ensuring that the view remains stable during data fetching and message loading. A new useSlug hook is utilized to derive the facility ID for navigation purposes.

Changes

File Change Summary
src/pages/Encounters/tabs/EncounterNotesTab.tsx - Added useSlug hook and navigate import
- Implemented navigateToUser function
- Modified MessageItem to enable user profile navigation
- Updated scrolling logic with scrollToBottom state
- Enhanced loading state handling

Assessment against linked issues

Objective Addressed Explanation
Scroll Behavior on Data Fetch
Text Area Overflow No changes visible in the provided summary related to text area height.
User Profile Navigation

Possibly related PRs

Suggested labels

needs review, changes required, needs testing

Suggested reviewers

  • Jacobjeevan
  • rithviknishad

Poem

🐰 Hop, hop, through the code we go,
Navigating profiles with a rabbit's flow
Scrolling smooth, no more a maze
User experience enters its praise!
CodeRabbit's magic, a digital delight 🚀


📜 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 4f57530 and 766d77a.

📒 Files selected for processing (1)
  • src/pages/Encounters/tabs/EncounterNotesTab.tsx (10 hunks)
🧰 Additional context used
🪛 eslint
src/pages/Encounters/tabs/EncounterNotesTab.tsx

[error] 183-183: Replace <span·className="text-xs·text-gray-500·mb-1·cursor-pointer"·onClick={navigateToUser} with ·<span⏎············className="text-xs·text-gray-500·mb-1·cursor-pointer"⏎············onClick={navigateToUser}⏎··········

(prettier/prettier)

🪛 GitHub Check: lint
src/pages/Encounters/tabs/EncounterNotesTab.tsx

[failure] 183-183:
Replace <span·className="text-xs·text-gray-500·mb-1·cursor-pointer"·onClick={navigateToUser} with ·<span⏎············className="text-xs·text-gray-500·mb-1·cursor-pointer"⏎············onClick={navigateToUser}⏎··········

🪛 GitHub Check: cypress-run (1)
src/pages/Encounters/tabs/EncounterNotesTab.tsx

[failure] 183-183:
Replace <span·className="text-xs·text-gray-500·mb-1·cursor-pointer"·onClick={navigateToUser} with ·<span⏎············className="text-xs·text-gray-500·mb-1·cursor-pointer"⏎············onClick={navigateToUser}⏎··········

🪛 GitHub Actions: Lint Code Base
src/pages/Encounters/tabs/EncounterNotesTab.tsx

[error] 183-183: Prettier formatting error: Incorrect formatting of span element attributes. The attributes should be properly aligned on separate lines.

🪛 GitHub Actions: Cypress Tests
src/pages/Encounters/tabs/EncounterNotesTab.tsx

[error] 183-183: Replace <span·className="text-xs·text-gray-500·mb-1·cursor-pointer"·onClick={navigateToUser} with proper formatting

🔇 Additional comments (5)
src/pages/Encounters/tabs/EncounterNotesTab.tsx (5)

16-16: LGTM! New imports support user profile navigation.

The addition of navigate and useSlug imports appropriately supports the new user profile navigation feature.

Also applies to: 51-51


141-145: LGTM! Clean implementation of user profile navigation.

The navigateToUser function correctly uses the facility ID to construct the user profile URL path.


326-326: LGTM! Improved scroll behavior implementation.

The changes effectively address the scroll behavior issue by:

  • Adding state control for scroll behavior
  • Only scrolling on new messages or thread changes
  • Properly resetting scroll state

Also applies to: 405-405, 422-429


610-619: LGTM! Well-designed loading indicator.

The new loading indicator provides a better user experience with:

  • Non-intrusive positioning at the top
  • Clear loading state with spinner
  • Consistent styling with the app's design system

642-642: LGTM! Fixed text area overflow.

The addition of max-height constraint effectively prevents the text area from expanding indefinitely while maintaining its resizable functionality.


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. (Beta)
  • @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 Jan 12, 2025

Deploy Preview for care-ohc failed.

Name Link
🔨 Latest commit 766d77a
🔍 Latest deploy log https://app.netlify.com/sites/care-ohc/deploys/678c04e25859ff0008017a74

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 (2)
src/pages/Encounters/tabs/EncounterNotesTab.tsx (2)

428-435: Consider improving scroll behavior for better UX

While the current implementation fixes the automatic scrolling issue, consider adding a "scroll to bottom" button that appears when new messages arrive and the user has scrolled up. This would give users more control over the scroll behavior.

 useEffect(() => {
   if (
     messagesData &&
     !messagesLoading &&
     !isFetchingNextPage &&
     (messagesData.pages.length === 1 || scrollToBottom)
   ) {
     messagesEndRef.current?.scrollIntoView();
     setScrollToBottom(false);
   }
 }, [selectedThread, messagesData, messagesLoading, isFetchingNextPage]);
+
+const [showScrollButton, setShowScrollButton] = useState(false);
+
+useEffect(() => {
+  const handleScroll = (e: Event) => {
+    const element = e.target as HTMLElement;
+    const isScrolledUp = element.scrollHeight - element.scrollTop > element.clientHeight + 100;
+    setShowScrollButton(isScrolledUp);
+  };
+
+  const scrollArea = document.querySelector('.scroll-area');
+  scrollArea?.addEventListener('scroll', handleScroll);
+  return () => scrollArea?.removeEventListener('scroll', handleScroll);
+}, []);

648-648: Consider using a CSS variable for the max height

While the max-height constraint effectively prevents text area overflow, consider using a CSS variable for better maintainability and consistency across the application.

-className="max-h-[150px]"
+className="max-h-[var(--textarea-max-height)]"

Add this to your CSS:

:root {
  --textarea-max-height: 150px;
}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between dd68203 and a78bf53.

📒 Files selected for processing (1)
  • src/pages/Encounters/tabs/EncounterNotesTab.tsx (10 hunks)
🔇 Additional comments (2)
src/pages/Encounters/tabs/EncounterNotesTab.tsx (2)

141-145: LGTM: User profile navigation implementation

The implementation successfully addresses the unresponsive user avatar and username issue by adding click handlers that navigate to the user's profile page.

Also applies to: 163-166, 186-189


616-625: LGTM: Loading indicator implementation

The new loading indicator provides clear feedback during data fetching without disrupting the scroll position, effectively addressing the loading skeleton issue mentioned in the PR objectives.

@github-actions github-actions bot added the merge conflict pull requests with merge conflict label Jan 16, 2025
Copy link

👋 Hi, @shauryag2002,
Conflicts have been detected against the base branch. Please rebase your branch against the base branch.


This message is automatically generated by prince-chrismc/label-merge-conflicts-action so don't hesitate to report issues/improvements there.

@github-actions github-actions bot added the Deploy-Failed Deplyment is not showing preview label Jan 18, 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: 1

🧹 Nitpick comments (1)
src/pages/Encounters/tabs/EncounterNotesTab.tsx (1)

648-648: LGTM! Text area overflow prevention.

The max-height constraint prevents layout overflow while maintaining usability.

Consider adding aria-label to improve accessibility:

-          className="max-h-[150px]"
+          className="max-h-[150px]"
+          aria-label={t("encounter_notes__message_input")}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a78bf53 and 4f57530.

📒 Files selected for processing (1)
  • src/pages/Encounters/tabs/EncounterNotesTab.tsx (10 hunks)
🧰 Additional context used
🪛 eslint
src/pages/Encounters/tabs/EncounterNotesTab.tsx

[error] 163-166: Replace ⏎················className="flex·cursor-pointer"⏎················onClick={navigateToUser}⏎·············· with ·className="flex·cursor-pointer"·onClick={navigateToUser}

(prettier/prettier)

🪛 GitHub Check: cypress-run (1)
src/pages/Encounters/tabs/EncounterNotesTab.tsx

[failure] 163-163:
Replace ⏎················className="flex·cursor-pointer"⏎················onClick={navigateToUser}⏎·············· with ·className="flex·cursor-pointer"·onClick={navigateToUser}

🪛 GitHub Check: lint
src/pages/Encounters/tabs/EncounterNotesTab.tsx

[failure] 163-163:
Replace ⏎················className="flex·cursor-pointer"⏎················onClick={navigateToUser}⏎·············· with ·className="flex·cursor-pointer"·onClick={navigateToUser}

🪛 GitHub Actions: Lint Code Base
src/pages/Encounters/tabs/EncounterNotesTab.tsx

[error] 163-163: Prettier formatting error: Incorrect line breaks in JSX attributes. The className and onClick attributes should be on the same line.

🪛 GitHub Actions: Cypress Tests
src/pages/Encounters/tabs/EncounterNotesTab.tsx

[error] 163-163: Code formatting error: Improper indentation and line breaks

🪛 GitHub Actions: Deploy Care Fe
src/pages/Encounters/tabs/EncounterNotesTab.tsx

[error] 163-163: Replace multiline className and onClick props with single line format

🔇 Additional comments (4)
src/pages/Encounters/tabs/EncounterNotesTab.tsx (4)

16-16: LGTM! New imports support user profile navigation.

The addition of navigate and useSlug hook provides the necessary functionality for implementing user profile navigation.

Also applies to: 51-51


141-145: LGTM! User profile navigation implementation.

The navigateToUser function correctly constructs the navigation path using the facility ID and username.


332-332: LGTM! Improved scroll behavior during data fetch.

The scroll behavior has been improved by:

  • Adding scrollToBottom state to control when scrolling occurs
  • Only scrolling on initial load, thread change, or after sending a message
  • Preventing automatic scrolling during data fetch

Also applies to: 411-411, 428-435


616-625: LGTM! Non-intrusive loading indicator.

The new loading indicator is well-implemented:

  • Floating design prevents layout shifts
  • Includes loading animation and translated text
  • Maintains scroll position during data fetch

Comment on lines 163 to 166
<div
className="flex cursor-pointer"
onClick={navigateToUser}
>
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix formatting issues in click handlers.

The pipeline is failing due to formatting issues. Please fix the line breaks in the JSX attributes.

Apply this diff to fix the formatting:

-              <div
-                className="flex cursor-pointer"
-                onClick={navigateToUser}
-              >
+              <div className="flex cursor-pointer" onClick={navigateToUser}>
-          <span
-            className="text-xs text-gray-500 mb-1 cursor-pointer"
-            onClick={navigateToUser}
-          >
+          <span className="text-xs text-gray-500 mb-1 cursor-pointer" onClick={navigateToUser}>

Also applies to: 186-189

🧰 Tools
🪛 eslint

[error] 163-166: Replace ⏎················className="flex·cursor-pointer"⏎················onClick={navigateToUser}⏎·············· with ·className="flex·cursor-pointer"·onClick={navigateToUser}

(prettier/prettier)

🪛 GitHub Check: cypress-run (1)

[failure] 163-163:
Replace ⏎················className="flex·cursor-pointer"⏎················onClick={navigateToUser}⏎·············· with ·className="flex·cursor-pointer"·onClick={navigateToUser}

🪛 GitHub Check: lint

[failure] 163-163:
Replace ⏎················className="flex·cursor-pointer"⏎················onClick={navigateToUser}⏎·············· with ·className="flex·cursor-pointer"·onClick={navigateToUser}

🪛 GitHub Actions: Lint Code Base

[error] 163-163: Prettier formatting error: Incorrect line breaks in JSX attributes. The className and onClick attributes should be on the same line.

🪛 GitHub Actions: Cypress Tests

[error] 163-163: Code formatting error: Improper indentation and line breaks

🪛 GitHub Actions: Deploy Care Fe

[error] 163-163: Replace multiline className and onClick props with single line format

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Deploy-Failed Deplyment is not showing preview merge conflict pull requests with merge conflict
Projects
None yet
Development

Successfully merging this pull request may close these issues.

UI Issues in Data Fetch Scroll, Text Area Overflow, and User Profile Navigation
1 participant