docs(Table): direct users to DataVis NITRO for most table use cases#238
Merged
Conversation
Add a Storybook docs banner and JSDoc note on the Table component pointing users to DataVis NITRO. NITRO is simple out of the box while exposing power-user features progressively; Table should only be used in lightweight situations where that overhead is genuinely unneeded. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Adds documentation guidance to steer developers toward DataVis NITRO for most table/grid use cases, while clarifying when the lightweight Table component is still appropriate.
Changes:
- Added a Storybook docs description callout on the
Tabledocs page linking to DataVis NITRO docs. - Added JSDoc guidance on
Tableso the recommendation appears in IDE hover tooltips.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/components/Table/Table.tsx | Adds JSDoc guidance recommending DataVis NITRO over Table for most cases. |
| src/components/Table/Table.stories.tsx | Adds a Storybook docs description callout linking to the DataVis NITRO docs page. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Deploying ui with
|
| Latest commit: |
210afea
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://5e8ffbbd.ui-6d0.pages.dev |
| Branch Preview URL: | https://horner-table-nitro-redirect.ui-6d0.pages.dev |
The Storybook path ?path=/docs/... is not a valid URL or symbol reference, so most JSDoc/TS renderers showed it as a broken link. Replace with plain prose that preserves the full guidance. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Developers reaching for
Tableoften don't realize that DataVis NITRO covers the same ground with less manual wiring and exposes sorting, filtering, and other power-user features progressively -- so it fits both simple and complex cases. Without any guidance at the point of discovery, teams default toTableeven when NITRO would serve them better.This adds a short nudge in two places:
Table.stories.tsx) -- a callout rendered at the top of the Table docs page linking directly to the NITRO docs and explaining whenTableis still the right choice (genuinely lightweight situations where NITRO's overhead is unneeded).Table(Table.tsx) -- the same guidance in-editor so it surfaces in IDE hover tooltips without opening Storybook.No runtime behavior is changed.