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(docs): add the DataGrid page #104

Closed
wants to merge 53 commits into from
Closed

feat(docs): add the DataGrid page #104

wants to merge 53 commits into from

Conversation

desmondinho
Copy link
Contributor

@desmondinho desmondinho commented Nov 19, 2024

Closes #99

Summary by CodeRabbit

  • New Features

    • Introduced a new enumeration NavItemStatus for navigation item statuses: Soon and Preview.
    • Added a new class P for enhanced data handling.
    • Enhanced navigation item categorization and status management.
    • New NavItemBadge component displays navigation item statuses.
    • New DataGrid component with extensive documentation and examples for various functionalities, including editing, sorting, and dynamic columns.
    • Added support for remote data sources and customizable themes in data grids.
  • Bug Fixes

    • Improved handling of navigation item statuses and their display logic.
  • Documentation

    • Comprehensive updates to documentation pages for the new DataGrid component and its features.
  • Style

    • Added new CSS utility classes for better scrollbar styling and layout enhancements.

@desmondinho desmondinho self-assigned this Nov 19, 2024
@desmondinho desmondinho linked an issue Nov 19, 2024 that may be closed by this pull request
1 task
Copy link

coderabbitai bot commented Nov 19, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces several new components and modifications primarily centered around the LumexDataGrid. Key additions include multiple column types (e.g., EditColumn, PropertyColumn, TemplateColumn, and _CheckboxColumn) for enhanced data manipulation and display. A new enumeration for sorting direction and layout behavior is also introduced. Additionally, the NavItemStatus enum is added to manage navigation item statuses, and various UI improvements are made across the documentation and component files. The changes enhance the functionality and usability of the data grid and navigation systems within the application.

Changes

File Path Change Summary
docs/LumexUI.Docs.Client/Common/Enums/NavItemStatus.cs Added NavItemStatus enum with values Soon and Preview.
docs/LumexUI.Docs.Client/Common/Models/Generics.cs Added new class P.
docs/LumexUI.Docs.Client/Common/Navigation/NavigationStore.cs Updated navigation item statuses in CustomizationCategory and ComponentsCategory.
docs/LumexUI.Docs.Client/Common/Navigation/Types.cs Modified NavigationItem constructor to use NavItemStatus? instead of a boolean locked parameter.
docs/LumexUI.Docs.Client/Components/Layouts/DocsContentLayout.razor Changed class name of a <div> and added new elements to TableOfContents.
docs/LumexUI.Docs.Client/Components/Layouts/DocsLayout.razor Simplified class attributes for <aside> element.
docs/LumexUI.Docs.Client/Components/NavItemBadge.razor Introduced a new component for displaying navigation item badges based on status.
docs/LumexUI.Docs.Client/Components/NavMenu.razor Updated rendering logic to include NavItemBadge and handle item statuses.
docs/LumexUI.Docs.Client/Pages/Components/DataGrid/*.razor Added multiple new components for data grid examples, including support for features like editing, loading, and selection.
docs/LumexUI.Docs.Client/Program.cs Added HTTP client registration.
docs/LumexUI.Docs/Program.cs Added HTTP client registration for documentation project.
docs/LumexUI.Docs/Styles/globals.css Introduced .scrollbar utility class for scrollbar customization.
src/LumexUI/Common/Enums/Align.cs Updated comments and added Center member to Align enum.
src/LumexUI/Common/Enums/Layout.cs Introduced Layout enum for table layout behavior.
src/LumexUI/Common/Enums/SortDirection.cs Added SortDirection enum for column sorting.
src/LumexUI/Common/Events/DataGridRowClickEventArgs.cs Introduced DataGridRowClickEventArgs<T> class for row click events.
src/LumexUI/Components/Bases/LumexColumnBase.razor Added base column rendering logic for data grid.
src/LumexUI/Components/DataGrid/Columns/EditColumn.razor Introduced EditColumn for inline editing in data grids.
src/LumexUI/Components/DataGrid/Columns/PropertyColumn.razor Added PropertyColumn for displaying single property values in data grids.
src/LumexUI/Components/DataGrid/Columns/TemplateColumn.razor Introduced TemplateColumn for rendering custom templates in data grid cells.
src/LumexUI/Components/DataGrid/Columns/_CheckboxColumn.razor Added _CheckboxColumn for selecting rows in data grids.
src/LumexUI/Components/DataGrid/Core/EventCallbackSubscribable.cs Introduced EventCallbackSubscribable<T> for managing event subscriptions.

Assessment against linked issues

Objective Addressed Explanation
Add the DataGrid component (99)
Allow scanning, sorting, and comparing large amounts of data

Possibly related PRs

  • feat(docs): add the Colors page #74: Introduces NavItemStatus, utilized in navigation components to manage item statuses, directly related to changes in the NavItemBadge component.

🐰 In the meadow where data grids play,
New columns and features brighten the day.
With badges that shine and statuses clear,
Our Lumex UI grows, bringing us cheer!
So hop along, friends, let's code and explore,
For every new change opens up a door! 🌼


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

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.

[Feature]: Add DataGrid component
1 participant