fix(select): SelectItem does not accept value props
#4653
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThis pull request introduces changes to the Changes
Sequence DiagramsequenceDiagram
participant User
participant SelectComponent
participant SelectItem
User->>SelectComponent: Interact with Select
SelectComponent->>SelectItem: Render items
SelectItem-->>SelectComponent: Display with key-based value
User->>SelectComponent: Select an item
SelectComponent->>SelectComponent: Use key for form submission
The sequence diagram illustrates the updated flow where Assessment against linked issues
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: 5
🧹 Nitpick comments (7)
apps/docs/content/components/select/virtualization.raw.jsx (1)
Line range hint
23-27: Consider removing unused value property from dataset.The
valueproperty is generated in the dataset but no longer used after removing the value prop from SelectItem. If this property is not needed elsewhere, consider simplifying the dataset structure..changeset/light-hairs-draw.md (1)
6-6: Fix typo in PR description."dose" should be "does"
-Fix SelectItem dose not accept value props (#2283) +Fix SelectItem does not accept value props (#2283)🧰 Tools
🪛 LanguageTool
[misspelling] ~6-~6: Did you mean the auxiliary verb “does”?
Context: ...roui/select": minor --- Fix SelectItem dose not accept value props (#2283)(DOSE_DOES)
packages/components/select/__tests__/select.test.tsx (4)
485-487: Add test cases for form submission with key propSince the
valueprop has been removed in favor of usingkeyfor form submissions, consider adding test cases that explicitly verify form submission behavior with thekeyprop.Also applies to: 490-492
622-624: Add test case for key-based selectionConsider adding a test case that verifies the correct handling of the
keyprop in form submissions after removing thevalueprop.
663-663: Add virtualization tests for key-based selectionThe virtualization tests should include verification of key-based selection and form submission behavior.
Also applies to: 699-699
729-731: Add accessibility tests for form labelsConsider adding tests to verify that form labels are correctly associated with the select component when using key-based selection.
Also applies to: 752-754
apps/docs/content/docs/components/select.mdx (1)
297-303: Enhance documentation with migration examplesWhile the explanation about using
keyinstead ofvalueis clear, consider adding:
- Code examples showing before/after migration
- Example of implementing a lookup map for custom form values
- Best practices for key selection in forms
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (9)
.changeset/light-hairs-draw.md(1 hunks)apps/docs/content/components/form/demo.raw.jsx(1 hunks)apps/docs/content/components/select/virtualization-custom-item-height.raw.jsx(1 hunks)apps/docs/content/components/select/virtualization-max-listbox-height.raw.jsx(1 hunks)apps/docs/content/components/select/virtualization-ten-thousand.raw.jsx(1 hunks)apps/docs/content/components/select/virtualization.raw.jsx(1 hunks)apps/docs/content/docs/components/select.mdx(1 hunks)packages/components/listbox/src/base/listbox-item-base.tsx(1 hunks)packages/components/select/__tests__/select.test.tsx(10 hunks)
✅ Files skipped from review due to trivial changes (1)
- apps/docs/content/components/form/demo.raw.jsx
🧰 Additional context used
🪛 LanguageTool
.changeset/light-hairs-draw.md
[misspelling] ~6-~6: Did you mean the auxiliary verb “does”?
Context: ...roui/select": minor --- Fix SelectItem dose not accept value props (#2283)
(DOSE_DOES)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: TypeScript
- GitHub Check: Build
🔇 Additional comments (1)
apps/docs/content/components/select/virtualization.raw.jsx (1)
Line range hint
39-48: Verify form submission behavior after removing value prop.Please ensure that form submissions still work correctly after removing the value prop. The PR description mentions this was a fix for SelectItem not accepting value props, but we should verify that the selected values are still properly handled.
apps/docs/content/components/select/virtualization-max-listbox-height.raw.jsx
Outdated
Show resolved
Hide resolved
apps/docs/content/components/select/virtualization-custom-item-height.raw.jsx
Outdated
Show resolved
Hide resolved
🦋 Changeset detectedLatest commit: 1790b5a The changes in this PR will be included in the next version bump. This PR includes changesets to release 4 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
.changeset/light-hairs-draw.md
Outdated
| "@heroui/listbox": minor | ||
| "@heroui/select": minor |
There was a problem hiding this comment.
should be patch. we only set react one as minor to avoid double minor bump
There was a problem hiding this comment.
I see. value wasn't actually being used for anything, so patch sounds appropriate.
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.changeset/light-hairs-draw.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
.changeset/light-hairs-draw.md
[misspelling] ~6-~6: Did you mean the auxiliary verb “does”?
Context: ...roui/select": patch --- Fix SelectItem dose not accept value props (#2283)
(DOSE_DOES)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: TypeScript
- GitHub Check: Build
🔇 Additional comments (1)
.changeset/light-hairs-draw.md (1)
1-4: LGTM on version bumps!The patch version updates for both packages align with the discussion in previous reviews, as the
valueprop wasn't being used functionally.
| "@heroui/select": patch | ||
| --- | ||
|
|
||
| Fix SelectItem dose not accept value props (#2283) |
There was a problem hiding this comment.
Fix typo in commit message.
There's a spelling error in the commit message: "dose" should be "does".
Apply this diff to fix the typo:
-Fix SelectItem dose not accept value props (#2283)
+Fix SelectItem does not accept value props (#2283)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Fix SelectItem dose not accept value props (#2283) | |
| Fix SelectItem does not accept value props (#2283) |
🧰 Tools
🪛 LanguageTool
[misspelling] ~6-~6: Did you mean the auxiliary verb “does”?
Context: ...roui/select": patch --- Fix SelectItem dose not accept value props (#2283)
(DOSE_DOES)
Closes #2283
📝 Description
This PR includes the following changes:
valueattribute.SelectItemto not accept avalueprop.⛳️ Current behavior (updates)
SelectItemaccepts avalueprop (but it is not reflected).🚀 New behavior
SelectItemno longer accepts avalueprop.💣 Is this a breaking change (Yes/No):
No
📝 Additional Information
For more details on why the
valueattribute cannot be used, please see the issue comment:#2283 (comment)
Summary by CodeRabbit
Summary by CodeRabbit
Release Notes
Bug Fixes
SelectItemnot accepting value properties, ensuring proper functionality.valueattribute fromSelectItemcomponents across multiple documentation and test files.ListboxItemBasecomponent to omitvalueproperty.Documentation
SelectItem.Dependencies
@heroui/listboxand@heroui/select.These changes improve the consistency of
SelectItemcomponent usage and provide clearer guidance for developers.