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 CSS files in src/components/RequestsTableItem #3410

Conversation

arpit-chakraborty
Copy link
Contributor

@arpit-chakraborty arpit-chakraborty commented Jan 24, 2025

What kind of change does this PR introduce?

Added css to global css file, added svg's for accept and reject button in RequestsTableItem

Issue Number:

Fixes #3338

Snapshots/Videos:

Screenshot 2025-01-24 195647

Unfortunately I was unable to upload video in my PR so here is the link: https://drive.google.com/file/d/17s9cxRduLIOTrSy23rCN9Bhoi-fV4MC6/view?usp=sharing

Checklist

CodeRabbit AI Review

  • I have reviewed and addressed all critical issues flagged by CodeRabbit AI
  • I have implemented or provided justification for each non-critical suggestion
  • I have documented my reasoning in the PR comments where CodeRabbit AI suggestions were not implemented

Test Coverage

  • I have written tests for all new changes/features
  • I have verified that test coverage meets or exceeds 95%
  • I have run the test suite locally and all tests pass

Have you read the contributing guide?

Yes

Summary by CodeRabbit

  • New Features

    • Added two new icons: AddMember and TrashBin
    • Enhanced RequestsTableItem component with new icon buttons
  • Style Changes

    • Updated CSS styles for RequestsTableItem
    • Migrated styles from module CSS to global app.module.css
  • Documentation

    • Updated line references for various components and functions in documentation files
  • Refactor

    • Adjusted import statements in RequestsTableItem component

Copy link
Contributor

coderabbitai bot commented Jan 24, 2025

Walkthrough

This pull request focuses on refactoring CSS files for the RequestsTableItem component, moving from a component-specific CSS module to the global src/style/app.module.css. The changes involve deleting the RequestsTableItem.module.css file, updating import statements in the RequestsTableItem.tsx component, and adding new styles to the global CSS file. Additionally, the PR introduces two new icons (AddMember and TrashBin) to the IconComponent and updates the corresponding test ID mappings.

Changes

File Change Summary
src/components/RequestsTableItem/RequestsTableItem.module.css Deleted file with component-specific styles
src/components/RequestsTableItem/RequestsTableItem.tsx Updated import from local CSS module to global CSS file, added IconComponent for accept and reject buttons
src/style/app.module.css Added new CSS classes for .tableItem, .index, .name, .email, .acceptButton, and .rejectButton with responsive design
src/components/IconComponent/IconComponent.tsx Added new icon cases for 'AddMember' and 'TrashBin'
src/components/IconComponent/IconComponent.spec.tsx Added test ID mappings for new icons

Assessment against linked issues

