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/DynamicDropdown #3426

Conversation

hars-21
Copy link

@hars-21 hars-21 commented Jan 25, 2025

What kind of change does this PR introduce?

Refactor css for drodown component

Issue Number:

Fixes #3332

Snapshots/Videos:

Screenshot from 2025-01-24 22-41-57

If relevant, did you update the documentation?

Summary

Transferred all existing to app.module.css file
Refactored CSS to make all the css in one global file
Updated source path

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 line number reference for SignOut component documentation
  • Styling

    • Added new CSS classes for cards, sidebar, dropdowns, and action buttons
    • Introduced enhanced visual styles and hover effects
    • Standardized component appearance across the application
  • Component Updates

    • Relocated dropdown styles to a centralized CSS module
    • Minor reorganization of SignOut component's logout function

Copy link
Contributor

coderabbitai bot commented Jan 25, 2025

Walkthrough

This pull request involves refactoring CSS files and updating documentation for the Talawa Admin project. The primary changes include removing the DynamicDropDown.module.css file, updating the import path for CSS styles in the DynamicDropDown component, and moving styles to the global app.module.css file. Additionally, there's a minor documentation update for the SignOut component and a reorganization of the logout function in the SignOut.tsx file.

Changes

File Change Summary
docs/docs/auto-docs/components/SignOut/SignOut/functions/default.md Updated line number reference for default() function
src/components/DynamicDropDown/DynamicDropDown.module.css Deleted CSS file with .dropwdownToggle class
src/components/DynamicDropDown/DynamicDropDown.tsx Updated CSS import path to ../../style/app.module.css
src/components/SignOut/SignOut.tsx Reorganized logout function position
src/style/app.module.css Added new classes: .dropwdownToggle, .cardContainer, .actionBtn, .titlemodalEvents

Assessment against linked issues

