Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[Feat]: Add pagination size dropdown #3593

Merged
merged 3 commits into from
Feb 6, 2025

Conversation

Innocent-Akim
Copy link
Contributor

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

Description

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

  • New Features
    • Introduced dynamic pagination controls allowing users to select the number of entries per page on the team statistics view.
    • Updated pagination behavior to reset the view when the page size is changed.
    • Enhanced the dropdown options to adapt based on the total number of items, offering flexible display configurations.

- Replace custom pagination select with PaginationDropdown component
- Improve layout and styling of pagination controls
- Move pagination size control next to entries count
- Update text color to #111827 for better visibility
Copy link
Contributor

coderabbitai bot commented Feb 6, 2025

Walkthrough

This pull request implements a dynamic pagination feature for the team statistics table. In the TeamStatsTable component, the static ITEMS_PER_PAGE is replaced with a state variable pageSize (defaulting to 10), and updated calculations determine the range of displayed items. The pagination controls now incorporate a PaginationDropdown for selecting page size and reset the current page on change. In addition, the PaginationDropdown component is enhanced with a new optional total property and a function to calculate pagination options based on the total count.

Changes

File(s) Change Summary
apps/web/app/[locale]/dashboard/team-dashboard/[teamId]/components/team-stats-table.tsx Added dynamic pagination: removed constant ITEMS_PER_PAGE, introduced state variable pageSize, updated pagination calculations (totalPages, startIndex, endIndex), integrated PaginationDropdown component, and reset the current page when the page size changes.
apps/web/lib/settings/page-dropdown.tsx Enhanced the component by adding an optional total prop, introduced the function calculatePaginationOptions to compute pagination options based on the total count, and modified the useEffect hook to update options when the total prop changes, with minor styling class adjustments.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant TeamStatsTable
    participant PaginationDropdown

    User->>TeamStatsTable: Selects new page size
    TeamStatsTable->>PaginationDropdown: Calls update for pagination options
    PaginationDropdown->>TeamStatsTable: Returns updated options
    TeamStatsTable->>TeamStatsTable: Resets current page and recalculates indices
Loading

Suggested labels

Improvement, UI/UX, WEB, Ever Teams

Suggested reviewers

  • evereq
  • Cedric921

Poem

I hopped into the code today,
Where pagination sets the pace to play.
Dropdowns leap with options so bright,
As pages refresh in pure delight.
A bunny cheers in joyful code energy—
Bounding through change with boundless glee! 🐇

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/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.

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

🧹 Nitpick comments (1)
apps/web/lib/settings/page-dropdown.tsx (1)

20-34: Fix array formatting in baseOptions.

The array formatting in baseOptions has inconsistent spacing.

-		const baseOptions = [10, 20, 30,40, 50];
+		const baseOptions = [10, 20, 30, 40, 50];
📜 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 4057ac9.

📒 Files selected for processing (2)
  • apps/web/app/[locale]/dashboard/team-dashboard/[teamId]/components/team-stats-table.tsx (5 hunks)
  • apps/web/lib/settings/page-dropdown.tsx (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: deploy
🔇 Additional comments (5)
apps/web/lib/settings/page-dropdown.tsx (3)

11-19: LGTM! Props are well-typed and documented.

The props interface is clear and properly typed with TypeScript.


54-58: LGTM! Effect properly handles total prop changes.

The effect correctly updates pagination options when total changes, with proper dependency array.


97-102: LGTM! Styling is consistent and supports dark mode.

The styling changes maintain consistency and properly handle dark mode.

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

47-51: LGTM! Pagination state and calculations are well implemented.

The pagination logic is correct with proper state management and calculations.


221-233: LGTM! Pagination dropdown is well integrated.

The pagination dropdown is properly integrated with good UX considerations:

  • Resets to page 1 when page size changes
  • Shows correct entry count
  • Properly passes total count to dropdown

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

221-228: Consider adding ARIA labels for better accessibility.

The pagination controls would benefit from proper ARIA labels to improve accessibility.

 <PaginationDropdown
+  aria-label="Select number of items per page"
   setValue={(value) => {
     setPageSize(value);
     setCurrentPage(1);
   }}
   total={rapportDailyActivity?.length}
 />
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4057ac9 and d1d2a7b.

📒 Files selected for processing (1)
  • apps/web/app/[locale]/dashboard/team-dashboard/[teamId]/components/team-stats-table.tsx (6 hunks)
⏰ 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)

6-6: LGTM! Pagination state and calculations are well implemented.

The pageSize state is properly integrated with the pagination logic, and the calculations for totalPages, startIndex, and endIndex are mathematically sound.

Also applies to: 46-49


70-76: LGTM! Empty state handling is improved with dark mode support.

The empty state UI is well-implemented with proper dark mode support and consistent layout.


193-194: LGTM! Responsive layout and pagination controls are well implemented.

The flex layout provides good mobile responsiveness, and the PaginationDropdown is properly integrated with the pagination state.

Also applies to: 221-234

@Innocent-Akim Innocent-Akim requested a review from evereq February 6, 2025 19:07
@evereq evereq merged commit b7d7086 into develop Feb 6, 2025
13 checks passed
@evereq evereq deleted the feat/add-pagination-size-dropdown branch February 6, 2025 21:56
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants