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

[Feat]: Improve activity modal UI #3585

Merged
merged 3 commits into from
Feb 7, 2025
Merged

Conversation

Innocent-Akim
Copy link
Contributor

@Innocent-Akim Innocent-Akim commented Feb 4, 2025

Description

#3251

Please include a summary of the changes and the related issues.

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 on my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings

Previous screenshots

Please add here videos or images of the previous status

Current screenshots

Please add here videos or images of the current (new) status

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features

    • Introduced a new control that opens a detailed view of employee activity logs.
    • Enhanced localization in dashboard navigation for improved language support.
  • Style

    • Refined the visual presentation in modals and tables by adjusting avatar size, text scaling, and spacing.
    • Improved layout consistency during loading and no-data states with increased component heights.

Copy link
Contributor

coderabbitai bot commented Feb 4, 2025

Walkthrough

This update refines the UI elements for the team dashboard. In the ActivityModal, padding and font sizes have been adjusted to alter the visual hierarchy. In the TeamStatsTable, a new state variable is introduced to manage an employee's log, triggering a conditional modal display upon button click; additionally, layout heights have been increased for loading and no data states. The TeamDashboard page now incorporates localized breadcrumb support and updated styling, ensuring translations are recalculated and the layout is adjusted consistently.

Changes

File(s) Change Summary
apps/web/app/[locale]/…/components/activity-modal.tsx Modified styling: removed p-5 padding class on Modal, reduced Avatar size from 40 to 30, and changed h3 text class from text-xl to text-lg.
apps/web/app/[locale]/…/components/team-stats-table.tsx Introduced employeeLog state variable, added a button to set the state and trigger modal rendering, and increased the min-height for loading/no data states from 400px to 500px.
apps/web/app/[locale]/…/page.tsx Imported useTranslations and updated breadcrumb navigation with localized strings, adjusted Container class to include !px-4, and increased Card component min-height from 400px to 500px.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Table as TeamStatsTable
    participant State as EmployeeLog State
    participant Modal as ActivityModal

    User->>Table: Click "View Activity" button
    Table->>State: Set employeeLog state with selected log
    State-->>Table: Updated employeeLog
    Table->>Modal: Render ActivityModal conditionally
    Modal-->>User: Display employee activity details
Loading

Possibly related PRs

  • [Feat]: Improve timesheet and Activity reporting #3590: The changes in the main PR are related to the same ActivityModal component as those in the retrieved PR, specifically focusing on styling adjustments within that component.
  • [Improvement] Team Dashboard | Card Data & UI #3556: The changes in the main PR are related to the modifications in the TeamStatsTable component of the retrieved PR, as both involve updates to the styling and presentation of the modal and table components within the same dashboard context.
  • [Fea]: Activity Modal #3551: The changes in the main PR are related to the modifications in the ActivityModal component, as both involve updates to the styling and functionality of the modal that displays employee activity logs.

Suggested labels

UI/UX, WEB, Improvement, Ever Teams

Suggested reviewers

  • evereq

Poem

I'm a rabbit with a cheerful beat,
Hopping through code with nimble feet.
Changes refined, small yet neat,
Making UIs a delightful treat.
Coding carrots in each line so sweet! 🥕🐇

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]/dashboard/team-dashboard/[teamId]/components/activity-modal.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.

apps/web/app/[locale]/dashboard/team-dashboard/[teamId]/components/team-stats-table.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.

apps/web/app/[locale]/dashboard/team-dashboard/[teamId]/page.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.

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.

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.

@Innocent-Akim Innocent-Akim self-assigned this Feb 4, 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: 2

🧹 Nitpick comments (3)
apps/web/app/[locale]/dashboard/team-dashboard/[teamId]/components/activity-modal.tsx (1)

92-97: Enhance modal accessibility.

