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: Funds & Campaign Pages Violate The Figma Style #3478

Conversation

pranavnathe
Copy link
Contributor

@pranavnathe pranavnathe commented Jan 29, 2025

What kind of change does this PR introduce?

This PR updates the styling of the Funds & Campaign Pages to align with the Figma design specifications.

Issue Number:

Fixes #3175

Snapshots/Videos:

OrganizationFunds.mp4

If relevant, did you update the documentation?

Summary

This PR resolves issues related to the design mismatch and ensures the page adheres to the figma design guidelines.

Does this PR introduce a breaking change?

No

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?

Yes

Summary by CodeRabbit

Release Notes

  • Documentation

    • Updated documentation line references for OrganizationFunds component.
  • Style

    • Updated CSS variables for dropdown and switch input styles.
    • Refined styling for CampaignModal close button.
    • Enhanced OrganizationFunds component styling with CSS variables.
    • Improved styling consistency for DataGrid component, including updated hover effects and border properties.
  • User Experience

    • Added dynamic document title setting for OrganizationFunds page.
    • Updated header name for 'Sr. No.' column in DataGrid.

Copy link
Contributor

coderabbitai bot commented Jan 29, 2025

Walkthrough

This pull request involves updates to documentation and styling across several files. The changes include updating the documentation for the default() function in the OrganizationFunds component, modifying the class name for a close button in the CampaignModal, and refining the styling in the OrganizationFunds.tsx and app.module.css files. The modifications aim to enhance code maintainability, styling consistency, and user experience by utilizing CSS variables and dynamically setting document titles.

Changes

File Change Summary
docs/docs/auto-docs/screens/OrganizationFunds/OrganizationFunds/functions/default.md Updated function definition line number from 103 to 99
src/screens/OrganizationFundCampaign/CampaignModal.tsx Changed close button class from styles.modalCloseBtn to styles.closeButton
src/screens/OrganizationFunds/OrganizationFunds.tsx Updated dataGridStyle to use CSS variables, added document title setting
src/style/app.module.css Added new CSS variable --hyperlink-text-color, modified .dropdown border property, added focus style for .switch input, and defined .hyperlinkText class

Assessment against linked issues

