Update table.mdx #3849
Update table.mdx #3849
Conversation
That "bug" has been there for > 1 year !! I understand the wait ... but hey at least document it ! (so that users don't spend hours in the middle of the night trying to figure it out !! ^^) Source : heroui-inc#1403 (comment)
|
|
@kjorand is attempting to deploy a commit to the NextUI Inc Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughThe pull request introduces significant updates to the documentation of the Changes
Possibly related PRs
Suggested labels
Suggested reviewers
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (5)
apps/docs/content/docs/components/table.mdx (5)
34-35: Great addition of new sections for dynamic rendering, empty state, and customization options.These new sections greatly enhance the documentation by covering important use cases and customization options. The examples are clear and well-explained, which will be very helpful for developers using the Table component.
Consider adding a brief explanation of when users might want to use these options, particularly for hiding the header or removing the wrapper. This context could help developers make informed decisions about using these features.
Also applies to: 36-45, 36-45, 36-45
Line range hint
36-45: Excellent addition of advanced features documentation.The new sections on row selection, sorting, and pagination (including async and infinite pagination) are comprehensive and well-explained. These advanced features are crucial for many Table component use cases, and the detailed documentation will greatly assist developers in implementing them correctly.
Consider adding a "Best Practices" or "Performance Considerations" subsection within these advanced features. This could include tips on optimizing performance when dealing with large datasets or complex sorting/filtering operations.
Also applies to: 36-45, 36-45, 36-45, 36-45, 36-45, 36-45
Line range hint
36-45: Great addition of custom styles documentation.The new section on customizing the Table component using Tailwind CSS classes is a valuable addition. It provides clear guidance on how developers can tailor the appearance of the component to fit their specific design needs.
Consider adding a brief note about the potential impact of custom styles on accessibility. This could remind developers to ensure that their customizations maintain or enhance the component's accessibility features.
Line range hint
36-45: Excellent addition of data attributes and accessibility information.The new sections on data attributes and accessibility features are comprehensive and provide crucial information for developers. This level of detail demonstrates a strong commitment to creating accessible and semantically rich components.
Consider adding examples of how these data attributes and accessibility features can be leveraged in real-world scenarios. This could include snippets demonstrating how to use these attributes for styling or how screen readers interpret the accessibility features.
Also applies to: 36-45
Line range hint
36-45: Comprehensive and well-structured API documentation.The extensive API documentation for the Table component and its related sub-components is excellent. It provides developers with a thorough reference, including props, events, and type definitions, which is crucial for effective use of the component.
Consider adding a "Quick Reference" section at the beginning of the API documentation. This could include a table or list of the most commonly used props and events, allowing developers to quickly find the information they need most often.
Also applies to: 36-45, 36-45, 36-45, 36-45, 36-45, 36-45
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
- apps/docs/content/docs/components/table.mdx (1 hunks)
🔇 Additional comments (1)
apps/docs/content/docs/components/table.mdx (1)
34-35: Excellent addition of the client-side component warning.This warning is crucial for developers using the Table component, as it clearly states the limitation of the component to client-side rendering. This information helps prevent potential issues and improves the developer experience.
|
It should apply for all collection-based components. However, RA team has supported custom collection renderers so probably it should be resolved after upgrading RA dependencies. If not, we will add the notes then. |
That "bug" has been there for > 1 year !!
I understand the wait ... but hey at least document it ! (so that users don't spend hours in the middle of the night trying to figure it out !! ^^)
Source :
#1403 (comment)
Closes #
📝 Description
⛳️ Current behavior (updates)
🚀 New behavior
💣 Is this a breaking change (Yes/No):
📝 Additional Information
Summary by CodeRabbit
New Features
Tablecomponent is only functional in client components.Documentation
Tablecomponent's documentation, including detailed API sections for various props and events.