Consider adding ARIA attributes to improve the modal's accessibility.

 <Modal
   isOpen={isOpen}
   closeModal={closeModal}
   className="bg-light--theme-light dark:bg-dark--theme-light rounded-xl w-full md:w-40 md:min-w-[32rem] justify-start h-[auto]"
   titleClass="font-bold flex justify-start w-full"
+  aria-labelledby="activity-modal-title"
+  aria-describedby="activity-modal-description"
 >

Also update the heading:

-<h3 className="text-lg font-medium text-gray-900 dark:text-gray-100">
+<h3 id="activity-modal-title" className="text-lg font-medium text-gray-900 dark:text-gray-100">
apps/web/app/[locale]/dashboard/team-dashboard/[teamId]/components/team-stats-table.tsx (2)

173-186: Remove unnecessary Fragment.

The Fragment wrapper is redundant as it contains only one child.

-<>
 <Button
   variant="ghost"
   size="icon"
   onClick={() => {
     setEmployeeLog(employeeLog);
     openModal();
   }}
   aria-label={`View activity chart for ${employeeLog.employee?.user?.name || 'employee'}`}
   title="View activity chart">
   <ChartIcon />
 </Button>
-</>
🧰 Tools
🪛 Biome (1.9.4)

[error] 173-185: Avoid using unnecessary Fragment.

A fragment is redundant if it contains only one child, or if it is the child of a html element, and is not a keyed fragment.
Unsafe fix: Remove the Fragment

(lint/complexity/noUselessFragments)


204-238: Enhance pagination buttons accessibility.

Add descriptive aria-labels to pagination buttons for better screen reader support.

-<Button variant="outline" size="icon" onClick={goToFirstPage} disabled={currentPage === 1}>
+<Button 
+  variant="outline" 
+  size="icon" 
+  onClick={goToFirstPage} 
+  disabled={currentPage === 1}
+  aria-label="Go to first page"
+>
   <ChevronsLeft className="w-4 h-4" />
 </Button>

Apply similar changes to other pagination buttons.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 796a9b8 and bcd9b0b.

📒 Files selected for processing (3)
  • apps/web/app/[locale]/dashboard/team-dashboard/[teamId]/components/activity-modal.tsx (1 hunks)
  • apps/web/app/[locale]/dashboard/team-dashboard/[teamId]/components/team-stats-table.tsx (3 hunks)
  • apps/web/app/[locale]/dashboard/team-dashboard/[teamId]/page.tsx (4 hunks)
🧰 Additional context used
🪛 Biome (1.9.4)
apps/web/app/[locale]/dashboard/team-dashboard/[teamId]/components/team-stats-table.tsx

[error] 173-185: Avoid using unnecessary Fragment.

A fragment is redundant if it contains only one child, or if it is the child of a html element, and is not a keyed fragment.
Unsafe fix: Remove the Fragment

(lint/complexity/noUselessFragments)

⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: deploy
  • GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (3)
apps/web/app/[locale]/dashboard/team-dashboard/[teamId]/page.tsx (1)

76-77: LGTM! Layout improvements.

The padding and height adjustments improve the visual consistency of the dashboard layout.

apps/web/app/[locale]/dashboard/team-dashboard/[teamId]/components/activity-modal.tsx (1)

101-110: LGTM! Improved visual hierarchy.

The reduced avatar size and font size create a better visual hierarchy in the modal header.

apps/web/app/[locale]/dashboard/team-dashboard/[teamId]/components/team-stats-table.tsx (1)

63-77: LGTM! Consistent loading states.

The increased minimum height for loading and no data states improves layout consistency.

@evereq
Copy link
Member

evereq commented Feb 6, 2025

@Innocent-Akim resolve merge conflicts please

- Fix type error in ActivityModal component
- Improve modal styling and responsiveness
- Replace custom button with Button component
- Add accessibility attributes to chart button
- Optimize modal rendering with null check
- Fix type error in ActivityModal component
- Improve modal styling and responsiveness
- Replace custom button with Button component
- Add accessibility attributes to chart button
- Optimize modal rendering with null check
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