Objective Addressed Explanation
Conform to Figma Style Guide [#3175]
Consolidate CSS into src/style/app.module.css [#3175]
Use variable names describing color function [#3175]
Remove HTML color codes except in app.module.css [#3175]

Possibly related issues

Possibly related PRs

Suggested labels

ignore-sensitive-files-pr

Suggested reviewers

  • palisadoes

Poem

🐰 Styling Rabbit's Rhyme 🎨
With variables bright and lines just right,
CSS dancing in the moonlight,
Docs updated, classes refined,
A code symphony, perfectly aligned!
Hop, hop, hooray for clean design! 🌈


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

🧹 Nitpick comments (2)
src/screens/OrganizationFunds/OrganizationFunds.tsx (2)

23-38: LGTM! Consider documenting CSS variables.

Good job replacing hardcoded values with CSS variables for better maintainability and design consistency. Consider adding a comment documenting the expected values of these CSS variables for future reference.

Add a comment like this above the dataGridStyle object:

+/**
+ * CSS Variables used:
+ * --table-head-radius: Border radius for the table header
+ * --row-background: Background color for table rows
+ */
const dataGridStyle = {

105-107: Consider using useEffect for document title.

While setting the document title is good for accessibility, it's better to handle it using React's useEffect hook for consistency with React's lifecycle.

  const { t: tCommon } = useTranslation('common');

-  // Set the document title based on the translation
-  document.title = t('title');
+  useEffect(() => {
+    document.title = t('title');
+  }, [t]);

  const { orgId } = useParams();
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 714f5a5 and b2c6b7c.

📒 Files selected for processing (4)
  • docs/docs/auto-docs/screens/OrganizationFunds/OrganizationFunds/functions/default.md (1 hunks)
  • src/screens/OrganizationFundCampaign/CampaignModal.tsx (1 hunks)
  • src/screens/OrganizationFunds/OrganizationFunds.tsx (3 hunks)
  • src/style/app.module.css (3 hunks)
✅ Files skipped from review due to trivial changes (2)
  • src/screens/OrganizationFundCampaign/CampaignModal.tsx
  • docs/docs/auto-docs/screens/OrganizationFunds/OrganizationFunds/functions/default.md
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Test Application
🔇 Additional comments (2)
src/screens/OrganizationFunds/OrganizationFunds.tsx (1)

337-337: LGTM! Consistent styling applied.

Good use of modular CSS class for the dropdown styling, maintaining consistency with the project's CSS architecture.

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

570-570: LGTM! Improved color variable consistency.

The border property now uses the standardized --dropdown-border variable instead of the specific --dropdown-border-color, which better aligns with the design system's color variables.

src/style/app.module.css Show resolved Hide resolved
Copy link

codecov bot commented Jan 29, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.80%. Comparing base (73cf8cd) to head (1b77948).
Report is 13 commits behind head on develop-postgres.

Additional details and impacted files
@@                  Coverage Diff                  @@
##           develop-postgres    #3478       +/-   ##
=====================================================
+ Coverage              1.90%   88.80%   +86.89%     
=====================================================
  Files                   316      338       +22     
  Lines                  8249     8627      +378     
  Branches               1880     1922       +42     
=====================================================
+ Hits                    157     7661     +7504     
+ Misses                 8083      636     -7447     
- Partials                  9      330      +321     

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

coderabbitai[bot]
coderabbitai bot previously approved these changes Jan 29, 2025
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. Please fix
    image
  2. Please fix
    image
  3. Please fix
    image

@pranavnathe
Copy link
Contributor Author

Hi @palisadoes,
I checked the other pages but couldn't find a consistent color being used for hyperlinks. Could you suggest a color that would work well? In the Figma design, the color #1778F2 has been used —would you recommend using that?

@palisadoes
Copy link
Contributor

Hi @palisadoes, I checked the other pages but couldn't find a consistent color being used for hyperlinks. Could you suggest a color that would work well? In the Figma design, the color #1778F2 has been used —would you recommend using that?

Yes that's OK

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

🧹 Nitpick comments (2)
src/screens/OrganizationFundCampaign/OrganizationFundCampagins.tsx (2)

190-190: Enhance accessibility of the '#' column header.

While '#' is a common convention, screen readers might not properly announce it. Consider adding an aria-label to provide a more descriptive label for screen readers.

 {
   field: 'id',
-  headerName: '#',
+  headerName: '#',
+  renderHeader: () => (
+    <div aria-label="Serial Number">#</div>
+  ),
   flex: 1,
   minWidth: 100,

Line range hint 190-199: Enhance type safety for GridCellParams.

Consider adding specific type parameters to GridCellParams to better type the row data structure.

-renderCell: (params: GridCellParams) => {
+renderCell: (params: GridCellParams<any, { id: number; campaign: InterfaceCampaignInfo }>) => {
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ae65ed7 and 1b77948.

📒 Files selected for processing (3)
  • src/screens/OrganizationFundCampaign/OrganizationFundCampagins.tsx (3 hunks)
  • src/screens/OrganizationFunds/OrganizationFunds.tsx (5 hunks)
  • src/style/app.module.css (5 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • src/screens/OrganizationFunds/OrganizationFunds.tsx
  • src/style/app.module.css
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Test Application
🔇 Additional comments (1)
src/screens/OrganizationFundCampaign/OrganizationFundCampagins.tsx (1)

212-212: LGTM! Verify hyperlink color implementation.

The change to use styles.hyperlinkText aligns with the team's decision to standardize hyperlink colors to #1778F2.

Run this script to verify the hyperlink color implementation:

✅ Verification successful

Verified: Hyperlink color matches team standard

The hyperlinkText class correctly implements the agreed-upon #1778F2 color through the CSS variable --hyperlink-text-color.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that the hyperlinkText class uses the agreed color #1778F2

# Search for hyperlinkText class definition and its color
rg -l "hyperlinkText" --type css
rg "hyperlinkText.*color.*1778F2" --type css

Length of output: 104


Script:

#!/bin/bash
# Check the actual implementation of hyperlinkText class
rg "hyperlinkText" -A 5 -B 5 src/style/app.module.css

Length of output: 368


Script:

#!/bin/bash
# Find the definition of --hyperlink-text-color variable
rg "--hyperlink-text-color" --type css

Length of output: 463


Script:

#!/bin/bash
# Search for hyperlink color variable definition, escaping the double dash
rg "\-\-hyperlink-text-color" --type css

Length of output: 165

@pranavnathe
Copy link
Contributor Author

Fundraising.Campaigns.Fix.mov

I've fixed the requested issues. Please take a look

@palisadoes palisadoes self-requested a review January 30, 2025 03:07
@palisadoes palisadoes merged commit 891ac62 into PalisadoesFoundation:develop-postgres Jan 30, 2025
19 checks passed
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