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

Add * symbol and max phone number length to Facility Create Form #9937

Merged
merged 2 commits into from
Jan 13, 2025

Conversation

nihal467
Copy link
Member

@nihal467 nihal467 commented Jan 13, 2025

Proposed Changes

  • Fixes #issue_number
  • Change 1
  • Change 2
  • More?

@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 form usability by clearly marking required fields in the facility creation form.
  • Style

    • Added required attribute to key form fields for improved user guidance.
    • Implemented a maximum character limit for the phone number input field.

@nihal467 nihal467 requested a review from a team as a code owner January 13, 2025 13:26
Copy link
Contributor

coderabbitai bot commented Jan 13, 2025

Walkthrough

The pull request introduces modifications to the CreateFacilityForm.tsx component by adding the required attribute to several form field labels. These updates specifically target fields such as facility type, name, phone number, pincode, and address, indicating that they are mandatory for submission. Additionally, a maxLength attribute has been implemented for the phone number input, limiting it to 13 characters. The overall form logic, validation, and submission processes remain unchanged.

Changes

File Change Summary
src/components/Facility/CreateFacilityForm.tsx Added required attribute to form labels for facility type, name, phone number, pincode, and address; added maxLength attribute to phone number input (max 13 characters)

Suggested Labels

changes required

Suggested Reviewers

  • rithviknishad

Poem

🐰 A form that whispers, "Fill me right!"
With labels bold and fields so bright
Required fields now clearly shown
No detail left to chance alone
A rabbit's touch of UI 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 7161508 and 5705d23.

📒 Files selected for processing (1)
  • src/components/Facility/CreateFacilityForm.tsx (5 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/components/Facility/CreateFacilityForm.tsx
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Cloudflare Pages: care-fe

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

Deploy Preview for care-ohc ready!

Name Link
🔨 Latest commit 5705d23
🔍 Latest deploy log https://app.netlify.com/sites/care-ohc/deploys/67851656392c4200086e1749
😎 Deploy Preview https://deploy-preview-9937--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

cloudflare-workers-and-pages bot commented Jan 13, 2025

Deploying care-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: 5705d23
Status: ✅  Deploy successful!
Preview URL: https://3c03df0f.care-fe.pages.dev
Branch Preview URL: https://facility-form-mandatory.care-fe.pages.dev

View logs

Copy link

cypress bot commented Jan 13, 2025

CARE    Run #4298

Run Properties:  status check passed Passed #4298  •  git commit 5705d23702: Add * to Facility Create Form
Project CARE
Branch Review facility-form-mandatory
Run status status check passed Passed #4298
Run duration 01m 47s
Commit git commit 5705d23702: Add * to Facility Create Form
Committer Mohammed Nihal
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 4
View all changes introduced in this branch ↗︎

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 (3)
src/components/Facility/CreateFacilityForm.tsx (3)

167-167: LGTM! Consider adding aria-required for better accessibility.

The required indicator matches the validation schema. However, for better accessibility, consider adding aria-required="true" to the select input.

-                      <SelectTrigger data-cy="facility-type">
+                      <SelectTrigger data-cy="facility-type" aria-required="true">

263-263: Consider improving the phone number validation message.

While the required indicator is correctly implemented, the validation error message could be more user-friendly.

Update the phone number validation in the schema:

  phone_number: z
    .string()
    .regex(
      /^\+91[0-9]{10}$/,
-     "Phone number must start with +91 followed by 10 digits",
+     "Please enter a valid Indian mobile number (e.g., +919876543210)",
    ),

Line range hint 167-300: Consider implementing a consistent required field validation pattern.

The form's required fields are now properly marked in the UI. To maintain consistency across the application, consider:

  1. Creating a reusable pattern for required field validation
  2. Implementing consistent error message formatting
  3. Adding aria-required attributes to all required inputs

Example pattern:

const createRequiredStringSchema = (field: string) =>
  z.string().min(1, `${field} is required`);

const facilityFormSchema = z.object({
  facility_type: createRequiredStringSchema("Facility type"),
  name: createRequiredStringSchema("Name"),
  // ... other fields
});
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 721a685 and 7161508.

📒 Files selected for processing (1)
  • src/components/Facility/CreateFacilityForm.tsx (5 hunks)
🔇 Additional comments (3)
src/components/Facility/CreateFacilityForm.tsx (3)

196-196: LGTM! The required indicator matches the validation schema.

The required indicator is correctly implemented and aligns with the form's validation rules.


300-300: LGTM! The required indicator matches the validation schema.

The required indicator is correctly implemented and aligns with the form's validation rules.


281-281: Verify pincode validation for required field.

The field is marked as required in the UI, but we should verify if the validatePincode function properly handles empty values.

✅ Verification successful

Pincode validation correctly handles required field

The validation is properly implemented:

  • Empty values fail the validation due to the regex pattern ^[1-9][0-9]{5}$
  • The Zod schema uses validatePincode as a refinement function
  • UI correctly shows the required marker
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for validatePincode implementation
rg -A 5 "validatePincode.*=" || rg -A 5 "export.*validatePincode"

Length of output: 260


Script:

#!/bin/bash
# Search for pincode validation in form schema
rg -B 2 -A 2 "pincode.*:" src/components/Facility/CreateFacilityForm.tsx

Length of output: 405

@nihal467 nihal467 changed the title Add * to Facility Create Form Add * symbol and max phone number length to Facility Create Form Jan 13, 2025
@rithviknishad rithviknishad merged commit 4b5d5a7 into develop Jan 13, 2025
26 checks passed
@rithviknishad rithviknishad deleted the facility-form-mandatory branch January 13, 2025 13:37
Copy link

@nihal467 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.

2 participants