🔭 Outside diff range comments (1)
apps/web/app/[locale]/dashboard/team-dashboard/[teamId]/components/team-stats-table.tsx (1)

75-75: Maintain consistent min-height across states.

The loading state uses min-h-[500px] while the empty state uses min-h-[400px]. This inconsistency could cause layout shifts when transitioning between states.

-<div className="flex justify-center items-center min-h-[400px] text-gray-500 dark:text-white dark:bg-dark--theme-light">
+<div className="flex justify-center items-center min-h-[500px] text-gray-500 dark:text-white dark:bg-dark--theme-light">
🧹 Nitpick comments (2)
apps/web/app/[locale]/dashboard/team-dashboard/[teamId]/components/team-stats-table.tsx (2)

47-47: Consider using non-nullable state type.

The state type ITimerEmployeeLog | undefined could be made more explicit about its purpose by using null instead of undefined to represent the absence of data.

-const [employeeLog, setEmployeeLog] = useState<ITimerEmployeeLog | undefined>(undefined);
+const [employeeLog, setEmployeeLog] = useState<ITimerEmployeeLog | null>(null);

175-188: Remove unnecessary Fragment.

The Fragment wrapper is redundant as it contains only one child element.

-<>
  <Button
    variant="ghost"
    size="icon"
    onClick={() => {
      setEmployeeLog(employeeLog);
      openModal();
    }}
    aria-label={`View activity chart for ${employeeLog.employee?.user?.name || 'employee'}`}
    title="View activity chart">
    <ChartIcon />
  </Button>
-</>
🧰 Tools
🪛 Biome (1.9.4)

[error] 175-187: Avoid using unnecessary Fragment.

A fragment is redundant if it contains only one child, or if it is the child of a html element, and is not a keyed fragment.
Unsafe fix: Remove the Fragment

(lint/complexity/noUselessFragments)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between bcd9b0b and 5eec9ed.

📒 Files selected for processing (3)
  • apps/web/app/[locale]/dashboard/team-dashboard/[teamId]/components/activity-modal.tsx (1 hunks)
  • apps/web/app/[locale]/dashboard/team-dashboard/[teamId]/components/team-stats-table.tsx (5 hunks)
  • apps/web/app/[locale]/dashboard/team-dashboard/[teamId]/page.tsx (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • apps/web/app/[locale]/dashboard/team-dashboard/[teamId]/components/activity-modal.tsx
  • apps/web/app/[locale]/dashboard/team-dashboard/[teamId]/page.tsx
🧰 Additional context used
🪛 Biome (1.9.4)
apps/web/app/[locale]/dashboard/team-dashboard/[teamId]/components/team-stats-table.tsx

[error] 175-187: Avoid using unnecessary Fragment.

A fragment is redundant if it contains only one child, or if it is the child of a html element, and is not a keyed fragment.
Unsafe fix: Remove the Fragment

(lint/complexity/noUselessFragments)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: deploy
🔇 Additional comments (3)
apps/web/app/[locale]/dashboard/team-dashboard/[teamId]/components/team-stats-table.tsx (3)

147-158: Use actual data for activity percentages.

The manually added, active time, idle time, and unknown activity percentages are still hardcoded.


176-186: LGTM! Well-implemented accessibility.

The activity chart button is well-implemented with proper accessibility attributes (aria-label and title).


200-237: LGTM! Well-implemented pagination controls.

The pagination implementation is robust with:

  • Complete navigation controls (first, last, previous, next)
  • Proper disabled states
  • Good keyboard accessibility

@Innocent-Akim Innocent-Akim requested a review from evereq February 6, 2025 22:57
@evereq evereq merged commit e71a27c into develop Feb 7, 2025
12 of 13 checks passed
@evereq evereq deleted the feat/improve-activity-modal-ui branch February 7, 2025 06:40
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