Skip to content

Conversation

@codegen-sh
Copy link
Contributor

@codegen-sh codegen-sh bot commented May 31, 2025

Overview

This PR adds comprehensive Storybook stories for the ControlledSelect component as part of the Medusa Forms controlled components documentation effort.

Changes

✨ New Stories Added

  1. Basic Single Select - Simple dropdown with options and default value handling
  2. Default Value Handling - Pre-selected value demonstration with form state tracking
  3. Required Field Validation - Form validation integration with error state display and submit handling
  4. Loading States - Loading indicator with disabled state during loading and toggle functionality
  5. Custom Option Rendering - Rich content in options using Select compound components with custom styling
  6. Disabled State - Disabled input demonstration with default value handling
  7. Error State - Manual error triggering with error message display and form state handling
  8. Size Variants - Small size demonstration with layout consistency
  9. Complex Form Integration - Multiple selects in one form with form submission handling, reset functionality, and error display
  10. Interactive Demo - External state management with onChange handler and value tracking

🛠️ Technical Implementation

  • Framework: Uses react-hook-form directly with FormProvider and useForm
  • No Dependencies: No react-router-stub dependencies as requested
  • Pattern Consistency: Follows the established pattern from ControlledInput.stories.tsx
  • Component Integration: Uses both options array and children prop patterns
  • Compound Components: Leverages Select.Trigger, Select.Value, Select.Content, and Select.Item for custom rendering

📋 Features Covered

Supported Features:

  • Single select functionality
  • Form integration through react-hook-form
  • Error state handling
  • Loading state support
  • Custom option rendering
  • Size variants ('base' | 'small')
  • Disabled state
  • Default value handling
  • Validation rules
  • onChange handlers

Not Included (Not Currently Supported):

  • Multi-select functionality
  • Searchable select functionality
  • Creatable select functionality

Note: Multi-select and searchable/creatable variants were not included as they are not currently supported by the base Select component. The types suggest these may be planned features.

🎯 Story Structure

Each story includes:

  • Form state visualization
  • Interactive controls where applicable
  • Error state demonstrations
  • Real-time value tracking
  • Consistent 400px width for layout

📁 File Location

  • Created: apps/docs/src/medusa-forms/ControlledSelect.stories.tsx
  • Pattern: Follows existing controlled component story structure

Testing

The stories demonstrate:

  • ✅ Form integration and state management
  • ✅ Validation and error handling
  • ✅ Loading and disabled states
  • ✅ Custom option rendering
  • ✅ Size variants
  • ✅ Complex form scenarios
  • ✅ Interactive functionality

Next Steps

  1. Test stories in Storybook UI
  2. Verify all variants work correctly
  3. Consider adding multi-select support in future iterations
  4. Document any limitations or future enhancements

Related: Part of LC-240 Medusa Forms controlled components documentation effort


💻 View my workAbout Codegen

- Add 10 comprehensive story variants for ControlledSelect component
- Cover basic single select, default values, validation, loading states
- Include custom option rendering using Select compound components
- Add disabled state, error state, and size variants
- Include complex form integration and interactive demo
- Follow established pattern from ControlledInput.stories.tsx
- Use react-hook-form directly without react-router dependencies

Note: Multi-select and searchable/creatable variants not included
as they are not currently supported by the base Select component
@bolt-new-by-stackblitz
Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@coderabbitai
Copy link

coderabbitai bot commented May 31, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 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>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @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.

Support

Need help? Join our Discord community for assistance with any issues or questions.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file 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.

@codegen-sh
Copy link
Contributor Author

codegen-sh bot commented May 31, 2025

I see a check failed - I'm on it! 🫡

💻 View my work

- Fixed duplicate identifier conflicts in ControlledSelect.stories.tsx:
  - Renamed component function ComplexFormIntegration to ComplexFormIntegrationComponent
  - Renamed story exports to avoid conflicts: RequiredValidation → SelectRequiredValidation, DisabledState → SelectDisabledState, ErrorState → SelectErrorState
- Fixed duplicate identifier conflicts in ControlledCheckbox.stories.tsx:
  - Renamed component function CompleteFormExample to CompleteFormExampleComponent
- Fixed incorrect import path in ControlledCheckbox.stories.tsx:
  - Changed from '@lambdacurry/medusa-forms/controlled' to '@lambdacurry/medusa-forms/controlled/ControlledCheckbox'

These changes resolve the Storybook build failures caused by TypeScript identifier conflicts and import path issues.
@codegen-sh
Copy link
Contributor Author

codegen-sh bot commented May 31, 2025

✅ Fixed failing check suite in this commit.

The issue was caused by TypeScript identifier conflicts and import path issues in the Storybook stories:

🔧 Issues Fixed:

  1. Duplicate identifiers in ControlledSelect.stories.tsx:

    • Component function ComplexFormIntegration conflicted with story export of same name
    • Story exports conflicted with other files: RequiredValidation, DisabledState, ErrorState
  2. Duplicate identifiers in ControlledCheckbox.stories.tsx:

    • Component function CompleteFormExample conflicted with story export of same name
  3. Incorrect import path in ControlledCheckbox.stories.tsx:

    • Import from directory @lambdacurry/medusa-forms/controlled instead of specific file

🛠️ Solutions Applied:

  • Renamed component functions to avoid conflicts (added Component suffix)
  • Prefixed conflicting story exports with Select to make them unique
  • Fixed import path to point to specific component file
  • Storybook build now passes successfully

The PR is ready for review with all build issues resolved!

💻 View my work • React 👍 or 👎

@github-actions
Copy link
Contributor

📝 Storybook Preview: View Storybook

This preview will be updated automatically when you push new changes to this PR.

Note: The preview will be available after the workflow completes and the PR is approved for deployment.

@jaruesink jaruesink marked this pull request as ready for review May 31, 2025 03:57
@jaruesink jaruesink merged commit a790cdc into codegen/lc-240-medusa-forms-controlled-components-documentation-stories-and May 31, 2025
4 checks passed
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.

2 participants