Skip to content

docs: update @termuijs/ui component list in README#2958

Open
Nikhil-0710 wants to merge 1 commit into
Karanjot786:mainfrom
Nikhil-0710:fix-readme-ui-components
Open

docs: update @termuijs/ui component list in README#2958
Nikhil-0710 wants to merge 1 commit into
Karanjot786:mainfrom
Nikhil-0710:fix-readme-ui-components

Conversation

@Nikhil-0710

@Nikhil-0710 Nikhil-0710 commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Description

This PR updates the @termuijs/ui component list in the README.md to accurately reflect the current, larger component set available in the package. It adds missing higher-value components (Tree, MultiSelect, Drawer, Wizard, RadioGroup, MenuBar) and includes a direct link to the full authoritative component catalog on the website.

Related Issue

Closes #2601

Which package(s)?

Root documentation (README.md)

Type of Change

  • 🐛 Bug fix (type:bug)
  • ✨ Feature (type:feature)
  • 📝 Docs (type:docs)
  • 🧪 Tests (type:testing)
  • ♻️ Refactor (type:refactor)
  • 🎨 Design / UX (type:design)
  • ♿ Accessibility (type:accessibility)
  • ⚡ Performance (type:performance)
  • 🔧 DevOps / CI (type:devops)
  • 🔒 Security (type:security)

Checklist

  • ⭐ You starred the repo. The needs-star check blocks your merge otherwise.
  • Tests pass locally: bun vitest run
  • Build passes: bun run build
  • Typecheck passes: bun run typecheck
  • You read CONTRIBUTING.md.
  • Your PR title follows type: short description.
  • Widget state mutators call markDirty() (if your change affects rendering).
  • No new any types without an inline comment explaining why.
  • No unrelated refactors bundled into this PR.

GSSoC 2026 Participation

Summary by CodeRabbit

  • Documentation
    • Updated the package documentation to link to the full UI component catalog.
    • Simplified the list of components shown in the package overview.

@Nikhil-0710
Nikhil-0710 requested a review from Karanjot786 as a code owner July 23, 2026 17:14
@github-actions github-actions Bot added the type:docs +5 pts. Documentation. label Jul 23, 2026
@coderabbitai

coderabbitai Bot commented Jul 23, 2026

Copy link
Copy Markdown

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 Plus

Run ID: 2d088414-c092-49d0-bc67-61cf22eeb36a

📥 Commits

Reviewing files that changed from the base of the PR and between 61eaa4e and d1db46d.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

The README’s @termuijs/ui package entry now uses a shorter description that links to the full component catalog instead of listing individual components inline.

Changes

UI package documentation

Layer / File(s) Summary
Update UI package description
README.md
The @termuijs/ui Packages table entry now references the full component catalog and removes the previous detailed component list.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: karanjot786

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise, in the required docs: short description style, and matches the README component-list update.
Description check ✅ Passed The PR description follows the template and includes the required description, issue link, package, type, checklist, and GSSoC section.
Linked Issues check ✅ Passed The change updates the @termuijs/ui README row with the missing components and a link to the authoritative catalog, matching #2601.
Out of Scope Changes check ✅ Passed The only change is a README documentation edit aligned with the stated objective.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type:docs +5 pts. Documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[feature] Update README's @termuijs/ui component list to match current component set

1 participant