feat(form): radio input with radio group component
Closes #44
📝 Description
⛳️ Current behavior (updates)
🚀 New behavior
💣 Is this a breaking change (Yes/No):
📝 Additional Information
Summary by CodeRabbit
-
New Features
- Introduced radio input functionality in forms.
- Added
RadioGroupcomponent to manage and display radio options. - Enhanced form selector to support radio input fields.
-
Improvements
- Updated form input labels for consistency.
- Enhanced configurability and functionality of radio components with new type definitions.
-
Removals
- Removed nested checkbox objects under
form-checkbox-1for better form management.
- Removed nested checkbox objects under
The latest updates on your projects. Learn more about Vercel for Git ↗︎
| Name | Status | Preview | Comments | Updated (UTC) |
|---|---|---|---|---|
| mui-builder | ❌ Failed (Inspect) | Jul 13, 2024 11:04am |
Walkthrough
The recent changes introduce new functionalities to handle radio input fields within a form module. This includes adding a RadioGroup component, defining necessary type definitions, and enhancing the form selector to manage radio inputs. Nested checkbox objects have been removed, and label properties updated for consistency.
Changes
| Files/Modules | Change Summary |
|---|---|
| apps/docs/src/app/app.tsx | Added a radio input object and removed nested checkbox objects; updated label properties. |
| packages/core/src/modules/form/src/components/fields/radio/radio.types.ts | Introduced type definitions for RadioProps and RadioGroupProps. |
| packages/core/src/modules/form/src/components/fields/radio/radioGroup.tsx | Added RadioGroup component to manage radio options. |
| packages/core/src/modules/form/src/components/fields/radio/useRadio.ts | Introduced useRadio custom hook for radio input management. |
| packages/core/src/modules/form/src/components/fields/radio/useRadioGroup.ts | Introduced useRadioGroup custom hook to handle radio group functionality. |
| packages/core/src/modules/form/src/types/public.types.ts | Updated types to include RadioGroupProps and radio as form types. |
| packages/core/src/modules/form/src/utils/selector/formSelector.tsx | Enhanced FormSelector to support radio input fields by adding a case for radio. |
Sequence Diagram(s)
sequenceDiagram
participant User
participant FormSelector
participant RadioGroup
participant Radio
User->>FormSelector: Select radio input
FormSelector->>RadioGroup: Initialize radio group
RadioGroup->>Radio: Create radio options
User->>RadioGroup: Interact with radio buttons
RadioGroup->>FormSelector: Return selected value
Assessment against linked issues
| Objective (Issue #) | Addressed | Explanation |
|---|---|---|
| Handle a group of radio input that wrapped with radioGroup component (#44) | ✅ |
Poem
In the forms where fields reside,
Radio buttons now take pride.
Options clear, with labels true,
User choices come into view.
Checkboxes have bid adieu,
With changes fresh, the app renews.
🐇💻✨
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?
Tips
Chat
There are 3 ways to chat with CodeRabbit:
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
I pushed a fix in commit <commit_id>.Generate unit testing code for this file.Open a follow-up GitHub issue for this discussion.
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:@coderabbitai generate unit testing code for this file.@coderabbitai modularize this function.
- PR comments: Tag
@coderabbitaiin a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:@coderabbitai generate interesting stats about this repository and render them as a table.@coderabbitai show all the console.log statements in this repository.@coderabbitai read src/utils.ts and generate unit testing code.@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.@coderabbitai help me debug CodeRabbit configuration file.
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 as PR comments)
@coderabbitai pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
CodeRabbit Configration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile to the root of your repository. - Please see the configuration documentation for more information.
- If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation:
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
Documentation and Community
- Visit our Documentation for detailed information on how to use CodeRabbit.
- Join our Discord Community to get help, request features, and share feedback.
- Follow us on X/Twitter for updates and announcements.