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

Render multi line text in Questionnaire Response #10216

Merged

Conversation

rajku-dev
Copy link
Contributor

@rajku-dev rajku-dev commented Jan 27, 2025

Proposed Changes

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

  • Style
    • Updated text display in ObservationsList and QuestionnaireResponsesList components to preserve whitespace and improve text wrapping
    • Added whitespace-pre-wrap class to enhance text formatting and readability

@rajku-dev rajku-dev requested a review from a team as a code owner January 27, 2025 15:34
Copy link
Contributor

coderabbitai bot commented Jan 27, 2025

Walkthrough

The pull request introduces a consistent whitespace handling approach in two React components: ObservationsList and QuestionnaireResponsesList. By adding the whitespace-pre-wrap CSS class to text rendering elements, the changes ensure that multi-line text from text areas is displayed with preserved line breaks and appropriate text wrapping, addressing the issue of single-line text rendering.

Changes

File Change Summary
src/components/Facility/ConsultationDetails/ObservationsList.tsx Added whitespace-pre-wrap class to observation value rendering
src/components/Facility/ConsultationDetails/QuestionnaireResponsesList.tsx Added whitespace-pre-wrap class to question response value rendering

Assessment against linked issues

Objective Addressed Explanation
Render multi-line text from text area in multiple lines [#10215]

Possibly related PRs

Suggested labels

tested, reviewed

Suggested reviewers

  • rithviknishad
  • Jacobjeevan

Poem

🐰 Multiline magic, text unfurled
Whitespace dancing, stories swirled
No more squished lines, no single-file fate
Rendering text, now pristine and straight!
Code rabbit hops with glee today 🌈


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 27, 2025

Deploy Preview for care-ohc ready!

Name Link
🔨 Latest commit 4e0892b
🔍 Latest deploy log https://app.netlify.com/sites/care-ohc/deploys/6798659c4840f200084d3921
😎 Deploy Preview https://deploy-preview-10216--care-ohc.netlify.app
📱 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: 0

🧹 Nitpick comments (1)
src/components/Facility/ConsultationDetails/ObservationsList.tsx (1)

100-102: LGTM! Consider extracting the class name to a constant.

The addition of whitespace-pre-wrap correctly addresses the multi-line text rendering requirement. This is particularly important for medical observations that may contain formatted text or line breaks.

Consider extracting commonly used class combinations into constants or utility classes for better maintainability:

+const TEXT_BLOCK_CLASSES = "mt-1 font-medium whitespace-pre-wrap";
+
 // Later in the code
-<div className="mt-1 font-medium whitespace-pre-wrap">
+<div className={TEXT_BLOCK_CLASSES}>
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6834157 and 4e0892b.

📒 Files selected for processing (2)
  • src/components/Facility/ConsultationDetails/ObservationsList.tsx (1 hunks)
  • src/components/Facility/ConsultationDetails/QuestionnaireResponsesList.tsx (1 hunks)
🔇 Additional comments (1)
src/components/Facility/ConsultationDetails/QuestionnaireResponsesList.tsx (1)

53-53: LGTM! Consider adding a test case for multi-line text.

The addition of whitespace-pre-wrap correctly implements the multi-line text rendering requirement, maintaining consistency with the ObservationsList component.

To ensure the feature works as expected, consider adding a test case with multi-line text input. Here's a suggested test case structure:

test('renders multi-line text with preserved formatting', () => {
  const multiLineQuestion = {
    id: '1',
    text: 'Description',
    type: 'text'
  };
  
  const multiLineResponse = {
    question_id: '1',
    values: [{
      value: 'Line 1\nLine 2\n  Indented Line'
    }]
  };
  
  render(
    <QuestionResponseValue
      question={multiLineQuestion}
      response={multiLineResponse}
    />
  );
  
  // Verify that line breaks and indentation are preserved
  const responseText = screen.getByText('Line 1\nLine 2\n  Indented Line');
  expect(responseText).toHaveClass('whitespace-pre-wrap');
});
✅ Verification successful

Styling change is consistent with codebase patterns

The addition of whitespace-pre-wrap to preserve formatting in questionnaire responses follows established patterns across the codebase, where this style is consistently used for multi-line text display in similar components like ObservationsList and ResourceDetails.

🏁 Scripts executed

The following scripts were executed for the analysis:

Error: No shell scripts found


Script:

#!/bin/bash
# Search for similar whitespace handling patterns
echo "=== Searching for whitespace-pre-wrap usage ==="
rg "whitespace-pre-wrap" -B 2 -A 2

echo -e "\n=== Looking for related test files ==="
fd "QuestionnaireResponsesList.test" -e tsx -e ts

echo -e "\n=== Finding similar text formatting components ==="
rg "className=\".*text-sm.*\"" -B 2 -A 2

Length of output: 121379

@rithviknishad rithviknishad merged commit 892dc4a into ohcnetwork:develop Jan 28, 2025
20 checks passed
Copy link

@rajku-dev Your efforts have helped advance digital healthcare and TeleICU systems. 🚀 Thank you for taking the time out to make CARE better. We hope you continue to innovate and contribute; your impact is immense! 🙌

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.

Render multi line text from text area in multiple lines
2 participants