Repository navigation
refactor: replace one-off props with shared names - #980
Open
rohanchkrabrty wants to merge 2 commits into
Open
rohanchkrabrty wants to merge 2 commits into
rohanchkrabrty wants to merge 2 commits into
Conversation
Remove Command.DialogContent width and Search width. Rename Skeleton borderRadius to radius and Breadcrumb.Item current to active. Merge DatePicker and FilterChip onErrorChange into onValidityChange, as on CalendarPreview.Input. Add gap 0 to Flex and Grid, and radius to Toast.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info
📝 Walkthrough
Priority: ➖ Normal Merge Risk: ⚪ Minimal · up to
|
| Check name | Status | Explanation | Resolution |
|---|---|---|---|
| Docstring Coverage |  |
Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 12 functions across 33 files. (12 skipped:… | Write docstrings for the functions missing them to satisfy the coverage threshold. |
-
Check name Status Explanation Title check The title clearly and concisely describes the main changes: replacing one-off component props with shared names and APIs. Description check The description directly explains the prop renames, behavior changes, documentation updates, validation decisions, and verification steps covered by the changeset. Linked Issues check Check skipped because no linked issues were found for this pull request. Out of Scope Changes check Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage
-
Explanation
Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 12 functions across 33 files. (12 skipped: 12 unsupported.)
Resolution
Write docstrings for the functions missing them to satisfy the coverage threshold.
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
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.
Comment @coderabbitai help to get the list of available commands.
commit: |
1 task done
- Remove FilterChip calendarProps.onValidityChange. It repeated calendarProps.slotProps.input.onValidityChange. - Shorten the DatePicker onValidityChange JSDoc and move its usage notes to the Calendar page. - Set the docs search width in CSS instead of an inline style. - List Skeleton and Toast.Provider under per-component radius, and DataView.Search in the upgrading notes.
This branch was successfully deployed
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
1 participant
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.
Summary
widthfromCommand.DialogContentandSearch. Set the palette width withclassNameorstyle. Search fills its parent's width from CSS, so the inline style is gone and the default does not change.borderRadiustoradius, and addradiustoToast.ProviderandToast. Both use the sharednone | small | medium | large | fullscale that Button, Dialog and Command use. Default radii do not change.Breadcrumb.Itemcurrenttoactive, as onSidebar.Item.onErrorChangeand FilterChipcalendarProps.onErrorChangewithonValidityChange, the callbackCalendarPreview.Inputalready has.gap,columnGapandrowGaptake0. Add the old to new mappings to the Upgrading page.Decisions where the proposal is silent:
onValidityChange(validity: { valid: boolean; reason?: 'unparseable' | 'out-of-bounds' | 'unavailable' | 'out-of-order'; message?: string }), the name and typeCalendarPreview.Inputalready uses. DatePicker reportsunparseableorout-of-boundswith the message'Invalid date', and fires when the reason changes. It has one argument. The details argument from the change-callbacks proposal is not added.calendarProps.onValidityChange(renamed fromonErrorChange), so its API matches DatePicker.calendarProps.slotProps.input.onValidityChangestill works.data-active="true"in place ofdata-current="true", to match the prop and Sidebar.Item.widthfrom its props, so TypeScript reports old usages. The docs tell users to size the parent.radiusis onToast.Provider, next toposition, and applies to every toast it renders.docs/V1-migration.mdand the RFCs keep the old names, because they describe earlier releases.No open PR covers this change. Search
sizeandvariantare changed in separate PRs.Checks run:
pnpm lint,pnpm exec tsc --noEmitinpackages/react, andpnpm test:apsarapass. I compared the Skeleton, Breadcrumb, Search, Navbar, Command (and the docs search dialog), Calendar, FilterChip, Flex, Grid, Toast and DataView pages on a local dev server with the deployed docs (main). Skeleton and Command were checked in light and dark themes, the other pages in one of them. Sizes, radii and colors match. I also checked gap0in the Flex and Grid playgrounds and the DatePicker Field error.