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 the ControlledTextArea component as part of the Medusa Forms controlled components documentation effort.

Changes

✅ All 5 Required Story Variants Implemented:

  1. BasicUsage - Simple textarea with react-hook-form integration and multi-line text input
  2. CharacterLimits - Maximum character count validation, character counter display, and limit enforcement
  3. RequiredFieldValidation - Required field validation, error state display, and custom validation messages
  4. AutoResizeFunctionality - Dynamic height adjustment, content-based resizing, and min/max height constraints
  5. ValidationErrorStates - Various error scenarios, error message display, and field highlighting

✅ Additional Features:

  1. ComprehensiveExample - Complete form showing multiple ControlledTextArea components working together

Implementation Details

  • Follows established pattern from ControlledInput.stories.tsx
  • Uses react-hook-form directly with FormProvider and useForm (NO react-router-stub dependencies)
  • Multiple states covered (basic, validation, error, character limits)
  • Auto-resize and character limit functionality demonstrated
  • Well-documented stories with appropriate descriptions and controls
  • Real-world usage patterns with proper validation using zod schemas

File Created

  • apps/docs/src/medusa-forms/ControlledTextArea.stories.tsx

Testing

The stories can be tested in Storybook by running the docs application and navigating to "Medusa Forms/Controlled Text Area".

Acceptance Criteria ✅

  • All 5 story variants implemented
  • Stories use react-hook-form directly without react-router wrapper
  • Multiple states covered (basic, validation, error, character limits)
  • Follows consistent pattern with existing ControlledInput story
  • Auto-resize and character limit functionality demonstrated
  • Stories are well-documented with appropriate args and controls

Closes LC-245


💻 View my workAbout Codegen

- 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
@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

📝 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:56
@jaruesink jaruesink merged commit a00c074 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