Skip to content

docs(guides): add large-list and virtualization guidance#1967

Merged
kotAPI merged 2 commits into
mainfrom
fix/issue-1848-virtualization-guide
Jun 12, 2026
Merged

docs(guides): add large-list and virtualization guidance#1967
kotAPI merged 2 commits into
mainfrom
fix/issue-1848-virtualization-guide

Conversation

@kotAPI

@kotAPI kotAPI commented Jun 12, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Documents when to virtualize long Select, Menu, Combobox, and Tree collections.
  • Covers integration patterns, keyboard/a11y constraints, and anti-patterns.

Closes #1848.

Test plan

  • Verify /docs/guides/large-lists-and-virtualization renders in the docs app.

Made with Cursor

Summary by CodeRabbit

  • Documentation
    • Added a new guide "Large Lists & Virtualization" that explains when and how to virtualize large, performance-sensitive lists (Select, Combobox, Menu/DropdownMenu, Tree, tables), with integration patterns, accessibility and keyboard guidance, and pitfalls to avoid.
    • Added the guide to the site navigation and published the page with SEO metadata.

Closes #1848.

Co-authored-by: Cursor <cursoragent@cursor.com>
@changeset-bot

changeset-bot Bot commented Jun 12, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 744be67

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d2e5f647-884d-479f-96de-f5d0667c614b

📥 Commits

Reviewing files that changed from the base of the PR and between 711d35d and 744be67.

📒 Files selected for processing (2)
  • docs/app/docs/docsNavigationSections.tsx
  • docs/app/docs/guides/large-lists-and-virtualization/content.mdx
✅ Files skipped from review due to trivial changes (1)
  • docs/app/docs/guides/large-lists-and-virtualization/content.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/app/docs/docsNavigationSections.tsx

📝 Walkthrough

Walkthrough

Adds a new "Large Lists & Virtualization" docs guide: MDX content, SEO metadata, and a page module are added and the guide is registered in the docs navigation.

Changes

Virtualization guidance documentation

Layer / File(s) Summary
Virtualization guide page and documentation
docs/app/docs/guides/large-lists-and-virtualization/content.mdx, docs/app/docs/guides/large-lists-and-virtualization/seo.ts, docs/app/docs/guides/large-lists-and-virtualization/page.tsx
Documentation content defines when and how to virtualize Rad UI lists, provides an integration pattern and accessibility notes; SEO metadata and the page module wire the MDX into the docs system.
Guide navigation registration
docs/app/docs/docsNavigationSections.tsx
Adds "Large Lists & Virtualization" to the "Guides" navigation items, positioned after "SSR & No-JS Fallback".

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related issues

  • #1987: The new "Large Lists & Virtualization" guide and nav entry directly address requests for virtualization documentation and guidance for large-component lists.

Possibly related PRs

  • rad-ui/ui#1064: Shares the SEO metadata generation codepath used by the new guide's seo.ts.

Poem

🐰 A little guide hops in to teach the trick,
Render just what's seen, keep the list light and slick,
Keys steady, focus saved, accessibility neat,
Docs point the way so large lists stay fleet,
Hooray—now navigation and guidance click!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs(guides): add large-list and virtualization guidance' accurately describes the main change—adding documentation about large lists and virtualization to the guides section.
Linked Issues check ✅ Passed The pull request meets all acceptance criteria from issue #1848: provides clear documentation on virtualization guidance [#1848], covers interaction patterns with Select/Menu/Combobox [#1848], and includes keyboard accessibility considerations [#1848].
Out of Scope Changes check ✅ Passed All changes are scoped to documentation additions for large-list virtualization guidance; no unrelated code modifications or features are included.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/issue-1848-virtualization-guide

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.

ESLint install failed due to a network error.


Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
docs/app/docs/guides/large-lists-and-virtualization/content.mdx (1)

11-11: 💤 Low value

Minor: Tighten the wording on keyboard navigation lag.

The phrase "lags behind input" is slightly wordy; consider replacing with a more concise synonym like "falls behind input" or "drags" to improve readability.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/app/docs/guides/large-lists-and-virtualization/content.mdx` at line 11,
Replace the phrase "keyboard navigation (arrow keys, typeahead) lags behind
input" with a tighter wording such as "keyboard navigation (arrow keys,
typeahead) falls behind input" or "keyboard navigation (arrow keys, typeahead)
drags" throughout the sentence in the docs content to improve conciseness while
preserving meaning.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@docs/app/docs/guides/large-lists-and-virtualization/content.mdx`:
- Line 11: Replace the phrase "keyboard navigation (arrow keys, typeahead) lags
behind input" with a tighter wording such as "keyboard navigation (arrow keys,
typeahead) falls behind input" or "keyboard navigation (arrow keys, typeahead)
drags" throughout the sentence in the docs content to improve conciseness while
preserving meaning.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 03655cbc-d020-4847-86e2-1416e8de7bab

📥 Commits

Reviewing files that changed from the base of the PR and between b05c1b2 and 711d35d.

📒 Files selected for processing (4)
  • docs/app/docs/docsNavigationSections.tsx
  • docs/app/docs/guides/large-lists-and-virtualization/content.mdx
  • docs/app/docs/guides/large-lists-and-virtualization/page.tsx
  • docs/app/docs/guides/large-lists-and-virtualization/seo.ts

@kotAPI

kotAPI commented Jun 12, 2026

Copy link
Copy Markdown
Collaborator Author

Need to create some virtualized examples/documentation for some components like select etc

Keep both Performance and Large Lists & Virtualization guide entries.

Co-authored-by: Cursor <cursoragent@cursor.com>
@github-actions

Copy link
Copy Markdown
Contributor

Coverage

This report compares the PR with the base branch. "Δ" shows how the PR affects each metric.

Metric PR Δ
Statements 75.68% +0.00%
Branches 59.08% +0.00%
Functions 61.75% +0.00%
Lines 77.22% +0.00%

Coverage improved or stayed the same. Great job!

Run npm run coverage:ci locally for detailed reports and target untested areas to raise these numbers.

@kotAPI kotAPI merged commit 24e2614 into main Jun 12, 2026
9 of 10 checks passed
@kotAPI kotAPI deleted the fix/issue-1848-virtualization-guide branch June 12, 2026 14:17
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.

Optimize large-list interactions (virtualization guidance).

1 participant