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

Refactored css in src/screens/OrganizationPeople/OrganizationPeople.tsx #2978

Merged

Conversation

AceHunterr
Copy link
Contributor

@AceHunterr AceHunterr commented Dec 27, 2024

What kind of change does this PR introduce?
Refactoring

Issue Number:
Fixes #2890

Did you add tests for your changes?
No

Snapshots/Videos:
Regarding the file... there was no in file styles and the style sheet of this particular file was already refactored into src/style/app.module.css

There are certain things that I mentioned in the Issue #2890 as well for the changes I made... I'll mention them here as well

we have sx prop for styling inside the react components like this:
original
2nd

For better consistency since we are already importing the styles and applying the classes... we can also apply the root element vars to the components ensuring further consistency like this and result would be the same:
after change
4th

I mentioned one more example in the issue for further context.

If relevant, did you update the documentation?
No

Summary

Does this PR introduce a breaking change?
No

Other information

I also made essentially 2 changes in the main CSS file for better consistency with the global vars:

  1. Exchange the use of color: white; with --bs-white: #fff and color:var(--bs-white).
  2. Created a new root var --grey-border-box-color: #e8e5e5; as #e8e5e5 was repeated many times for the border and box shadows and there was no variable for that and replaced #e8e5e5 with var(--grey-border-box-color) like in border-color: var(--grey-border-box-color)

There could be further some changes that can be made but I want to confirm about such these changes first are they good to be made?

Have you read the contributing guide?
Yes

Summary by CodeRabbit

  • New Features

    • Enhanced styling of the DataGrid component for improved visual consistency.
    • Introduced new CSS variables for colors and layout adjustments, including loader properties.
  • Bug Fixes

    • Updated background and border colors for various UI elements to utilize new CSS variables, ensuring a uniform appearance.
  • Refactor

    • Replaced hardcoded color values with CSS variables across multiple styles for better maintainability.

Copy link
Contributor

coderabbitai bot commented Dec 27, 2024

Walkthrough

This pull request focuses on refactoring CSS in the OrganizationPeople screen and the global app.module.css file. The changes involve replacing hardcoded color values with CSS variables to improve maintainability and consistency across the application. The modifications include updating background colors, border radii, and introducing new CSS variables for loader and border styling.

Changes

File Change Summary
src/screens/OrganizationPeople/OrganizationPeople.tsx Updated DataGrid component styling to use CSS variables for background colors and border radius
src/style/app.module.css Added new CSS variables: --grey-border-box-color, --loader-size, --loader-border-width, --loader-color; Updated border and background color references to use variables

Assessment against linked issues