Objective Addressed Explanation
Refactor CSS files in src/components/DynamicDropDown [#3332]
Streamline CSS into a single global file
Delete CSS files in the component path
Use descriptive variable names for colors Requires further review of color variables

Possibly related issues

Possibly related PRs

Suggested labels

ignore-sensitive-files-pr

Suggested reviewers

  • palisadoes

Poem

🐰 CSS dancing, files rearranging,
Styles now global, no more estranging!
Dropdowns sleek, imports so neat,
A rabbit's refactor - can't be beat!
Talawa's UI, now smooth and bright! 🎨


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

@hars-21 hars-21 changed the title Refactor CSS dor dynamic dropdown Refactor CSS files in src/components/DynamicDropdown Jan 25, 2025
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: 3

🔭 Outside diff range comments (2)
src/style/app.module.css (2)

Line range hint 334-344: Improve sidebar positioning and scrolling behavior.

The sidebar's absolute positioning and fixed height could cause issues on different screen sizes.

.sidebar:after {
  background-color: var(--grey-border-box-color);
  position: absolute;
  width: 2px;
-  height: 600px;
+  height: 100%;
  top: 10px;
  left: 94%;
  display: block;
+  content: '';
}

Line range hint 885-891: Improve error icon accessibility with ARIA attributes.

The error icon needs proper ARIA labeling for screen readers.

.errorIcon {
  transform: scale(1.5);
  color: var(--bs-danger, var(--delete-button-color));
  margin-bottom: 1rem;

-  /* Add error icon for non-color indication */
-  &::before {
-    content: '⚠️';
-    margin-right: 0.5rem;
-  }
+  &::before {
+    content: '⚠️';
+    margin-right: 0.5rem;
+    speak: none;
+    aria-hidden: true;
+  }
}
🧹 Nitpick comments (5)
src/components/SignOut/SignOut.tsx (1)

24-39: Consider optimizing the logout implementation.

The current implementation could be improved in several ways:

  1. Move handleSignOut outside the logout function to avoid recreating it on every call
  2. Add a loading state during logout
  3. Use more specific error handling

Here's a suggested implementation:

+ const handleSignOut = () => {
+   localStorage.clear();
+   endSession();
+   navigate('/');
+ };
+
+ const [isLoggingOut, setIsLoggingOut] = useState(false);
+
  const logout = async (): Promise<void> => {
-   const handleSignOut = () => {
-     localStorage.clear();
-     endSession();
-     navigate('/');
-   };

    try {
+     setIsLoggingOut(true);
      await revokeRefreshToken();
      handleSignOut();
    } catch (error) {
-     console.error('Error revoking refresh token:', error);
+     if (error instanceof ApolloError) {
+       console.error('GraphQL error during logout:', error.message);
+     } else {
+       console.error('Unexpected error during logout:', error);
+     }
      // Still sign out the user locally even if token revocation fails
      handleSignOut();
+   } finally {
+     setIsLoggingOut(false);
    }
  };
🧰 Tools
🪛 eslint

[error] 25-25: Missing return type on function.

(@typescript-eslint/explicit-function-return-type)

🪛 GitHub Check: Performs linting, formatting, type-checking, checking for different source and target branch

[failure] 25-25:
Missing return type on function

🪛 GitHub Actions: PR Workflow

[error] 25-25: Missing return type on function

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

Line range hint 257-271: Enhance card hover effects for better accessibility and performance.

The card hover effects can be optimized for better performance and accessibility:

.cards:hover {
-  filter: brightness(0.8);
+  opacity: 0.8;
+  transition: opacity 0.2s ease;
}

.cards:hover::before {
-  opacity: 0.5;
+  opacity: 0.4;
+  transition: opacity 0.2s ease;
}

.cards:hover::after {
  opacity: 1;
  mix-blend-mode: normal;
+  transition: all 0.2s ease;
}

Line range hint 3337-3342: Optimize animation performance with GPU acceleration.

Add GPU acceleration to improve animation performance.

@media (prefers-reduced-motion: no-preference) {
  .talawa_logo {
-    -webkit-animation: zoomIn 0.3s ease-in-out;
-    animation: zoomIn 0.3s ease-in-out;
+    -webkit-animation: zoomIn 0.3s ease-in-out;
+    animation: zoomIn 0.3s ease-in-out;
+    transform: translateZ(0);
+    will-change: transform;
  }
}

4373-4384: Improve left drawer layout and scrolling behavior.

The left drawer needs better layout handling and smooth scrolling.

.leftDrawer {
  height: 100vh;
-  /* Ensure it spans the full height */
  background-color: var(--profile-bg);
  overflow-y: auto;
-  /* Enable vertical scrolling */
  transition: transform 0.3s ease;
  will-change: transform;
-  /* NEW */
  position: fixed;
-  /* Ensure it's positioned properly */
  padding-bottom: 1rem;
-  /* Prevent last item clipping */
  overscroll-behavior: contain;
-  /* Improve scroll performance */
  -webkit-overflow-scrolling: touch;
+  scrollbar-width: thin;
+  scrollbar-color: rgba(0, 0, 0, 0.2) transparent;
}

7839-7903: Optimize media queries for better maintainability.

The media queries can be organized better using CSS custom properties for breakpoints.

+:root {
+  --breakpoint-sm: 650px;
+  --breakpoint-md: 900px;
+}

-@media (max-height: 900px) {
+@media (max-height: var(--breakpoint-md)) {
  .leftDrawer {
    width: calc(300px + 1rem);
  }
  /* ... other styles ... */
}

-@media (max-height: 650px) {
+@media (max-height: var(--breakpoint-sm)) {
  .leftDrawer {
    padding: 0.5rem 0.8rem 0 0.8rem;
    width: calc(250px);
  }
  /* ... other styles ... */
}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a52e5ce and b423dc5.

📒 Files selected for processing (5)
  • docs/docs/auto-docs/components/SignOut/SignOut/functions/default.md (1 hunks)
  • src/components/DynamicDropDown/DynamicDropDown.module.css (0 hunks)
  • src/components/DynamicDropDown/DynamicDropDown.tsx (1 hunks)
  • src/components/SignOut/SignOut.tsx (1 hunks)
  • src/style/app.module.css (92 hunks)
💤 Files with no reviewable changes (1)
  • src/components/DynamicDropDown/DynamicDropDown.module.css
✅ Files skipped from review due to trivial changes (2)
  • docs/docs/auto-docs/components/SignOut/SignOut/functions/default.md
  • src/components/DynamicDropDown/DynamicDropDown.tsx
🧰 Additional context used
🪛 eslint
src/components/SignOut/SignOut.tsx

[error] 25-25: Missing return type on function.

(@typescript-eslint/explicit-function-return-type)

🪛 GitHub Check: Performs linting, formatting, type-checking, checking for different source and target branch
src/components/SignOut/SignOut.tsx

[failure] 25-25:
Missing return type on function

🪛 GitHub Actions: PR Workflow
src/components/SignOut/SignOut.tsx

[error] 25-25: Missing return type on function

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyse Code With CodeQL (javascript)

Comment on lines +25 to +29
const handleSignOut = () => {
localStorage.clear();
endSession();
navigate('/');
};
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

Add return type to handleSignOut function.

The missing return type is causing pipeline failures. This should be addressed to maintain type safety throughout the codebase.

Apply this fix:

-   const handleSignOut = () => {
+   const handleSignOut = (): void => {

Note: Moving handleSignOut outside the logout function as suggested in the previous comment would also help resolve this issue more cleanly.

📝 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
const handleSignOut = () => {
localStorage.clear();
endSession();
navigate('/');
};
const handleSignOut = (): void => {
localStorage.clear();
endSession();
navigate('/');
};
🧰 Tools
🪛 eslint

[error] 25-25: Missing return type on function.

(@typescript-eslint/explicit-function-return-type)

🪛 GitHub Check: Performs linting, formatting, type-checking, checking for different source and target branch

[failure] 25-25:
Missing return type on function

🪛 GitHub Actions: PR Workflow

[error] 25-25: Missing return type on function

Comment on lines +4467 to +4468
@extend .reusable-text-ellipsis;
/* Referencing the reusable class from the general section */
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

Improve CSS reusability with proper class extension.

The @extend directives are referencing undefined classes.

-  @extend .reusable-text-ellipsis;
+  text-overflow: ellipsis;
+  white-space: nowrap;
+  overflow: hidden;

-  @extend .reusable-focus-visible;
+  outline: 2px solid var(--focus-color, var(--bs-primary));
+  outline-offset: 2px;

-  @extend .reusable-indicator;
+  content: '';
+  position: absolute;
+  left: 0;
+  top: 50%;
+  transform: translateY(-50%);
+  width: 4px;
+  height: 24px;
+  background-color: var(--bs-primary);
+  border-radius: 2px;

-  @extend .reusable-arrow-indicator;
+  content: '';
+  position: absolute;
+  right: 1rem;
+  top: 50%;
+  transform: translateY(-50%);
+  width: 8px;
+  height: 8px;
+  border-right: 2px solid currentColor;
+  border-bottom: 2px solid currentColor;
+  transform: rotate(-45deg);

Also applies to: 4474-4475, 4499-4500, 4509-4510, 4514-4515

Comment on lines +444 to +457
/* Dynamic Dropdown */
.dropwdownToggle {
background-color: #f1f3f6;
color: black;
width: 100%;
border: none;
padding: 0.5rem;
text-align: left;
display: flex;
align-items: center;
justify-content: space-between;
min-width: 8rem;
outline: 1px solid var(--bs-gray-400);
}
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

Enhance dropdown toggle accessibility and usability.

The dropdown toggle needs ARIA attributes and keyboard navigation improvements.

.dropwdownToggle {
  background-color: #f1f3f6;
  color: black;
  width: 100%;
  border: none;
  padding: 0.5rem;
  text-align: left;
  display: flex;
  align-items: center;
  justify-content: space-between;
  min-width: 8rem;
  outline: 1px solid var(--bs-gray-400);
+  cursor: pointer;
+  transition: background-color 0.2s ease;
+  position: relative;
+  z-index: 1;
}
📝 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
/* Dynamic Dropdown */
.dropwdownToggle {
background-color: #f1f3f6;
color: black;
width: 100%;
border: none;
padding: 0.5rem;
text-align: left;
display: flex;
align-items: center;
justify-content: space-between;
min-width: 8rem;
outline: 1px solid var(--bs-gray-400);
}
/* Dynamic Dropdown */
.dropwdownToggle {
background-color: #f1f3f6;
color: black;
width: 100%;
border: none;
padding: 0.5rem;
text-align: left;
display: flex;
align-items: center;
justify-content: space-between;
min-width: 8rem;
outline: 1px solid var(--bs-gray-400);
cursor: pointer;
transition: background-color 0.2s ease;
position: relative;
z-index: 1;
}

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 merge with the latest upstream
  2. Make sure all tests pass and code rabbit approves the PR
  3. Fix the conflicting files.

Note

File src/style/app.module.css has had significant changes DO NOT overwrite them

@hars-21 hars-21 closed this Jan 27, 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