Objective Addressed Explanation
Streamline CSS into single global file [#3338]
Delete component-specific CSS files [#3338]
Use descriptive variable names for colors [#3338] Need to verify color variable naming
Remove HTML color code references [#3338] Need to verify in app.module.css

Possibly related issues

Possibly related PRs

Suggested reviewers

  • palisadoes

Poem

🐰 CSS Rabbit's Refactoring Rhyme 🎨

In modules once scattered, now united they stand,
Global styles dancing across the land,
Icons hop in, buttons gleam so bright,
Refactoring magic, a coder's delight!

Hop, hop, hooray! 🎉


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

codecov bot commented Jan 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.74%. Comparing base (6a4eede) to head (802a6fc).
Report is 32 commits behind head on develop-postgres.

Additional details and impacted files
@@                  Coverage Diff                  @@
##           develop-postgres    #3410       +/-   ##
=====================================================
+ Coverage              7.89%   89.74%   +81.84%     
=====================================================
  Files                   312      334       +22     
  Lines                  8171     8637      +466     
  Branches               1838     1921       +83     
=====================================================
+ Hits                    645     7751     +7106     
+ Misses                 7459      623     -6836     
- Partials                 67      263      +196     
Flag Coverage Δ
combined 89.74% <100.00%> (?)
jest 7.89% <0.00%> (?)
vitest 89.74% <100.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

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)
docs/docs/auto-docs/screens/MemberDetail/MemberDetail/functions/default.md (1)

10-13: Improve documentation readability and clarity.

The component description could be improved by:

  1. Adding "the" before "MemberDetail component"
  2. Reducing repetitive sentence beginnings
  3. Consolidating related information

Apply this diff to enhance readability:

-MemberDetail component is used to display the details of a user.
-It also allows the user to update the details. It uses the UPDATE_USER_MUTATION to update the user details.
-It uses the USER_DETAILS query to get the user details. It uses the useLocalStorage hook to store the user details in the local storage.
+The MemberDetail component displays and manages user details. The component leverages UPDATE_USER_MUTATION for updates and USER_DETAILS query for data retrieval. Additionally, it utilizes the useLocalStorage hook for local storage persistence of user information.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~10-~10: You might be missing the article “the” here.
Context: ...ens/MemberDetail/MemberDetail.tsx#L50) MemberDetail component is used to display the detail...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[style] ~12-~12: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ER_MUTATION to update the user details. It uses the USER_DETAILS query to get the ...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~13-~13: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ..._DETAILS query to get the user details. It uses the useLocalStorage hook to store ...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

src/components/RequestsTableItem/RequestsTableItem.tsx (2)

120-122: Add accessibility support for the icon.

The icon is purely decorative, but screen readers may read it without further context. Consider adding an ARIA attribute or a tooltip for clarity. For example:

 <div className={styles.iconWrapper}>
-  <IconComponent name={'AddMember'} fill={'var(--bs-black)'} />
+  <IconComponent
+    name={'AddMember'}
+    fill={'var(--bs-black)'}
+    aria-label="Accept membership request"
+  />
 </div>
 {t('accept')}

135-137: Ensure consistency with accessibility guidelines.

The reject button's icon usage mirrors the accept button. For consistency, provide similar accessibility accommodations by adding helpful ARIA text or ensuring the icon is truly hidden from screen readers if it’s purely decorative.

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

7352-7372: Consider removing negative margins from buttons.

The negative margin-left on buttons could cause layout issues. Consider using positive margins or padding on the parent container instead.

 .acceptButton {
   background: var(--accept-button-bg);
   color: var(--accept-button-text);
   border: 0;
   width: 120px;
   height: 46px;
-  margin-left: -1rem;
   display: flex;
   align-items: center;
 }

 .rejectButton {
   background: var(--red-delete-bg);
   color: var(--red-delete-text);
   border: 0;
   width: 120px;
   height: 46px;
-  margin-left: -1rem;
   display: flex;
   align-items: center;
 }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6a4eede and 802a6fc.

⛔ Files ignored due to path filters (2)
  • src/assets/svgs/addMember.svg is excluded by !**/*.svg
  • src/assets/svgs/trashBin.svg is excluded by !**/*.svg
📒 Files selected for processing (12)
  • docs/docs/auto-docs/components/IconComponent/IconComponent/functions/default.md (1 hunks)
  • docs/docs/auto-docs/components/IconComponent/IconComponent/interfaces/InterfaceIconComponent.md (1 hunks)
  • docs/docs/auto-docs/components/RequestsTableItem/RequestsTableItem/functions/default.md (1 hunks)
  • docs/docs/auto-docs/components/RequestsTableItem/RequestsTableItem/interfaces/InterfaceRequestsListItem.md (2 hunks)
  • docs/docs/auto-docs/screens/MemberDetail/MemberDetail/functions/default.md (1 hunks)
  • docs/docs/auto-docs/screens/MemberDetail/MemberDetail/functions/getLanguageName.md (1 hunks)
  • docs/docs/auto-docs/screens/MemberDetail/MemberDetail/functions/prettyDate.md (1 hunks)
  • src/components/IconComponent/IconComponent.spec.tsx (1 hunks)
  • src/components/IconComponent/IconComponent.tsx (2 hunks)
  • src/components/RequestsTableItem/RequestsTableItem.module.css (0 hunks)
  • src/components/RequestsTableItem/RequestsTableItem.tsx (3 hunks)
  • src/style/app.module.css (2 hunks)
💤 Files with no reviewable changes (1)
  • src/components/RequestsTableItem/RequestsTableItem.module.css
✅ Files skipped from review due to trivial changes (6)
  • docs/docs/auto-docs/components/IconComponent/IconComponent/functions/default.md
  • docs/docs/auto-docs/screens/MemberDetail/MemberDetail/functions/getLanguageName.md
  • docs/docs/auto-docs/screens/MemberDetail/MemberDetail/functions/prettyDate.md
  • docs/docs/auto-docs/components/RequestsTableItem/RequestsTableItem/functions/default.md
  • docs/docs/auto-docs/components/RequestsTableItem/RequestsTableItem/interfaces/InterfaceRequestsListItem.md
  • docs/docs/auto-docs/components/IconComponent/IconComponent/interfaces/InterfaceIconComponent.md
🧰 Additional context used
🪛 GitHub Check: codecov/patch
src/components/IconComponent/IconComponent.tsx

[warning] 157-157: src/components/IconComponent/IconComponent.tsx#L157
Added line #L157 was not covered by tests


[warning] 161-161: src/components/IconComponent/IconComponent.tsx#L161
Added line #L161 was not covered by tests

🪛 LanguageTool
docs/docs/auto-docs/screens/MemberDetail/MemberDetail/functions/default.md

[uncategorized] ~10-~10: You might be missing the article “the” here.
Context: ...ens/MemberDetail/MemberDetail.tsx#L50) MemberDetail component is used to display the detail...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[style] ~12-~12: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ER_MUTATION to update the user details. It uses the USER_DETAILS query to get the ...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~13-~13: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ..._DETAILS query to get the user details. It uses the useLocalStorage hook to store ...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Test Application
🔇 Additional comments (8)
docs/docs/auto-docs/screens/MemberDetail/MemberDetail/functions/default.md (1)

9-9: LGTM!

The function definition location has been correctly updated to reflect the changes in the source file.

src/components/RequestsTableItem/RequestsTableItem.tsx (2)

11-11: Centralizing CSS.

Importing from a shared/global CSS file is a good move for reducing duplication. Ensure that the class names are unique enough to avoid accidental overrides or collisions in this global style.


12-12: Icon component import.

Importing the IconComponent is a clean approach. Check that you have adequate test coverage to confirm that icons are displayed as expected in different scenarios (e.g., invalid names, missing props).

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

7329-7351: LGTM! Table layout styles are well-structured.

The table cell styles provide consistent padding and alignment for good readability.


7374-7402: LGTM! Responsive design is well-implemented.

The media queries provide appropriate adjustments for different screen sizes, with good mobile support.

src/components/IconComponent/IconComponent.spec.tsx (1)

95-102: AddMember & TrashBin test IDs look good.

Both new entries align with existing naming conventions and should be picked up in the loop-based test. Good job extending coverage to these newly introduced icons.

src/components/IconComponent/IconComponent.tsx (2)

22-23: Icon imports are consistent.

These new imports follow the same pattern as other SVG icons. No issues are apparent.


156-163: Investigate coverage discrepancy for AddMember & TrashBin icons.

Despite the test loop referencing these icons, the coverage tool notes lines 157 and 161 as untested. This may be a false positive or a coverage configuration anomaly. Double-check that these switch cases are being exercised in your test runner.

🧰 Tools
🪛 GitHub Check: codecov/patch

[warning] 157-157: src/components/IconComponent/IconComponent.tsx#L157
Added line #L157 was not covered by tests


[warning] 161-161: src/components/IconComponent/IconComponent.tsx#L161
Added line #L161 was not covered by tests

@arpit-chakraborty
Copy link
Contributor Author

Please have a look and let me know if any further changes are required

@palisadoes
Copy link
Contributor

@dhanagopu PTAL

@palisadoes
Copy link
Contributor

  1. @arpit-chakraborty Your work does not match the figma.
  2. Please fix the conflicting file and work with @dhanagopu to review and merge this PR

image

@arpit-chakraborty
Copy link
Contributor Author

Ok sir I will upgrade it

@arpit-chakraborty
Copy link
Contributor Author

Screenshot 2025-01-26 113651
Please have a look and let me know, if it needs any further improvement.

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.

  1. Figma alignments.
    image
  2. Additional changes required
    image

@palisadoes
Copy link
Contributor

  1. We have to close this.
  2. The conflicting file is most likely due to our extensive changes migrating from Admin using a MongoDB backend to PostgreSQL
  3. Please create a new branch based on the latest upstream and resubmit your PR

@palisadoes palisadoes closed this Jan 28, 2025
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