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

fix(styles): adjust and refine organization tags styling #3251

Conversation

bruno-keiko
Copy link

@bruno-keiko bruno-keiko commented Jan 11, 2025

What kind of change does this PR introduce?

Issue Number:

Fixes #3173

Snapshots/Videos:

image
image

If relevant, did you update the documentation?

Summary

Does this PR introduce a breaking change?

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

Other information

Have you read the contributing guide?

Summary by CodeRabbit

Release Notes

  • UI Improvements

    • Enhanced visual design of DataGrid components
    • Updated search and edit icons for better user interaction
    • Refined styling of input fields and search buttons
  • Visual Updates

    • Adjusted color schemes and shadow effects
    • Modernized button and icon representations
    • Improved overall component aesthetics

Copy link
Contributor

coderabbitai bot commented Jan 11, 2025

Important

Review skipped

More than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review.

152 files out of 275 files are above the max files limit of 75. Please upgrade to Pro plan to get higher limits.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The pull request introduces visual and styling modifications across multiple files in the Talawa Admin application. Changes include updating the ManageTag and OrganizationTags components with new icons, refining the DataGrid appearance, and adjusting CSS properties in the app.module.css file. The modifications aim to enhance the user interface's visual consistency and align with the Figma design guidelines.

Changes

File Change Summary
src/screens/ManageTag/ManageTag.tsx Added inline style to noRowsOverlay slot, changing background color to white
src/screens/OrganizationTags/OrganizationTags.tsx Added Edit and Search icons, updated button styling, modified DataGrid row background and border radius
src/style/app.module.css Enhanced box-shadow for .inputField, modified .searchButton styling, removed border color

Assessment against linked issues

Objective Addressed Explanation
Conform to Figma Style Guide [#3173]
Migrate away from green theme
Consolidate CSS using variables Some variables used, but full consolidation unclear
Use appropriate blue/grey colors

Possibly related issues

Possibly related PRs

Suggested labels

ignore-sensitive-files-pr

Suggested reviewers

  • palisadoes
  • AVtheking
  • pranshugupta54

Poem

🐰 In the realm of pixels and style,
A rabbit hops through code with a smile
Icons dance, shadows grow bright
Figma's guide now shines just right
Refactoring magic, clean and neat
Our UI journey is now complete! 🎨


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

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Congratulations on making your first PR! 🎊 If you haven't already, check out our Contributing Guidelines and PR Reporting Guidelines to ensure that you are following our guidelines for contributing and creating PR.

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: 2

🧹 Nitpick comments (1)
src/screens/OrganizationTags/OrganizationTags.tsx (1)

Line range hint 391-407: Consider memoizing the noRowsOverlay component

The noRowsOverlay component is recreated on every render. Consider memoizing it with useMemo for better performance.

+const NoRowsOverlay = React.memo(() => (
+  <Stack
+    height="100%"
+    sx={{ backgroundColor: 'white' }}
+    alignItems="center"
+    justifyContent="center"
+  >
+    {t('noTagsFound')}
+  </Stack>
+));

// In DataGrid configuration
slots={{
-  noRowsOverlay: () => (
-    <Stack
-      height="100%"
-      sx={{ backgroundColor: 'white' }}
-      alignItems="center"
-      justifyContent="center"
-    >
-      {t('noTagsFound')}
-    </Stack>
-  ),
+  noRowsOverlay: NoRowsOverlay,
}}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b3f21a5 and ae8acd1.

📒 Files selected for processing (3)
  • src/screens/ManageTag/ManageTag.tsx (1 hunks)
  • src/screens/OrganizationTags/OrganizationTags.tsx (6 hunks)
  • src/style/app.module.css (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • src/screens/ManageTag/ManageTag.tsx
🔇 Additional comments (5)
src/style/app.module.css (2)

175-177: Verify the shadow intensity aligns with design system

The box-shadow has been significantly increased from a subtle 1px to a more pronounced 5px offset. While this adds depth, it might be too strong for input fields which are typically secondary UI elements.

Please confirm if this shadow intensity matches the Figma design guidelines and maintains proper visual hierarchy with other elements.


194-196: Verify button height alignment with input field

The search button modifications:

  • Remove the border for a cleaner look
  • Set a fixed height of 48px

Please ensure that:

  1. The 48px height aligns properly with the adjacent input field height
  2. The button remains vertically centered when the input field has different heights (e.g., multi-line content)
src/screens/OrganizationTags/OrganizationTags.tsx (3)

289-289: Nice UI enhancement!

The addition of the Edit icon improves the button's visual clarity and user experience.


Line range hint 414-429: Review commented-out outline styles

There are commented-out outline styles in the DataGrid configuration. These should either be:

  1. Removed if no longer needed
  2. Implemented if they're part of the accessibility/UX requirements

Please clarify if these outline styles are still needed for focus states and accessibility.


367-375: Good cleanup!

Removing the commented-out IconComponent section improves code maintainability.

backgroundColor: '#EAEBEF',
'& .MuiDataGrid-row': {
backgroundColor: '#eff1f7',
backgroundColor: '#fffff',
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix invalid hex color code

The background color hex code '#fffff' is invalid (has 6 f's). It should be '#ffffff' for white.

-backgroundColor: '#fffff',
+backgroundColor: '#ffffff',
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
backgroundColor: '#fffff',
backgroundColor: '#ffffff',

Comment on lines +302 to +307
<Button
className={`${styles.searchButton} `}
data-testid={'searchbtn'}
>
<Search className={styles.searchIcon} />
</Button>
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Add accessibility attributes and click handler to search button

The search button implementation needs improvement in the following areas:

  • Missing onClick handler for search functionality
  • Missing aria-label for screen readers
  • No visible text label alongside the icon
 <Button
   className={`${styles.searchButton} `}
   data-testid={'searchbtn'}
+  onClick={() => {/* implement search logic */}}
+  aria-label="Search tags"
 >
   <Search className={styles.searchIcon} />
+  <span className="visually-hidden">Search</span>
 </Button>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<Button
className={`${styles.searchButton} `}
data-testid={'searchbtn'}
>
<Search className={styles.searchIcon} />
</Button>
<Button
className={`${styles.searchButton} `}
data-testid={'searchbtn'}
onClick={() => {/* implement search logic */}}
aria-label="Search tags"
>
<Search className={styles.searchIcon} />
<span className="visually-hidden">Search</span>
</Button>

palisadoes and others added 3 commits January 11, 2025 14:18
* 20250110082558 Deleted all files in the main branch in anticipation of merging develop into main cleanly

* 20250110082559 Merge develop into main
* 20250110084643 Deleted all files in the main branch in anticipation of merging develop-postgres into main cleanly

* 20250110084645 Merge develop-postgres into main
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.

Figma: Tags Pages Violate The Figma Style Guide
2 participants