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

Refactor/create direct chat css #3021

Conversation

Dhiren-Mhatre
Copy link
Contributor

@Dhiren-Mhatre Dhiren-Mhatre commented Dec 29, 2024

Pull Request Title

Refactor CSS in src/components/UserPortal/CreateDirectChat/CreateDirectChat.tsx (#2896)

What kind of change does this PR introduce?

Refactoring

Issue Number

Fixes #2896

Did you add tests for your changes?

No. (Refactoring does not require new tests as functionality remains unchanged.)

Snapshots/Videos

Screenshot from 2024-12-29 15-37-07

If relevant, did you update the documentation?

N/A

Summary

This PR addresses issue #2896, which involves refactoring the CSS within the src/components/UserPortal/CreateDirectChat/CreateDirectChat.tsx file.

Motivation for the change:

  • To enhance the UI/UX of Talawa-Admin for colorblind users.
  • To streamline all CSS into a single global file (src/style/app.module.css).

Tasks completed:

  1. Moved all embedded CSS in CreateDirectChat.tsx to the global CSS file (src/style/app.module.css).
  2. Removed all embedded CSS from CreateDirectChat.tsx.

Reference

Foundational work for this change was initiated in PR #2466 (Chore/css changes).

Does this PR introduce a breaking change?

No.

Other information

  • The refactored CSS adheres to the design pattern established in src/style/app.module.css.
  • Improved maintainability and consistency of CSS across the application.

Have you read the contributing guide?

Yes.

Summary by CodeRabbit

  • Style Changes
    • Migrated styling for the direct chat creation modal from a component-specific CSS module to a centralized app module.
    • Updated class names and styling for modal content, input fields, submit button, and table container.

Copy link
Contributor

coderabbitai bot commented Dec 29, 2024

Walkthrough

This pull request focuses on refactoring the CSS for the CreateDirectChat component by moving its styles from a local CSS module to the global app.module.css. The changes involve removing the CreateDirectChat.module.css file, updating the import statement in the CreateDirectChat.tsx component, and adding new CSS classes to the global stylesheet. The primary goal is to streamline the CSS and improve the overall styling consistency of the application.

Changes

File Change Summary
src/components/UserPortal/CreateDirectChat/CreateDirectChat.module.css Deleted entirely
src/components/UserPortal/CreateDirectChat/CreateDirectChat.tsx Updated import statement to use global CSS file and modified class names
src/style/app.module.css Added new CSS classes for modal content, input container, input field, submit button, and table container

Assessment against linked issues

Objective Addressed Explanation
Move CSS references to src/style/app.module.css
Remove embedded CSS references
Improve UI/UX for color-blind users Requires further review of specific color implementations

Possibly related issues

Possibly related PRs

Suggested reviewers

  • palisadoes

Poem

🐰 In the realm of styles so neat,
CSS modules now retreat
Global file takes center stage
Refactoring turns a new page
Rabbit hops with coding glee! 🎨


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.

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

Our Pull Request Approval Process

Thanks for contributing!

Testing Your Code

Remember, your PRs won't be reviewed until these criteria are met:

  1. We don't merge PRs with poor code quality.
    1. Follow coding best practices such that CodeRabbit.ai approves your PR.
  2. We don't merge PRs with failed tests.
    1. When tests fail, click on the Details link to learn more.
    2. Write sufficient tests for your changes (CodeCov Patch Test). Your testing level must be better than the target threshold of the repository
    3. Tests may fail if you edit sensitive files. Ask to add the ignore-sensitive-files-pr label if the edits are necessary.
  3. We cannot merge PRs with conflicting files. These must be fixed.

Our policies make our code better.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

  1. PRs with issues not assigned to you will be closed by the reviewer
  2. Fix the first comment in the PR so that each issue listed automatically closes

Other

  1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
  2. Read the CONTRIBUTING.md file make

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 (4)
src/components/UserPortal/CreateDirectChat/CreateDirectChat.tsx (2)

150-150: Ensure button accessibility.

While switching to a custom class for the submit button is fine, make sure the button’s text or icon is accessible to screen readers (e.g., include an aria-label attribute if the icon is the sole content).


156-159: Validate container responsiveness.

styles.tableContainer uses a fixed height of 400px. Consider making this responsive if the table grows larger on smaller screens, to avoid potential scrolling constraints.

src/style/app.module.css (2)

3847-3852: Check consistency of border styling.

.inputFieldModal uses border: 1px solid #ced4da;. Confirm that the color is consistent with the rest of the theme or if a CSS variable would be more suitable for consistency.


3863-3867: Scroll behavior and responsiveness.

.tableContainer sets height: 400px; with overflow-y: scroll;. Test on smaller screens to confirm it remains usable and doesn’t cause layout shifts.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2e2e8ef and b0a04fe.

📒 Files selected for processing (3)
  • src/components/UserPortal/CreateDirectChat/CreateDirectChat.module.css (0 hunks)
  • src/components/UserPortal/CreateDirectChat/CreateDirectChat.tsx (3 hunks)
  • src/style/app.module.css (1 hunks)
💤 Files with no reviewable changes (1)
  • src/components/UserPortal/CreateDirectChat/CreateDirectChat.module.css
🔇 Additional comments (5)
src/components/UserPortal/CreateDirectChat/CreateDirectChat.tsx (2)

20-20: Check the relative import path consistency.

The relative path '../../../style/app.module.css' appears correct given the file structure. Confirm that the path remains valid if any future reorganization occurs.


132-132: Good alignment with the new global CSS.

Using styles.inputContainer for the wrapper ensures consistent styling. No issues found here.

src/style/app.module.css (3)

3838-3840: Confirm modal sizing with UI/UX guidelines.

.modalContent sets a width of 530px, which may be appropriate but could reduce responsiveness on smaller devices. Verify cross-device display.


3842-3845: Margins and positioning look fine.

.inputContainer uses position: relative and margin-bottom: 16px; this is consistent with typical form field spacing.


3854-3862: Absolute positioning for the submit button.

.submitBtn is positioned absolutely within .inputContainer. Double-check that no overlap occurs when translations or placeholders become longer. Also ensure keyboard navigation remains intact.

Copy link

codecov bot commented Dec 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.95%. Comparing base (a36c0ff) to head (b0a04fe).
Report is 2 commits behind head on develop-postgres.

Additional details and impacted files
@@                  Coverage Diff                  @@
##           develop-postgres    #3021       +/-   ##
=====================================================
+ Coverage             29.25%   88.95%   +59.70%     
=====================================================
  Files                   300      321       +21     
  Lines                  7552     8409      +857     
  Branches               1649     1894      +245     
=====================================================
+ Hits                   2209     7480     +5271     
+ Misses                 5159      686     -4473     
- Partials                184      243       +59     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@palisadoes palisadoes merged commit f4830d0 into PalisadoesFoundation:develop-postgres Dec 29, 2024
15 checks passed
This was referenced Dec 30, 2024
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