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] Dark colors | 'groupBy' report limits dropdown #3469

Merged

Conversation

CREDO23
Copy link
Contributor

@CREDO23 CREDO23 commented Dec 23, 2024

Description

Fixes #3466

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings

Previous screenshots

Screenshot from 2024-12-23 18-05-14

Current screenshots

Screenshot from 2024-12-23 17-58-54

Summary by CodeRabbit

  • New Features

    • Introduced dark mode support for the GroupBySelect component, enhancing visual representation for better user experience.
    • Updated styling for selection states in dark mode.
  • Bug Fixes

    • Improved adaptability of text and background colors based on selection and active states in dark mode.

@CREDO23 CREDO23 self-assigned this Dec 23, 2024
@CREDO23 CREDO23 linked an issue Dec 23, 2024 that may be closed by this pull request
Copy link
Contributor

coderabbitai bot commented Dec 23, 2024

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

apps/web/app/[locale]/reports/weekly-limit/components/group-by-select.tsx

Oops! Something went wrong! :(

ESLint: 8.46.0

ESLint couldn't find the config "next/core-web-vitals" to extend from. Please check that the name of the config is correct.

The config "next/core-web-vitals" was referenced from the config file in "/apps/web/.eslintrc.json".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

Walkthrough

The pull request focuses on enhancing the GroupBySelect component in the weekly limit reports section by adding dark mode support. The changes involve modifying the class names for Listbox.Button, Listbox.Options, and Listbox.Option to ensure proper background and text color rendering in dark mode. The core functionality of the component remains unchanged, with the primary goal of improving the visual experience across different color themes.

Changes

File Change Summary
apps/web/app/[locale]/reports/weekly-limit/components/group-by-select.tsx Added dark mode classes to Listbox components for background and text color adaptation

Assessment against linked issues

Objective Addressed Explanation
Fix dark mode colors for Weekly Limit Group By Dropdown [#3466]

Possibly related PRs

Suggested labels

UI/UX

Suggested reviewers

  • evereq
  • Cedric921

Poem

🐰 In the realm of dark and light,
A dropdown's colors now shine bright
With classes that adapt and gleam
Our weekly limits now supreme!
Dark mode magic, code's delight 🌙


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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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
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 (3)
apps/web/app/[locale]/reports/weekly-limit/components/group-by-select.tsx (3)

90-92: Update comment to reflect single-selection behavior

The comment suggests multi-selection behavior ("clearing all selections"), but according to the learnings, only one option can be selected at a time. Please update the comment to accurately reflect the component's behavior.

-// Prevents users from clearing all selections, ensuring at least one option is always selected.
+// Prevents deselection of the only selected option, as one option must always be selected.

94-99: Improve className implementation readability

The className implementation could be more maintainable by extracting the conditional classes into a separate constant or using a utility like clsx or tailwind-merge.

-className={({ active, selected }) =>
-  `relative cursor-default select-none py-2 pl-10 pr-4 ${
-    active
-      ? 'bg-primary/10 text-primary dark:text-white dark:bg-primary/10'
-      : 'text-gray-900 dark:text-white'
-  } ${selected && 'dark:bg-primary/10'}`
-}
+className={({ active, selected }) => {
+  const baseClasses = 'relative cursor-default select-none py-2 pl-10 pr-4';
+  const activeClasses = active
+    ? 'bg-primary/10 text-primary dark:text-white dark:bg-primary/10'
+    : 'text-gray-900 dark:text-white';
+  const selectedClasses = selected ? 'dark:bg-primary/10' : '';
+  
+  return `${baseClasses} ${activeClasses} ${selectedClasses}`;
+}}

Line range hint 105-105: Consider consistent text casing

The option value is lowercase but displayed capitalized. Consider either:

  1. Storing the values in the desired display case, or
  2. Adding a text transform class to handle the display formatting
-<span className={`block truncate ${selected ? 'font-medium' : 'font-normal'}`}>
+<span className={`block truncate capitalize ${selected ? 'font-medium' : 'font-normal'}`}>
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a53760c and f7bd527.

📒 Files selected for processing (1)
  • apps/web/app/[locale]/reports/weekly-limit/components/group-by-select.tsx (2 hunks)
🧰 Additional context used
📓 Learnings (1)
apps/web/app/[locale]/reports/weekly-limit/components/group-by-select.tsx (1)
Learnt from: CREDO23
PR: ever-co/ever-teams#3392
File: apps/web/app/[locale]/reports/weekly-limit/components/group-by-select.tsx:42-51
Timestamp: 2024-12-05T09:04:08.049Z
Learning: In the `GroupBySelect` component (`apps/web/app/[locale]/reports/weekly-limit/components/group-by-select.tsx`), only one option can be selected at a time; two options cannot be selected simultaneously.
🔇 Additional comments (2)
apps/web/app/[locale]/reports/weekly-limit/components/group-by-select.tsx (2)

62-62: LGTM: Dark mode styling for button is properly implemented

The dark mode classes are correctly applied to the Listbox.Button, providing appropriate contrast for both border and background colors while maintaining focus states.


86-86: LGTM: Dropdown options container properly styled for dark mode

The dark mode background is consistently applied to the options container, maintaining visual hierarchy with appropriate z-index and shadow styling.

@evereq evereq merged commit 1caeaf0 into develop Dec 23, 2024
13 checks passed
@evereq evereq deleted the 3466-bug-weekly-limit--group-by-dropdown-dark-colors branch December 23, 2024 16:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug] Weekly Limit | Group By Dropdown Dark Colors
2 participants