Fix data table filter issues: add counts, persist filters, and real-time updates

[codegen-sh]

This PR addresses three main issues with the data table filters:

1. Filter Counts: The filters now display accurate counts of the data remaining, synchronized with the server data. This is implemented by connecting the filters to the data source and updating the faceted counts.

2. Query Parameter Persistence: Filters now persist on page reload with query parameters as the source of truth. This is implemented using the useFilterSync hook with improved options for debouncing and history management.

3. Real-time Data Updates: The filters now update the data in real-time when changed. This is implemented using React Query to fetch data based on the current filter state.

Implementation Details:

• Created a new useFilteredData hook that combines filter state management with data fetching
• Enhanced useFilterSync to better handle URL synchronization with debouncing
• Improved useDataQuery (formerly useIssuesQuery) to be more generic and handle real-time updates
• Added comprehensive examples showing how to use the data table filter component
• Added detailed documentation in a README file

Usage Example:

// Simple usage with the useFilteredData hook
const {
  filters,
  columns,
  actions,
  data,
  isLoading,
} = useFilteredData({
  endpoint: '/api/items',
  columnsConfig,
  initialData: [],
});

// Render the filter component
<DataTableFilter
  columns={columns}
  filters={filters}
  actions={actions}
  strategy="client"
/>

This PR ensures that when filters are updated, users can see the correct counts of the data remaining (accurate from the server), the filters filter the data in the table on change, and the filters persist on refresh from the query params as the source of truth.

---

💻 View my work • About Codegen

[bolt-new-by-stackblitz]

Run & review this pull request in StackBlitz Codeflow.

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

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

Support

Need help? Join our Discord community for assistance with any issues or questions.

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 sequence diagram to generate a sequence diagram of the changes in this PR.
• @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.

[github-actions]

📝 Storybook Preview: View Storybook

This preview will be updated automatically when you push new changes to this PR.

Note: The preview will be available after the workflow completes and the PR is approved for deployment.