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

Figma user portal organization screen violates the figma style guide #3197 #3394

Conversation

khushipatil1523
Copy link
Contributor

@khushipatil1523 khushipatil1523 commented Jan 23, 2025

What kind of change does this PR introduce?

UI/UX improvement, refactoring of CSS for better accessibility and maintainability.

Issue Number:

Fixes #3197

Description
This PR addresses the issue "Organization Screen Violates the Figma Style Guide" by implementing the following changes:

Changes Made
Consolidated all CSS into src/style/app.module.css:

here is video of Updated the Organization Screen to match the Figma style guide:

output.compress-video-online.com.mp4

Applied proper spacing, alignment, and colors as per the provided Figma file.

Standardized buttons and dropdowns with hover shadows but no color changes.

Ensured search boxes only show shadows when selected.
Does this PR introduce a breaking change?

No, this PR does not introduce breaking changes. It only refactors styles and updates UI components for consistency and accessibility.

Summary by CodeRabbit

Release Notes

  • Style Updates

    • Comprehensive redesign of application styles
    • Enhanced organization card layouts
    • Updated color schemes and background properties
    • Improved responsive design for various screen sizes
  • UI Refinements

    • Simplified organization listing
    • Removed pagination from organization screen
    • Updated search functionality
    • Integrated new profile dropdown component
  • Performance

    • Streamlined component structures
    • Removed unnecessary CSS modules

These changes focus on improving the visual consistency and user experience of the application's organization and user portal sections.

Copy link
Contributor

coderabbitai bot commented Jan 23, 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.

217 files out of 300 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

This pull request focuses on consolidating CSS files into a single global stylesheet (src/style/app.module.css) and removing individual CSS module files across multiple components. The changes involve deleting specific CSS module files like ProfileDropdown.module.css, OrganizationCard.module.css, UserSidebar.module.css, Organizations.module.css, and updating the corresponding TypeScript components to use the global stylesheet. The modifications aim to standardize styling, improve maintainability, and adhere to the Figma design guidelines.

Changes

File Path Change Summary
src/components/ProfileDropdown/ProfileDropdown.module.css Deleted CSS module file
src/components/ProfileDropdown/ProfileDropdown.tsx Updated to use global stylesheet and simplified component structure
src/components/UserPortal/OrganizationCard/OrganizationCard.module.css Deleted CSS module file
src/components/UserPortal/OrganizationCard/OrganizationCard.tsx Updated to use global stylesheet and adjusted layout
src/components/UserPortal/UserSidebar/UserSidebar.module.css Deleted CSS module file
src/components/UserPortal/UserSidebar/UserSidebar.tsx Updated component name, styling, and added ProfileDropdown
src/screens/OrgList/OrgList.tsx Updated sorting functionality and organization list rendering
src/screens/UserPortal/Organizations/Organizations.module.css Deleted CSS module file
src/screens/UserPortal/Organizations/Organizations.tsx Removed pagination and updated search functionality
src/style/app.module.css Added new CSS classes, variables, and consolidated styles from deleted files

Assessment against linked issues

Objective Addressed Explanation
Consolidate CSS into src/style/app.module.css
Remove individual CSS module files
Use descriptive color variable names
Remove HTML color codes except in global CSS
Conform to Figma style guide Requires visual verification

Possibly related issues

Possibly related PRs

Suggested reviewers

  • palisadoes

Poem

🐰 CSS Consolidation Hop! 🎨

In the realm of styles so bright,
We've merged our modules, made them tight.
One stylesheet to rule them all,
No more scattered CSS to enthrall!

A rabbit's code refactor dance! 🕺


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

🔭 Outside diff range comments (2)
src/components/UserPortal/OrganizationCard/OrganizationCard.tsx (1)

Line range hint 87-114: Enhance error handling in joinOrganization function.

The error handling can be improved to handle more specific error cases and provide better user feedback.

 async function joinOrganization(): Promise<void> {
   try {
     if (props.userRegistrationRequired) {
       await sendMembershipRequest({
         variables: {
           organizationId: props.id,
         },
       });
       toast.success(t('MembershipRequestSent') as string);
     } else {
       await joinPublicOrganization({
         variables: {
           organizationId: props.id,
         },
       });
       toast.success(t('orgJoined') as string);
     }
     refetch();
   } catch (error: unknown) {
-    if (error instanceof Error) {
-      if (error.message === 'User is already a member') {
-        toast.error(t('AlreadyJoined') as string);
-      } else {
-        toast.error(t('errorOccured') as string);
-      }
+    if (error instanceof Error) {
+      const errorMessages: Record<string, string> = {
+        'User is already a member': t('AlreadyJoined'),
+        'Network error': t('networkError'),
+        'Invalid organization': t('invalidOrg'),
+      };
+      toast.error((errorMessages[error.message] || t('errorOccured')) as string);
+      console.error('Join organization error:', error);
     }
   }
 }
src/components/ProfileDropdown/ProfileDropdown.tsx (1)

Line range hint 41-58: Improve error handling in logout function.

The logout function should handle errors more gracefully and provide user feedback.

 const logout = async (): Promise<void> => {
   try {
     await revokeRefreshToken();
+    localStorage.clear();
+    endSession();
+    navigate('/');
   } catch (error) {
-    console.error('Error revoking refresh token:', error);
+    // Still clear session even if token revocation fails
+    localStorage.clear();
+    endSession();
+    navigate('/');
+    toast.error(t('logoutError'));
+    console.error('Error during logout:', error);
   }
-  localStorage.clear();
-  endSession();
-  navigate('/');
 };
🧹 Nitpick comments (10)
src/components/UserPortal/UserSidebar/UserSidebar.tsx (3)

56-58: Move inline styles to CSS module.

Inline styles should be avoided for better maintainability. Consider moving the background color to the CSS module.

-              style={{
-                backgroundColor: isActive === true ? '#EAEBEF' : '',
-              }}
+              className={`${
+                isActive === true ? styles.activeNavButton : ''
+              }`}

Add to app.module.css:

.activeNavButton {
  background-color: #EAEBEF;
}

62-90: Standardize icon property usage.

The icons use inconsistent properties:

  • OrganizationsIcon uses fill
  • SettingsIcon uses stroke

This makes maintenance more difficult and could lead to visual inconsistencies.

Consider standardizing to use either fill or stroke consistently for all icons.


31-40: Consider enhancing accessibility attributes.

The sidebar could benefit from additional accessibility attributes:

  • Add role="navigation" to the sidebar container
  • Add aria-label to describe the navigation purpose
 <div
      className={`${styles.leftDrawer} ${
        hideDrawer === null
          ? styles.hideElemByDefault
          : hideDrawer
            ? styles.inactiveDrawer
            : styles.activeDrawer
      }`}
+     role="navigation"
+     aria-label="User navigation sidebar"
      data-testid="leftDrawerContainer"
src/components/UserPortal/OrganizationCard/OrganizationCard.tsx (3)

166-170: Improve accessibility for organization name tooltip.

The tooltip should include ARIA attributes for better screen reader support.

-<Tooltip title={props.name} placement="top-end">
+<Tooltip 
+  title={props.name} 
+  placement="top-end"
+  aria-label={`Organization name: ${props.name}`}
+>

174-186: Optimize conditional rendering of address.

The address check can be simplified using optional chaining as suggested by static analysis.

-{props.address && props.address.city && (
+{props.address?.city && (
🧰 Tools
🪛 Biome (1.9.4)

[error] 174-174: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)


195-206: Consider consolidating membership action buttons.

The three separate conditional blocks for buttons can be simplified using a switch statement or object mapping for better maintainability.

-{props.membershipRequestStatus === 'accepted' && (
-  <Button /* ... */ />
-)}
-{props.membershipRequestStatus === '' && (
-  <Button /* ... */ />
-)}
-{props.membershipRequestStatus === 'pending' && (
-  <Button /* ... */ />
-)}
+{(() => {
+  const buttonConfig = {
+    accepted: {
+      variant: "outline-success",
+      onClick: () => navigate(`/user/organization/${props.id}`),
+      text: t('visit'),
+      className: styles.joinedBtn,
+      'data-testid': "manageBtn"
+    },
+    '': {
+      variant: "outline-success",
+      onClick: joinOrganization,
+      text: t('joinNow'),
+      className: styles.joinBtn,
+      'data-testid': "joinBtn"
+    },
+    pending: {
+      variant: "danger",
+      onClick: withdrawMembershipRequest,
+      text: t('withdraw'),
+      className: styles.withdrawBtn,
+      'data-testid': "withdrawBtn"
+    }
+  }[props.membershipRequestStatus];
+  
+  return buttonConfig && <Button {...buttonConfig}>{buttonConfig.text}</Button>;
+})()}

Also applies to: 207-216, 217-226

src/screens/UserPortal/Organizations/Organizations.tsx (2)

357-386: Optimize organization list rendering performance.

The organization list mapping can be optimized to prevent unnecessary re-renders.

+const OrganizationCardMemo = React.memo(OrganizationCard);

 <div className={`${styles.OrgList}`}>
   {organizations.map(
     (organization: InterfaceOrganization, index) => {
       const cardProps: InterfaceOrganizationCardProps = {
         name: organization.name,
         image: organization.image,
         id: organization._id,
         description: organization.description,
         admins: organization.admins,
         members: organization.members,
         address: organization.address,
         membershipRequestStatus:
           organization.membershipRequestStatus,
         userRegistrationRequired:
           organization.userRegistrationRequired,
         membershipRequests: organization.membershipRequests,
       };

       return (
         <div
           key={organization._id} // Use unique ID instead of index
           className={`${styles.cardcontainer}`}
           style={{ width: '48%', marginBottom: '20px' }}
         >
-          <OrganizationCard {...cardProps} />
+          <OrganizationCardMemo {...cardProps} />
         </div>
       );
     },
   )}
 </div>

295-296: Remove commented code.

Remove unnecessary commented code that adds noise to the codebase.

-            {/* <div className='SearchandDropdown'> */}
src/style/app.module.css (2)

6036-6046: Optimize box-shadow performance.

The box-shadow property can impact rendering performance. Consider using transform: translateZ(0) to enable GPU acceleration.

 .orgCard {
   background-color: var(--bs-white);
   margin: 0.5rem;
   height: calc(135px + 2rem);
   padding: 1rem;
   border-radius: 8px;
-  box-shadow: 0 1.5px 1.5px rgba(0, 0, 0, 0.3);
+  box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
   transition: box-shadow 0.3s ease;
   outline: 1px solid var(--bs-gray-200);
   position: relative;
   box-sizing: border-box;
+  transform: translateZ(0);
+  will-change: transform;
 }

6169-6180: Enhance responsive design breakpoints.

The media queries can be improved to use standardized breakpoints and handle more screen sizes.

-@media (max-width: 1024px) {
+@media (max-width: var(--breakpoint-desktop)) {
   .OrgList > .cardcontainer {
     flex: 0 1 100%;
   }
 }

-@media (max-width: 768px) {
+@media (max-width: var(--breakpoint-tablet)) {
   .OrgList > .cardcontainer {
     flex: 0 1 100%;
+    margin: 0.5rem 0;
   }
 }
+
+@media (max-width: var(--breakpoint-mobile)) {
+  .OrgList > .cardcontainer {
+    margin: 0.25rem 0;
+  }
+}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b99eba7 and a0be8a3.

📒 Files selected for processing (10)
  • src/components/ProfileDropdown/ProfileDropdown.module.css (0 hunks)
  • src/components/ProfileDropdown/ProfileDropdown.tsx (3 hunks)
  • src/components/UserPortal/OrganizationCard/OrganizationCard.module.css (0 hunks)
  • src/components/UserPortal/OrganizationCard/OrganizationCard.tsx (2 hunks)
  • src/components/UserPortal/UserSidebar/UserSidebar.module.css (0 hunks)
  • src/components/UserPortal/UserSidebar/UserSidebar.tsx (1 hunks)
  • src/screens/OrgList/OrgList.tsx (0 hunks)
  • src/screens/UserPortal/Organizations/Organizations.module.css (0 hunks)
  • src/screens/UserPortal/Organizations/Organizations.tsx (3 hunks)
  • src/style/app.module.css (3 hunks)
💤 Files with no reviewable changes (5)
  • src/screens/UserPortal/Organizations/Organizations.module.css
  • src/components/UserPortal/UserSidebar/UserSidebar.module.css
  • src/components/ProfileDropdown/ProfileDropdown.module.css
  • src/screens/OrgList/OrgList.tsx
  • src/components/UserPortal/OrganizationCard/OrganizationCard.module.css
🧰 Additional context used
🪛 Biome (1.9.4)
src/components/UserPortal/OrganizationCard/OrganizationCard.tsx

[error] 174-174: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

🔇 Additional comments (2)
src/components/UserPortal/UserSidebar/UserSidebar.tsx (2)

8-11: LGTM! Import changes align with CSS consolidation.

The changes to import statements correctly implement the CSS consolidation strategy mentioned in the PR objectives.


97-99: LGTM! Clean integration of ProfileDropdown.

The ProfileDropdown component is well-integrated at the bottom of the sidebar with proper styling wrapper.

@palisadoes
Copy link
Contributor

Please fix the conflicting files

coderabbitai[bot]
coderabbitai bot previously approved these changes Jan 24, 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 the linting error
  2. Styling changes required
    image
  3. More
    image

@palisadoes
Copy link
Contributor

Please fix the conflicting files

@khushipatil1523 khushipatil1523 force-pushed the Figma_User_Portal_Organization_Screen_Violates_The_Figma_Style_Guide_#3197 branch from a1a78f5 to 97f2f50 Compare January 26, 2025 15:52
@khushipatil1523
Copy link
Contributor Author

  1. Please fix the linting error
  2. Styling changes required
    image
  3. More
    image

changes done

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