Skip to content

Conversation

@codegen-sh
Copy link
Contributor

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

Overview

This PR implements comprehensive Storybook stories for Medusa Forms controlled components as part of the documentation and testing effort (LC-240).

✅ Completed Components

1. ControlledTextArea Stories (LC-245)

  • BasicUsage - Simple textarea with react-hook-form integration
  • CharacterLimits - Character count validation and counter display
  • RequiredFieldValidation - Required field validation with error states
  • AutoResizeFunctionality - Dynamic height adjustment with constraints
  • ValidationErrorStates - Various error scenarios and field highlighting
  • ComprehensiveExample - Multiple textareas in a complete form

2. ControlledCurrencyInput Stories (LC-244)

  • Different Currency Symbols - USD, EUR, GBP currency inputs
  • Validation with Min/Max Values - Range validation scenarios
  • Error Handling - Required field and custom validation messages
  • Different Currency Codes - JPY, CAD, AUD with locale formatting

3. ControlledDatePicker Stories (LC-242)

  • BasicDateSelection - Simple date picker functionality
  • RequiredFieldValidation - Form validation integration with error states
  • DateFormatVariations - US, European, and ISO date formats
  • DisabledDates - Past/future date restrictions and specific ranges
  • MinMaxDateConstraints - Business days, age verification, and date ranges

4. ControlledCheckbox Stories (LC-243) ⭐ NEW

  • BasicUsage - Simple checkbox with react-hook-form integration
  • DefaultChecked/Unchecked - Pre-checked and default states
  • RequiredValidation - Required field validation with error handling
  • CustomValidationMessage - Custom validation rules and messages
  • ErrorState - Error state styling and display
  • DisabledState - Disabled checkbox functionality
  • MultipleCheckboxes - Advanced select-all functionality with indeterminate state
  • CompleteFormExample - Full form integration with mixed input types

🎯 Implementation Standards

  • React Hook Form Integration - All stories use FormProvider and useForm directly
  • NO react-router-stub dependencies - Clean, focused implementations
  • Consistent Patterns - Follows established ControlledInput.stories.tsx pattern
  • Comprehensive Validation - Uses zod schemas for robust validation
  • Well-documented - Each story includes proper descriptions and examples
  • Real-world Scenarios - Covers practical use cases and edge cases

📁 Files Added

  • apps/docs/src/medusa-forms/ControlledTextArea.stories.tsx
  • apps/docs/src/medusa-forms/ControlledCurrencyInput.stories.tsx
  • apps/docs/src/medusa-forms/ControlledDatePicker.stories.tsx
  • apps/docs/src/medusa-forms/ControlledCheckbox.stories.tsx ⭐ NEW
  • apps/docs/src/medusa-forms/controlled-components/README.md (scaffolding)

🧪 Testing

The stories can be tested in Storybook by running the docs application and navigating to the "Medusa Forms" section. Each component includes multiple interactive examples demonstrating various states and validation scenarios.

📋 Remaining Work

This PR completes 4 of 7 planned sub-issues (57% complete). Remaining components:

  • LC-241: ControlledSelect Stories (High Priority)
  • LC-246: Form Integration Examples (Lower Priority)
  • LC-247: Storybook Testing (Lower Priority)

🤝 Team Collaboration

This work was completed through coordinated effort with multiple child agents:

  • Agent #27944: ControlledTextArea implementation
  • Agent #27943: ControlledCurrencyInput implementation
  • Agent #27941: ControlledDatePicker implementation
  • Agent #27942: ControlledCheckbox implementation ⭐ NEW

All work was merged into this single coordinated branch to maintain consistency and avoid conflicts.


Closes LC-245, LC-244, LC-242, LC-243
Part of LC-240

🔗 View Storybook Preview (when available)

codegen-sh bot added 5 commits May 31, 2025 03:05
- Created directory structure for controlled component stories
- Added README with implementation plan and template pattern
- Based on medusa-forms-upgrades branch as requested
- Add BasicUsage story with simple textarea and react-hook-form integration
- Add CharacterLimits story with character count validation and display
- Add RequiredFieldValidation story with error states and custom messages
- Add AutoResizeFunctionality story with dynamic height adjustment
- Add ValidationErrorStates story with various error scenarios
- Add ComprehensiveExample story showing multiple textareas in a form
- Follow established pattern from ControlledInput.stories.tsx
- Use react-hook-form directly with FormProvider and useForm
- Include proper validation with zod schemas
- Demonstrate real-world usage patterns

Addresses LC-245: Create ControlledTextArea Storybook Stories
- Complete Registration Form with multi-step validation
- Product Creation Form demonstrating all controlled components
- Form Validation Showcase with various validation scenarios
- Real-world usage patterns with error handling and submit states
- Comprehensive documentation for each example

Components integrated:
- ControlledInput (text, email, password, number)
- ControlledCheckbox (terms, preferences, status flags)
- ControlledSelect (country, category selection)
- ControlledDatePicker (birth date, launch date with constraints)
- ControlledCurrencyInput (pricing with validation)
- ControlledTextArea (descriptions, tags)

Validation features:
- Real-time validation with react-hook-form
- Complex business rules (age verification, price ranges)
- Format validation (email, SKU patterns, dimensions)
- Cross-field validation (password confirmation)
- Submit handling with loading states and success feedback
- ControlledCurrencyInput: 4 story variants (USD/EUR/GBP, validation, error handling, different currency codes)
- ControlledDatePicker: 5 story variants (basic, validation, formats, disabled dates, constraints)
- Both follow react-hook-form pattern with comprehensive validation
- Merged from agents #27943 and #27941 work on LC-244 and LC-242
@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.

@github-actions
Copy link
Contributor

github-actions bot commented May 31, 2025

📝 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.

codegen-sh bot and others added 6 commits May 31, 2025 03:24
- Comprehensive implementation with 8 story variants
- BasicUsage, DefaultChecked/Unchecked, RequiredValidation, CustomValidation
- ErrorState, DisabledState, MultipleCheckboxes, CompleteFormExample
- Follows react-hook-form pattern with proper boolean value handling
- Includes advanced features like select-all functionality

Merged from agent #27942's work on LC-243
- 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
- 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.
@jaruesink jaruesink marked this pull request as ready for review May 31, 2025 04:01
@jaruesink jaruesink merged commit 67fe131 into medusa-forms-upgrades 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