Objective Addressed Explanation
Refactor CSS in OrganizationPeople.tsx [#2890]
Move embedded CSS to global file
Improve UI/UX for color blind users Requires further color contrast validation

Possibly related issues

Possibly related PRs

Suggested labels

ignore-sensitive-files-pr

Suggested reviewers

  • palisadoes

Poem

🐰 CSS variables dance and sway,
Hardcoded colors fade away,
Styling now with grace and might,
A rabbit's code shines ever bright!
Maintainability takes the stage 🎨


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/style/app.module.css (4)

Line range hint 5-25: LGTM! Consider adding fallback values for CSS variables.

The new CSS variables are well-organized and follow consistent naming conventions. The --grey-border-box-color variable will help maintain consistency across the application.

Consider adding fallback values for all CSS variables similar to how --table-head-bg has a fallback value of blue. This ensures graceful degradation if a variable is undefined:

 :root {
-  --grey-border-box-color: #e8e5e5;
+  --grey-border-box-color: var(--bs-gray-300, #e8e5e5);
-  --loader-size: 10em;
+  --loader-size: var(--custom-loader-size, 10em);
-  --loader-border-width: 1.1em;
+  --loader-border-width: var(--custom-loader-border-width, 1.1em);
-  --loader-color: #febc59;
+  --loader-color: var(--custom-loader-color, #febc59);
 }

968-968: Continue replacing hardcoded colors with CSS variables.

Good progress on replacing hardcoded colors with CSS variables. However, there are still several instances where colors are hardcoded.

Consider creating and using CSS variables for commonly used colors:

 :root {
+  /* Add new color variables */
+  --color-primary: #31bb6b;
+  --color-text-secondary: #707070;
+  --color-success: #23864c;
 }

 /* Example replacements */
-.customcell {
-  color: var(--bs-white) !important;
+  color: var(--bs-white, #fff) !important;
 }

-.greenregbtnOrganizationFundCampaign {
-  color: var(--bs-white);
+  color: var(--bs-white, #fff);
 }

-.memberfontcreatedbtn {
-  background-color: #eaebef;
+  background-color: var(--grey-bg-color, #eaebef);
 }

Also applies to: 1021-1021, 1051-1051, 1476-1476, 1884-1884, 2075-2075, 2262-2262, 2608-2608, 2981-2981


613-613: Create shared variables for box shadows.

Good use of --grey-border-box-color for borders and shadows. However, box shadow patterns are repeated across components.

Consider creating shared variables for common box shadow patterns:

 :root {
+  /* Add box shadow variables */
+  --shadow-sm: 0 2px 2px var(--grey-border-box-color, #e8e5e5);
+  --shadow-md: 0 3px 5px var(--bs-gray-400, #c9c9c9);
+  --shadow-lg: 0 0.5rem 1rem rgb(0 0 0 / 0.15);
 }

 .greenregbtn {
-  box-shadow: 0 2px 2px var(--grey-border-box-color);
+  box-shadow: var(--shadow-sm);
 }

 .invitebtn {
-  box-shadow: 0 2px 2px var(--grey-border-box-color);
+  box-shadow: var(--shadow-sm);
 }

Also applies to: 1015-1015, 1045-1046, 1471-1472, 1879-1880, 1965-1966, 2445-2446, 2975-2976


Line range hint 3051-3196: Create shared variables for animations.

The animations are well-structured with proper vendor prefixes. However, animation durations and timing functions are hardcoded.

Consider creating shared variables for animation properties:

 :root {
+  /* Add animation variables */
+  --animation-duration-fast: 0.3s;
+  --animation-duration-normal: 0.5s;
+  --animation-timing-ease: ease-in-out;
 }

 .activeDrawer {
-  animation: comeToRightBigScreen 0.5s ease-in-out;
+  animation: comeToRightBigScreen var(--animation-duration-normal) var(--animation-timing-ease);
 }

 .inactiveDrawer {
-  animation: goToLeftBigScreen 0.5s ease-in-out;
+  animation: goToLeftBigScreen var(--animation-duration-normal) var(--animation-timing-ease);
 }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 43f2c61 and 8ce5217.

📒 Files selected for processing (2)
  • src/screens/OrganizationPeople/OrganizationPeople.tsx (1 hunks)
  • src/style/app.module.css (29 hunks)
✅ Files skipped from review due to trivial changes (1)
  • src/screens/OrganizationPeople/OrganizationPeople.tsx

Copy link

codecov bot commented Dec 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.50%. Comparing base (43f2c61) to head (8ce5217).
Report is 2 commits behind head on develop-postgres.

Additional details and impacted files
@@                  Coverage Diff                  @@
##           develop-postgres    #2978       +/-   ##
=====================================================
+ Coverage             38.68%   88.50%   +49.81%     
=====================================================
  Files                   299      320       +21     
  Lines                  7427     8288      +861     
  Branches               1624     1869      +245     
=====================================================
+ Hits                   2873     7335     +4462     
+ Misses                 4337      731     -3606     
- Partials                217      222        +5     

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

Copy link
Contributor

@palisadoes palisadoes left a comment

Choose a reason for hiding this comment

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

Thanks for going the extra mile and replacing the references to #e8e5e5

@palisadoes palisadoes merged commit 2327a4b into PalisadoesFoundation:develop-postgres Dec 27, 2024
14 checks passed
@AceHunterr AceHunterr deleted the Issue#2890 branch January 8, 2025 18:45
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