Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
315 changes: 315 additions & 0 deletions packages/medusa-forms/REGISTRY.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,315 @@
# Medusa Forms shadcn/ui Registry

This package provides a custom shadcn/ui registry for medusa-forms components, allowing developers to install them using the native shadcn CLI while preserving the valuable field wrapper structure with built-in labels and error handling.

## Installation

You can install individual medusa-forms components using the shadcn CLI. The registry automatically handles dependencies, so installing a controlled component will also install the necessary UI wrapper components:

```bash
# Install controlled components (automatically includes UI dependencies)
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-input.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-select.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-checkbox.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-textarea.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-datepicker.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-currency-input.json

# Or install UI components individually if needed
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/input.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/field-wrapper.json
```

## Architecture

### πŸ—οΈ **Preserved Field Wrapper Structure**

The registry maintains the valuable field wrapper architecture that provides superior UX:

- **FieldWrapper**: Handles labels, tooltips, and error display
- **UI Components**: Input, Select, Checkbox, etc. with built-in wrapper integration
- **Controlled Components**: react-hook-form integration with wrapper components

### πŸ“¦ **Dependency Management**

The registry automatically handles the dependency chain:

```
ControlledInput
└── Input
└── FieldWrapper
β”œβ”€β”€ FieldError
└── Label
```

When you install `controlled-input`, shadcn automatically copies:
- `ControlledInput.tsx` (main component)
- `Input.tsx` (UI wrapper)
- `FieldWrapper.tsx` (field wrapper logic)
- `Error.tsx` (error display)
- `Label.tsx` (label with tooltip support)
- `types.d.ts` (TypeScript definitions)

## Available Components

### Controlled Components (with react-hook-form)

#### ControlledInput
```tsx
import { ControlledInput } from '@/components/ui/controlled-input'

<ControlledInput
name="email"
label="Email Address"
placeholder="Enter your email"
labelTooltip="We'll never share your email"
rules={{ required: 'Email is required' }}
/>
```

#### ControlledSelect
```tsx
import { ControlledSelect } from '@/components/ui/controlled-select'

const options = [
{ label: 'Option 1', value: 'option1' },
{ label: 'Option 2', value: 'option2' },
]

<ControlledSelect
name="category"
label="Category"
placeholder="Select a category"
options={options}
rules={{ required: 'Category is required' }}
/>
```

#### ControlledCheckbox
```tsx
import { ControlledCheckbox } from '@/components/ui/controlled-checkbox'

<ControlledCheckbox
name="terms"
label="I agree to the terms and conditions"
description="You must agree to continue"
rules={{ required: 'You must agree to the terms' }}
/>
```

#### ControlledTextarea
```tsx
import { ControlledTextarea } from '@/components/ui/controlled-textarea'

<ControlledTextarea
name="description"
label="Description"
placeholder="Enter a description"
rows={4}
rules={{ required: 'Description is required' }}
/>
```

#### ControlledDatePicker
```tsx
import { ControlledDatePicker } from '@/components/ui/controlled-datepicker'

<ControlledDatePicker
name="birthDate"
label="Birth Date"
placeholder="Select your birth date"
rules={{ required: 'Birth date is required' }}
/>
```

#### ControlledCurrencyInput
```tsx
import { ControlledCurrencyInput } from '@/components/ui/controlled-currency-input'

<ControlledCurrencyInput
name="price"
label="Price"
symbol="$"
code="USD"
rules={{ required: 'Price is required' }}
/>
```

### UI Components (standalone)

#### Input
```tsx
import { Input } from '@/components/ui/input'

<Input
label="Email"
placeholder="Enter email"
labelTooltip="Your email address"
formErrors={errors}
name="email"
/>
```

#### FieldWrapper
```tsx
import { FieldWrapper } from '@/components/ui/field-wrapper'

<FieldWrapper
label="Custom Field"
labelTooltip="Additional information"
formErrors={errors}
name="custom"
>
{(props) => <CustomInput {...props} />}
</FieldWrapper>
```

## Prerequisites

Before using these components, make sure you have:

1. **shadcn/ui initialized** in your project:
```bash
npx shadcn@latest init
```

2. **Required dependencies** installed:
```bash
npm install @medusajs/ui react-hook-form
```

3. **FormProvider setup** for controlled components:
```tsx
import { useForm, FormProvider } from 'react-hook-form'

function MyForm() {
const methods = useForm()

return (
<FormProvider {...methods}>
<form onSubmit={methods.handleSubmit(onSubmit)}>
{/* Your controlled components here */}
</form>
</FormProvider>
)
}
```

## Benefits

βœ… **Preserved Architecture**: Maintains valuable field wrapper structure
βœ… **Built-in Labels & Errors**: Superior UX with integrated label and error handling
βœ… **Automatic Dependencies**: shadcn handles all component dependencies
βœ… **No Custom CLI**: Leverage existing shadcn infrastructure
βœ… **TypeScript Support**: Full TypeScript compatibility
βœ… **Familiar UX**: Developers already know `npx shadcn@latest add`
βœ… **v0 Compatible**: Components work with v0.dev
βœ… **Single Source of Truth**: Components serve both shadcn and npm package usage

## Registry Structure

```
packages/medusa-forms/
β”œβ”€β”€ registry.json # Main registry configuration
β”œβ”€β”€ registry/ # Component registry files
β”‚ β”œβ”€β”€ controlled-*.json # Controlled components
β”‚ β”œβ”€β”€ field-wrapper.json # Core wrapper component
β”‚ β”œβ”€β”€ input.json # UI components
β”‚ └── ...
β”œβ”€β”€ src/controlled/ # Controlled component source files
β”‚ β”œβ”€β”€ ControlledInput.tsx
β”‚ └── ...
└── src/ui/ # UI wrapper components
β”œβ”€β”€ FieldWrapper.tsx # Core field wrapper
β”œβ”€β”€ Input.tsx # Input with wrapper
β”œβ”€β”€ Error.tsx # Error display
β”œβ”€β”€ Label.tsx # Label with tooltip
β”œβ”€β”€ types.d.ts # TypeScript definitions
└── ...
```

## Dependency Chain

The registry manages a complete dependency chain:

```
Controlled Components
β”œβ”€β”€ ControlledInput β†’ Input β†’ FieldWrapper β†’ [FieldError, Label]
β”œβ”€β”€ ControlledSelect β†’ Select β†’ FieldWrapper β†’ [FieldError, Label]
β”œβ”€β”€ ControlledCheckbox β†’ FieldCheckbox β†’ [FieldWrapper, Label] β†’ [FieldError]
β”œβ”€β”€ ControlledTextarea β†’ TextArea β†’ FieldWrapper β†’ [FieldError, Label]
β”œβ”€β”€ ControlledDatePicker β†’ DatePicker β†’ FieldWrapper β†’ [FieldError, Label]
└── ControlledCurrencyInput β†’ CurrencyInput β†’ FieldWrapper β†’ [FieldError, Label]

Core Components
β”œβ”€β”€ FieldWrapper (requires FieldError, Label, types.d.ts)
β”œβ”€β”€ FieldError (standalone)
└── Label (standalone)
```

## Usage Patterns

### 1. **Form with Validation**
```tsx
import { useForm, FormProvider } from 'react-hook-form'
import { ControlledInput, ControlledSelect } from '@/components/ui'

function ContactForm() {
const methods = useForm()

return (
<FormProvider {...methods}>
<form onSubmit={methods.handleSubmit(onSubmit)}>
<ControlledInput
name="name"
label="Full Name"
rules={{ required: 'Name is required' }}
/>
<ControlledSelect
name="country"
label="Country"
options={countries}
rules={{ required: 'Please select a country' }}
/>
</form>
</FormProvider>
)
}
```

### 2. **Custom Field with Wrapper**
```tsx
import { FieldWrapper } from '@/components/ui/field-wrapper'

function CustomField({ name, label, formErrors }) {
return (
<FieldWrapper
name={name}
label={label}
formErrors={formErrors}
labelTooltip="Custom field tooltip"
>
{(props) => (
<div className="custom-input">
<input {...props} />
</div>
)}
</FieldWrapper>
)
}
```

## Contributing

To add new components to the registry:

1. Create the UI component in `src/ui/` following the wrapper pattern
2. Create the controlled component in `src/controlled/`
3. Add both to the main `registry.json` with proper dependencies
4. Generate the individual JSON files
5. Update this documentation

## License

This project is licensed under the same license as the main forms repository.

Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
315 changes: 315 additions & 0 deletions packages/medusa-forms/REGISTRY.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,315 @@
# Medusa Forms shadcn/ui Registry

This package provides a custom shadcn/ui registry for medusa-forms components, allowing developers to install them using the native shadcn CLI while preserving the valuable field wrapper structure with built-in labels and error handling.

## Installation

You can install individual medusa-forms components using the shadcn CLI. The registry automatically handles dependencies, so installing a controlled component will also install the necessary UI wrapper components:

```bash
# Install controlled components (automatically includes UI dependencies)
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-input.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-select.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-checkbox.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-textarea.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-datepicker.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-currency-input.json

# Or install UI components individually if needed
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/input.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/field-wrapper.json
```

## Architecture

### πŸ—οΈ **Preserved Field Wrapper Structure**

The registry maintains the valuable field wrapper architecture that provides superior UX:

- **FieldWrapper**: Handles labels, tooltips, and error display
- **UI Components**: Input, Select, Checkbox, etc. with built-in wrapper integration
- **Controlled Components**: react-hook-form integration with wrapper components

### πŸ“¦ **Dependency Management**

The registry automatically handles the dependency chain:

```
ControlledInput
└── Input
└── FieldWrapper
β”œβ”€β”€ FieldError
└── Label
```

When you install `controlled-input`, shadcn automatically copies:
- `ControlledInput.tsx` (main component)
- `Input.tsx` (UI wrapper)
- `FieldWrapper.tsx` (field wrapper logic)
- `Error.tsx` (error display)
- `Label.tsx` (label with tooltip support)
- `types.d.ts` (TypeScript definitions)

## Available Components

### Controlled Components (with react-hook-form)

#### ControlledInput
```tsx
import { ControlledInput } from '@/components/ui/controlled-input'

<ControlledInput
name="email"
label="Email Address"
placeholder="Enter your email"
labelTooltip="We'll never share your email"
rules={{ required: 'Email is required' }}
/>
```

#### ControlledSelect
```tsx
import { ControlledSelect } from '@/components/ui/controlled-select'

const options = [
{ label: 'Option 1', value: 'option1' },
{ label: 'Option 2', value: 'option2' },
]

<ControlledSelect
name="category"
label="Category"
placeholder="Select a category"
options={options}
rules={{ required: 'Category is required' }}
/>
```

#### ControlledCheckbox
```tsx
import { ControlledCheckbox } from '@/components/ui/controlled-checkbox'

<ControlledCheckbox
name="terms"
label="I agree to the terms and conditions"
description="You must agree to continue"
rules={{ required: 'You must agree to the terms' }}
/>
```

#### ControlledTextarea
```tsx
import { ControlledTextarea } from '@/components/ui/controlled-textarea'

<ControlledTextarea
name="description"
label="Description"
placeholder="Enter a description"
rows={4}
rules={{ required: 'Description is required' }}
/>
```

#### ControlledDatePicker
```tsx
import { ControlledDatePicker } from '@/components/ui/controlled-datepicker'

<ControlledDatePicker
name="birthDate"
label="Birth Date"
placeholder="Select your birth date"
rules={{ required: 'Birth date is required' }}
/>
```

#### ControlledCurrencyInput
```tsx
import { ControlledCurrencyInput } from '@/components/ui/controlled-currency-input'

<ControlledCurrencyInput
name="price"
label="Price"
symbol="$"
code="USD"
rules={{ required: 'Price is required' }}
/>
```

### UI Components (standalone)

#### Input
```tsx
import { Input } from '@/components/ui/input'

<Input
label="Email"
placeholder="Enter email"
labelTooltip="Your email address"
formErrors={errors}
name="email"
/>
```

#### FieldWrapper
```tsx
import { FieldWrapper } from '@/components/ui/field-wrapper'

<FieldWrapper
label="Custom Field"
labelTooltip="Additional information"
formErrors={errors}
name="custom"
>
{(props) => <CustomInput {...props} />}
</FieldWrapper>
```

## Prerequisites

Before using these components, make sure you have:

1. **shadcn/ui initialized** in your project:
```bash
npx shadcn@latest init
```

2. **Required dependencies** installed:
```bash
npm install @medusajs/ui react-hook-form
```

3. **FormProvider setup** for controlled components:
```tsx
import { useForm, FormProvider } from 'react-hook-form'

function MyForm() {
const methods = useForm()

return (
<FormProvider {...methods}>
<form onSubmit={methods.handleSubmit(onSubmit)}>
{/* Your controlled components here */}
</form>
</FormProvider>
)
}
```

## Benefits

βœ… **Preserved Architecture**: Maintains valuable field wrapper structure
βœ… **Built-in Labels & Errors**: Superior UX with integrated label and error handling
βœ… **Automatic Dependencies**: shadcn handles all component dependencies
βœ… **No Custom CLI**: Leverage existing shadcn infrastructure
βœ… **TypeScript Support**: Full TypeScript compatibility
βœ… **Familiar UX**: Developers already know `npx shadcn@latest add`
βœ… **v0 Compatible**: Components work with v0.dev
βœ… **Single Source of Truth**: Components serve both shadcn and npm package usage

## Registry Structure

```
packages/medusa-forms/
β”œβ”€β”€ registry.json # Main registry configuration
β”œβ”€β”€ registry/ # Component registry files
β”‚ β”œβ”€β”€ controlled-*.json # Controlled components
β”‚ β”œβ”€β”€ field-wrapper.json # Core wrapper component
β”‚ β”œβ”€β”€ input.json # UI components
β”‚ └── ...
β”œβ”€β”€ src/controlled/ # Controlled component source files
β”‚ β”œβ”€β”€ ControlledInput.tsx
β”‚ └── ...
└── src/ui/ # UI wrapper components
β”œβ”€β”€ FieldWrapper.tsx # Core field wrapper
β”œβ”€β”€ Input.tsx # Input with wrapper
β”œβ”€β”€ Error.tsx # Error display
β”œβ”€β”€ Label.tsx # Label with tooltip
β”œβ”€β”€ types.d.ts # TypeScript definitions
└── ...
```

## Dependency Chain

The registry manages a complete dependency chain:

```
Controlled Components
β”œβ”€β”€ ControlledInput β†’ Input β†’ FieldWrapper β†’ [FieldError, Label]
β”œβ”€β”€ ControlledSelect β†’ Select β†’ FieldWrapper β†’ [FieldError, Label]
β”œβ”€β”€ ControlledCheckbox β†’ FieldCheckbox β†’ [FieldWrapper, Label] β†’ [FieldError]
β”œβ”€β”€ ControlledTextarea β†’ TextArea β†’ FieldWrapper β†’ [FieldError, Label]
β”œβ”€β”€ ControlledDatePicker β†’ DatePicker β†’ FieldWrapper β†’ [FieldError, Label]
└── ControlledCurrencyInput β†’ CurrencyInput β†’ FieldWrapper β†’ [FieldError, Label]

Core Components
β”œβ”€β”€ FieldWrapper (requires FieldError, Label, types.d.ts)
β”œβ”€β”€ FieldError (standalone)
└── Label (standalone)
```

## Usage Patterns

### 1. **Form with Validation**
```tsx
import { useForm, FormProvider } from 'react-hook-form'
import { ControlledInput, ControlledSelect } from '@/components/ui'

function ContactForm() {
const methods = useForm()

return (
<FormProvider {...methods}>
<form onSubmit={methods.handleSubmit(onSubmit)}>
<ControlledInput
name="name"
label="Full Name"
rules={{ required: 'Name is required' }}
/>
<ControlledSelect
name="country"
label="Country"
options={countries}
rules={{ required: 'Please select a country' }}
/>
</form>
</FormProvider>
)
}
```

### 2. **Custom Field with Wrapper**
```tsx
import { FieldWrapper } from '@/components/ui/field-wrapper'

function CustomField({ name, label, formErrors }) {
return (
<FieldWrapper
name={name}
label={label}
formErrors={formErrors}
labelTooltip="Custom field tooltip"
>
{(props) => (
<div className="custom-input">
<input {...props} />
</div>
)}
</FieldWrapper>
)
}
```

## Contributing

To add new components to the registry:

1. Create the UI component in `src/ui/` following the wrapper pattern
2. Create the controlled component in `src/controlled/`
3. Add both to the main `registry.json` with proper dependencies
4. Generate the individual JSON files
5. Update this documentation

## License

This project is licensed under the same license as the main forms repository.

Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
315 changes: 315 additions & 0 deletions packages/medusa-forms/REGISTRY.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,315 @@
# Medusa Forms shadcn/ui Registry

This package provides a custom shadcn/ui registry for medusa-forms components, allowing developers to install them using the native shadcn CLI while preserving the valuable field wrapper structure with built-in labels and error handling.

## Installation

You can install individual medusa-forms components using the shadcn CLI. The registry automatically handles dependencies, so installing a controlled component will also install the necessary UI wrapper components:

```bash
# Install controlled components (automatically includes UI dependencies)
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-input.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-select.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-checkbox.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-textarea.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-datepicker.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-currency-input.json

# Or install UI components individually if needed
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/input.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/field-wrapper.json
```

## Architecture

### πŸ—οΈ **Preserved Field Wrapper Structure**

The registry maintains the valuable field wrapper architecture that provides superior UX:

- **FieldWrapper**: Handles labels, tooltips, and error display
- **UI Components**: Input, Select, Checkbox, etc. with built-in wrapper integration
- **Controlled Components**: react-hook-form integration with wrapper components

### πŸ“¦ **Dependency Management**

The registry automatically handles the dependency chain:

```
ControlledInput
└── Input
└── FieldWrapper
β”œβ”€β”€ FieldError
└── Label
```

When you install `controlled-input`, shadcn automatically copies:
- `ControlledInput.tsx` (main component)
- `Input.tsx` (UI wrapper)
- `FieldWrapper.tsx` (field wrapper logic)
- `Error.tsx` (error display)
- `Label.tsx` (label with tooltip support)
- `types.d.ts` (TypeScript definitions)

## Available Components

### Controlled Components (with react-hook-form)

#### ControlledInput
```tsx
import { ControlledInput } from '@/components/ui/controlled-input'

<ControlledInput
name="email"
label="Email Address"
placeholder="Enter your email"
labelTooltip="We'll never share your email"
rules={{ required: 'Email is required' }}
/>
```

#### ControlledSelect
```tsx
import { ControlledSelect } from '@/components/ui/controlled-select'

const options = [
{ label: 'Option 1', value: 'option1' },
{ label: 'Option 2', value: 'option2' },
]

<ControlledSelect
name="category"
label="Category"
placeholder="Select a category"
options={options}
rules={{ required: 'Category is required' }}
/>
```

#### ControlledCheckbox
```tsx
import { ControlledCheckbox } from '@/components/ui/controlled-checkbox'

<ControlledCheckbox
name="terms"
label="I agree to the terms and conditions"
description="You must agree to continue"
rules={{ required: 'You must agree to the terms' }}
/>
```

#### ControlledTextarea
```tsx
import { ControlledTextarea } from '@/components/ui/controlled-textarea'

<ControlledTextarea
name="description"
label="Description"
placeholder="Enter a description"
rows={4}
rules={{ required: 'Description is required' }}
/>
```

#### ControlledDatePicker
```tsx
import { ControlledDatePicker } from '@/components/ui/controlled-datepicker'

<ControlledDatePicker
name="birthDate"
label="Birth Date"
placeholder="Select your birth date"
rules={{ required: 'Birth date is required' }}
/>
```

#### ControlledCurrencyInput
```tsx
import { ControlledCurrencyInput } from '@/components/ui/controlled-currency-input'

<ControlledCurrencyInput
name="price"
label="Price"
symbol="$"
code="USD"
rules={{ required: 'Price is required' }}
/>
```

### UI Components (standalone)

#### Input
```tsx
import { Input } from '@/components/ui/input'

<Input
label="Email"
placeholder="Enter email"
labelTooltip="Your email address"
formErrors={errors}
name="email"
/>
```

#### FieldWrapper
```tsx
import { FieldWrapper } from '@/components/ui/field-wrapper'

<FieldWrapper
label="Custom Field"
labelTooltip="Additional information"
formErrors={errors}
name="custom"
>
{(props) => <CustomInput {...props} />}
</FieldWrapper>
```

## Prerequisites

Before using these components, make sure you have:

1. **shadcn/ui initialized** in your project:
```bash
npx shadcn@latest init
```

2. **Required dependencies** installed:
```bash
npm install @medusajs/ui react-hook-form
```

3. **FormProvider setup** for controlled components:
```tsx
import { useForm, FormProvider } from 'react-hook-form'

function MyForm() {
const methods = useForm()

return (
<FormProvider {...methods}>
<form onSubmit={methods.handleSubmit(onSubmit)}>
{/* Your controlled components here */}
</form>
</FormProvider>
)
}
```

## Benefits

βœ… **Preserved Architecture**: Maintains valuable field wrapper structure
βœ… **Built-in Labels & Errors**: Superior UX with integrated label and error handling
βœ… **Automatic Dependencies**: shadcn handles all component dependencies
βœ… **No Custom CLI**: Leverage existing shadcn infrastructure
βœ… **TypeScript Support**: Full TypeScript compatibility
βœ… **Familiar UX**: Developers already know `npx shadcn@latest add`
βœ… **v0 Compatible**: Components work with v0.dev
βœ… **Single Source of Truth**: Components serve both shadcn and npm package usage

## Registry Structure

```
packages/medusa-forms/
β”œβ”€β”€ registry.json # Main registry configuration
β”œβ”€β”€ registry/ # Component registry files
β”‚ β”œβ”€β”€ controlled-*.json # Controlled components
β”‚ β”œβ”€β”€ field-wrapper.json # Core wrapper component
β”‚ β”œβ”€β”€ input.json # UI components
β”‚ └── ...
β”œβ”€β”€ src/controlled/ # Controlled component source files
β”‚ β”œβ”€β”€ ControlledInput.tsx
β”‚ └── ...
└── src/ui/ # UI wrapper components
β”œβ”€β”€ FieldWrapper.tsx # Core field wrapper
β”œβ”€β”€ Input.tsx # Input with wrapper
β”œβ”€β”€ Error.tsx # Error display
β”œβ”€β”€ Label.tsx # Label with tooltip
β”œβ”€β”€ types.d.ts # TypeScript definitions
└── ...
```

## Dependency Chain

The registry manages a complete dependency chain:

```
Controlled Components
β”œβ”€β”€ ControlledInput β†’ Input β†’ FieldWrapper β†’ [FieldError, Label]
β”œβ”€β”€ ControlledSelect β†’ Select β†’ FieldWrapper β†’ [FieldError, Label]
β”œβ”€β”€ ControlledCheckbox β†’ FieldCheckbox β†’ [FieldWrapper, Label] β†’ [FieldError]
β”œβ”€β”€ ControlledTextarea β†’ TextArea β†’ FieldWrapper β†’ [FieldError, Label]
β”œβ”€β”€ ControlledDatePicker β†’ DatePicker β†’ FieldWrapper β†’ [FieldError, Label]
└── ControlledCurrencyInput β†’ CurrencyInput β†’ FieldWrapper β†’ [FieldError, Label]

Core Components
β”œβ”€β”€ FieldWrapper (requires FieldError, Label, types.d.ts)
β”œβ”€β”€ FieldError (standalone)
└── Label (standalone)
```

## Usage Patterns

### 1. **Form with Validation**
```tsx
import { useForm, FormProvider } from 'react-hook-form'
import { ControlledInput, ControlledSelect } from '@/components/ui'

function ContactForm() {
const methods = useForm()

return (
<FormProvider {...methods}>
<form onSubmit={methods.handleSubmit(onSubmit)}>
<ControlledInput
name="name"
label="Full Name"
rules={{ required: 'Name is required' }}
/>
<ControlledSelect
name="country"
label="Country"
options={countries}
rules={{ required: 'Please select a country' }}
/>
</form>
</FormProvider>
)
}
```

### 2. **Custom Field with Wrapper**
```tsx
import { FieldWrapper } from '@/components/ui/field-wrapper'

function CustomField({ name, label, formErrors }) {
return (
<FieldWrapper
name={name}
label={label}
formErrors={formErrors}
labelTooltip="Custom field tooltip"
>
{(props) => (
<div className="custom-input">
<input {...props} />
</div>
)}
</FieldWrapper>
)
}
```

## Contributing

To add new components to the registry:

1. Create the UI component in `src/ui/` following the wrapper pattern
2. Create the controlled component in `src/controlled/`
3. Add both to the main `registry.json` with proper dependencies
4. Generate the individual JSON files
5. Update this documentation

## License

This project is licensed under the same license as the main forms repository.

Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
315 changes: 315 additions & 0 deletions packages/medusa-forms/REGISTRY.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,315 @@
# Medusa Forms shadcn/ui Registry

This package provides a custom shadcn/ui registry for medusa-forms components, allowing developers to install them using the native shadcn CLI while preserving the valuable field wrapper structure with built-in labels and error handling.

## Installation

You can install individual medusa-forms components using the shadcn CLI. The registry automatically handles dependencies, so installing a controlled component will also install the necessary UI wrapper components:

```bash
# Install controlled components (automatically includes UI dependencies)
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-input.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-select.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-checkbox.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-textarea.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-datepicker.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-currency-input.json

# Or install UI components individually if needed
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/input.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/field-wrapper.json
```

## Architecture

### πŸ—οΈ **Preserved Field Wrapper Structure**

The registry maintains the valuable field wrapper architecture that provides superior UX:

- **FieldWrapper**: Handles labels, tooltips, and error display
- **UI Components**: Input, Select, Checkbox, etc. with built-in wrapper integration
- **Controlled Components**: react-hook-form integration with wrapper components

### πŸ“¦ **Dependency Management**

The registry automatically handles the dependency chain:

```
ControlledInput
└── Input
└── FieldWrapper
β”œβ”€β”€ FieldError
└── Label
```

When you install `controlled-input`, shadcn automatically copies:
- `ControlledInput.tsx` (main component)
- `Input.tsx` (UI wrapper)
- `FieldWrapper.tsx` (field wrapper logic)
- `Error.tsx` (error display)
- `Label.tsx` (label with tooltip support)
- `types.d.ts` (TypeScript definitions)

## Available Components

### Controlled Components (with react-hook-form)

#### ControlledInput
```tsx
import { ControlledInput } from '@/components/ui/controlled-input'

<ControlledInput
name="email"
label="Email Address"
placeholder="Enter your email"
labelTooltip="We'll never share your email"
rules={{ required: 'Email is required' }}
/>
```

#### ControlledSelect
```tsx
import { ControlledSelect } from '@/components/ui/controlled-select'

const options = [
{ label: 'Option 1', value: 'option1' },
{ label: 'Option 2', value: 'option2' },
]

<ControlledSelect
name="category"
label="Category"
placeholder="Select a category"
options={options}
rules={{ required: 'Category is required' }}
/>
```

#### ControlledCheckbox
```tsx
import { ControlledCheckbox } from '@/components/ui/controlled-checkbox'

<ControlledCheckbox
name="terms"
label="I agree to the terms and conditions"
description="You must agree to continue"
rules={{ required: 'You must agree to the terms' }}
/>
```

#### ControlledTextarea
```tsx
import { ControlledTextarea } from '@/components/ui/controlled-textarea'

<ControlledTextarea
name="description"
label="Description"
placeholder="Enter a description"
rows={4}
rules={{ required: 'Description is required' }}
/>
```

#### ControlledDatePicker
```tsx
import { ControlledDatePicker } from '@/components/ui/controlled-datepicker'

<ControlledDatePicker
name="birthDate"
label="Birth Date"
placeholder="Select your birth date"
rules={{ required: 'Birth date is required' }}
/>
```

#### ControlledCurrencyInput
```tsx
import { ControlledCurrencyInput } from '@/components/ui/controlled-currency-input'

<ControlledCurrencyInput
name="price"
label="Price"
symbol="$"
code="USD"
rules={{ required: 'Price is required' }}
/>
```

### UI Components (standalone)

#### Input
```tsx
import { Input } from '@/components/ui/input'

<Input
label="Email"
placeholder="Enter email"
labelTooltip="Your email address"
formErrors={errors}
name="email"
/>
```

#### FieldWrapper
```tsx
import { FieldWrapper } from '@/components/ui/field-wrapper'

<FieldWrapper
label="Custom Field"
labelTooltip="Additional information"
formErrors={errors}
name="custom"
>
{(props) => <CustomInput {...props} />}
</FieldWrapper>
```

## Prerequisites

Before using these components, make sure you have:

1. **shadcn/ui initialized** in your project:
```bash
npx shadcn@latest init
```

2. **Required dependencies** installed:
```bash
npm install @medusajs/ui react-hook-form
```

3. **FormProvider setup** for controlled components:
```tsx
import { useForm, FormProvider } from 'react-hook-form'

function MyForm() {
const methods = useForm()

return (
<FormProvider {...methods}>
<form onSubmit={methods.handleSubmit(onSubmit)}>
{/* Your controlled components here */}
</form>
</FormProvider>
)
}
```

## Benefits

βœ… **Preserved Architecture**: Maintains valuable field wrapper structure
βœ… **Built-in Labels & Errors**: Superior UX with integrated label and error handling
βœ… **Automatic Dependencies**: shadcn handles all component dependencies
βœ… **No Custom CLI**: Leverage existing shadcn infrastructure
βœ… **TypeScript Support**: Full TypeScript compatibility
βœ… **Familiar UX**: Developers already know `npx shadcn@latest add`
βœ… **v0 Compatible**: Components work with v0.dev
βœ… **Single Source of Truth**: Components serve both shadcn and npm package usage

## Registry Structure

```
packages/medusa-forms/
β”œβ”€β”€ registry.json # Main registry configuration
β”œβ”€β”€ registry/ # Component registry files
β”‚ β”œβ”€β”€ controlled-*.json # Controlled components
β”‚ β”œβ”€β”€ field-wrapper.json # Core wrapper component
β”‚ β”œβ”€β”€ input.json # UI components
β”‚ └── ...
β”œβ”€β”€ src/controlled/ # Controlled component source files
β”‚ β”œβ”€β”€ ControlledInput.tsx
β”‚ └── ...
└── src/ui/ # UI wrapper components
β”œβ”€β”€ FieldWrapper.tsx # Core field wrapper
β”œβ”€β”€ Input.tsx # Input with wrapper
β”œβ”€β”€ Error.tsx # Error display
β”œβ”€β”€ Label.tsx # Label with tooltip
β”œβ”€β”€ types.d.ts # TypeScript definitions
└── ...
```

## Dependency Chain

The registry manages a complete dependency chain:

```
Controlled Components
β”œβ”€β”€ ControlledInput β†’ Input β†’ FieldWrapper β†’ [FieldError, Label]
β”œβ”€β”€ ControlledSelect β†’ Select β†’ FieldWrapper β†’ [FieldError, Label]
β”œβ”€β”€ ControlledCheckbox β†’ FieldCheckbox β†’ [FieldWrapper, Label] β†’ [FieldError]
β”œβ”€β”€ ControlledTextarea β†’ TextArea β†’ FieldWrapper β†’ [FieldError, Label]
β”œβ”€β”€ ControlledDatePicker β†’ DatePicker β†’ FieldWrapper β†’ [FieldError, Label]
└── ControlledCurrencyInput β†’ CurrencyInput β†’ FieldWrapper β†’ [FieldError, Label]

Core Components
β”œβ”€β”€ FieldWrapper (requires FieldError, Label, types.d.ts)
β”œβ”€β”€ FieldError (standalone)
└── Label (standalone)
```

## Usage Patterns

### 1. **Form with Validation**
```tsx
import { useForm, FormProvider } from 'react-hook-form'
import { ControlledInput, ControlledSelect } from '@/components/ui'

function ContactForm() {
const methods = useForm()

return (
<FormProvider {...methods}>
<form onSubmit={methods.handleSubmit(onSubmit)}>
<ControlledInput
name="name"
label="Full Name"
rules={{ required: 'Name is required' }}
/>
<ControlledSelect
name="country"
label="Country"
options={countries}
rules={{ required: 'Please select a country' }}
/>
</form>
</FormProvider>
)
}
```

### 2. **Custom Field with Wrapper**
```tsx
import { FieldWrapper } from '@/components/ui/field-wrapper'

function CustomField({ name, label, formErrors }) {
return (
<FieldWrapper
name={name}
label={label}
formErrors={formErrors}
labelTooltip="Custom field tooltip"
>
{(props) => (
<div className="custom-input">
<input {...props} />
</div>
)}
</FieldWrapper>
)
}
```

## Contributing

To add new components to the registry:

1. Create the UI component in `src/ui/` following the wrapper pattern
2. Create the controlled component in `src/controlled/`
3. Add both to the main `registry.json` with proper dependencies
4. Generate the individual JSON files
5. Update this documentation

## License

This project is licensed under the same license as the main forms repository.

Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
315 changes: 315 additions & 0 deletions packages/medusa-forms/REGISTRY.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,315 @@
# Medusa Forms shadcn/ui Registry

This package provides a custom shadcn/ui registry for medusa-forms components, allowing developers to install them using the native shadcn CLI while preserving the valuable field wrapper structure with built-in labels and error handling.

## Installation

You can install individual medusa-forms components using the shadcn CLI. The registry automatically handles dependencies, so installing a controlled component will also install the necessary UI wrapper components:

```bash
# Install controlled components (automatically includes UI dependencies)
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-input.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-select.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-checkbox.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-textarea.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-datepicker.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-currency-input.json

# Or install UI components individually if needed
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/input.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/field-wrapper.json
```

## Architecture

### πŸ—οΈ **Preserved Field Wrapper Structure**

The registry maintains the valuable field wrapper architecture that provides superior UX:

- **FieldWrapper**: Handles labels, tooltips, and error display
- **UI Components**: Input, Select, Checkbox, etc. with built-in wrapper integration
- **Controlled Components**: react-hook-form integration with wrapper components

### πŸ“¦ **Dependency Management**

The registry automatically handles the dependency chain:

```
ControlledInput
└── Input
└── FieldWrapper
β”œβ”€β”€ FieldError
└── Label
```

When you install `controlled-input`, shadcn automatically copies:
- `ControlledInput.tsx` (main component)
- `Input.tsx` (UI wrapper)
- `FieldWrapper.tsx` (field wrapper logic)
- `Error.tsx` (error display)
- `Label.tsx` (label with tooltip support)
- `types.d.ts` (TypeScript definitions)

## Available Components

### Controlled Components (with react-hook-form)

#### ControlledInput
```tsx
import { ControlledInput } from '@/components/ui/controlled-input'

<ControlledInput
name="email"
label="Email Address"
placeholder="Enter your email"
labelTooltip="We'll never share your email"
rules={{ required: 'Email is required' }}
/>
```

#### ControlledSelect
```tsx
import { ControlledSelect } from '@/components/ui/controlled-select'

const options = [
{ label: 'Option 1', value: 'option1' },
{ label: 'Option 2', value: 'option2' },
]

<ControlledSelect
name="category"
label="Category"
placeholder="Select a category"
options={options}
rules={{ required: 'Category is required' }}
/>
```

#### ControlledCheckbox
```tsx
import { ControlledCheckbox } from '@/components/ui/controlled-checkbox'

<ControlledCheckbox
name="terms"
label="I agree to the terms and conditions"
description="You must agree to continue"
rules={{ required: 'You must agree to the terms' }}
/>
```

#### ControlledTextarea
```tsx
import { ControlledTextarea } from '@/components/ui/controlled-textarea'

<ControlledTextarea
name="description"
label="Description"
placeholder="Enter a description"
rows={4}
rules={{ required: 'Description is required' }}
/>
```

#### ControlledDatePicker
```tsx
import { ControlledDatePicker } from '@/components/ui/controlled-datepicker'

<ControlledDatePicker
name="birthDate"
label="Birth Date"
placeholder="Select your birth date"
rules={{ required: 'Birth date is required' }}
/>
```

#### ControlledCurrencyInput
```tsx
import { ControlledCurrencyInput } from '@/components/ui/controlled-currency-input'

<ControlledCurrencyInput
name="price"
label="Price"
symbol="$"
code="USD"
rules={{ required: 'Price is required' }}
/>
```

### UI Components (standalone)

#### Input
```tsx
import { Input } from '@/components/ui/input'

<Input
label="Email"
placeholder="Enter email"
labelTooltip="Your email address"
formErrors={errors}
name="email"
/>
```

#### FieldWrapper
```tsx
import { FieldWrapper } from '@/components/ui/field-wrapper'

<FieldWrapper
label="Custom Field"
labelTooltip="Additional information"
formErrors={errors}
name="custom"
>
{(props) => <CustomInput {...props} />}
</FieldWrapper>
```

## Prerequisites

Before using these components, make sure you have:

1. **shadcn/ui initialized** in your project:
```bash
npx shadcn@latest init
```

2. **Required dependencies** installed:
```bash
npm install @medusajs/ui react-hook-form
```

3. **FormProvider setup** for controlled components:
```tsx
import { useForm, FormProvider } from 'react-hook-form'

function MyForm() {
const methods = useForm()

return (
<FormProvider {...methods}>
<form onSubmit={methods.handleSubmit(onSubmit)}>
{/* Your controlled components here */}
</form>
</FormProvider>
)
}
```

## Benefits

βœ… **Preserved Architecture**: Maintains valuable field wrapper structure
βœ… **Built-in Labels & Errors**: Superior UX with integrated label and error handling
βœ… **Automatic Dependencies**: shadcn handles all component dependencies
βœ… **No Custom CLI**: Leverage existing shadcn infrastructure
βœ… **TypeScript Support**: Full TypeScript compatibility
βœ… **Familiar UX**: Developers already know `npx shadcn@latest add`
βœ… **v0 Compatible**: Components work with v0.dev
βœ… **Single Source of Truth**: Components serve both shadcn and npm package usage

## Registry Structure

```
packages/medusa-forms/
β”œβ”€β”€ registry.json # Main registry configuration
β”œβ”€β”€ registry/ # Component registry files
β”‚ β”œβ”€β”€ controlled-*.json # Controlled components
β”‚ β”œβ”€β”€ field-wrapper.json # Core wrapper component
β”‚ β”œβ”€β”€ input.json # UI components
β”‚ └── ...
β”œβ”€β”€ src/controlled/ # Controlled component source files
β”‚ β”œβ”€β”€ ControlledInput.tsx
β”‚ └── ...
└── src/ui/ # UI wrapper components
β”œβ”€β”€ FieldWrapper.tsx # Core field wrapper
β”œβ”€β”€ Input.tsx # Input with wrapper
β”œβ”€β”€ Error.tsx # Error display
β”œβ”€β”€ Label.tsx # Label with tooltip
β”œβ”€β”€ types.d.ts # TypeScript definitions
└── ...
```

## Dependency Chain

The registry manages a complete dependency chain:

```
Controlled Components
β”œβ”€β”€ ControlledInput β†’ Input β†’ FieldWrapper β†’ [FieldError, Label]
β”œβ”€β”€ ControlledSelect β†’ Select β†’ FieldWrapper β†’ [FieldError, Label]
β”œβ”€β”€ ControlledCheckbox β†’ FieldCheckbox β†’ [FieldWrapper, Label] β†’ [FieldError]
β”œβ”€β”€ ControlledTextarea β†’ TextArea β†’ FieldWrapper β†’ [FieldError, Label]
β”œβ”€β”€ ControlledDatePicker β†’ DatePicker β†’ FieldWrapper β†’ [FieldError, Label]
└── ControlledCurrencyInput β†’ CurrencyInput β†’ FieldWrapper β†’ [FieldError, Label]

Core Components
β”œβ”€β”€ FieldWrapper (requires FieldError, Label, types.d.ts)
β”œβ”€β”€ FieldError (standalone)
└── Label (standalone)
```

## Usage Patterns

### 1. **Form with Validation**
```tsx
import { useForm, FormProvider } from 'react-hook-form'
import { ControlledInput, ControlledSelect } from '@/components/ui'

function ContactForm() {
const methods = useForm()

return (
<FormProvider {...methods}>
<form onSubmit={methods.handleSubmit(onSubmit)}>
<ControlledInput
name="name"
label="Full Name"
rules={{ required: 'Name is required' }}
/>
<ControlledSelect
name="country"
label="Country"
options={countries}
rules={{ required: 'Please select a country' }}
/>
</form>
</FormProvider>
)
}
```

### 2. **Custom Field with Wrapper**
```tsx
import { FieldWrapper } from '@/components/ui/field-wrapper'

function CustomField({ name, label, formErrors }) {
return (
<FieldWrapper
name={name}
label={label}
formErrors={formErrors}
labelTooltip="Custom field tooltip"
>
{(props) => (
<div className="custom-input">
<input {...props} />
</div>
)}
</FieldWrapper>
)
}
```

## Contributing

To add new components to the registry:

1. Create the UI component in `src/ui/` following the wrapper pattern
2. Create the controlled component in `src/controlled/`
3. Add both to the main `registry.json` with proper dependencies
4. Generate the individual JSON files
5. Update this documentation

## License

This project is licensed under the same license as the main forms repository.

Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
315 changes: 315 additions & 0 deletions packages/medusa-forms/REGISTRY.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,315 @@
# Medusa Forms shadcn/ui Registry

This package provides a custom shadcn/ui registry for medusa-forms components, allowing developers to install them using the native shadcn CLI while preserving the valuable field wrapper structure with built-in labels and error handling.

## Installation

You can install individual medusa-forms components using the shadcn CLI. The registry automatically handles dependencies, so installing a controlled component will also install the necessary UI wrapper components:

```bash
# Install controlled components (automatically includes UI dependencies)
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-input.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-select.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-checkbox.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-textarea.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-datepicker.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-currency-input.json

# Or install UI components individually if needed
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/input.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/field-wrapper.json
```

## Architecture

### πŸ—οΈ **Preserved Field Wrapper Structure**

The registry maintains the valuable field wrapper architecture that provides superior UX:

- **FieldWrapper**: Handles labels, tooltips, and error display
- **UI Components**: Input, Select, Checkbox, etc. with built-in wrapper integration
- **Controlled Components**: react-hook-form integration with wrapper components

### πŸ“¦ **Dependency Management**

The registry automatically handles the dependency chain:

```
ControlledInput
└── Input
└── FieldWrapper
β”œβ”€β”€ FieldError
└── Label
```

When you install `controlled-input`, shadcn automatically copies:
- `ControlledInput.tsx` (main component)
- `Input.tsx` (UI wrapper)
- `FieldWrapper.tsx` (field wrapper logic)
- `Error.tsx` (error display)
- `Label.tsx` (label with tooltip support)
- `types.d.ts` (TypeScript definitions)

## Available Components

### Controlled Components (with react-hook-form)

#### ControlledInput
```tsx
import { ControlledInput } from '@/components/ui/controlled-input'

<ControlledInput
name="email"
label="Email Address"
placeholder="Enter your email"
labelTooltip="We'll never share your email"
rules={{ required: 'Email is required' }}
/>
```

#### ControlledSelect
```tsx
import { ControlledSelect } from '@/components/ui/controlled-select'

const options = [
{ label: 'Option 1', value: 'option1' },
{ label: 'Option 2', value: 'option2' },
]

<ControlledSelect
name="category"
label="Category"
placeholder="Select a category"
options={options}
rules={{ required: 'Category is required' }}
/>
```

#### ControlledCheckbox
```tsx
import { ControlledCheckbox } from '@/components/ui/controlled-checkbox'

<ControlledCheckbox
name="terms"
label="I agree to the terms and conditions"
description="You must agree to continue"
rules={{ required: 'You must agree to the terms' }}
/>
```

#### ControlledTextarea
```tsx
import { ControlledTextarea } from '@/components/ui/controlled-textarea'

<ControlledTextarea
name="description"
label="Description"
placeholder="Enter a description"
rows={4}
rules={{ required: 'Description is required' }}
/>
```

#### ControlledDatePicker
```tsx
import { ControlledDatePicker } from '@/components/ui/controlled-datepicker'

<ControlledDatePicker
name="birthDate"
label="Birth Date"
placeholder="Select your birth date"
rules={{ required: 'Birth date is required' }}
/>
```

#### ControlledCurrencyInput
```tsx
import { ControlledCurrencyInput } from '@/components/ui/controlled-currency-input'

<ControlledCurrencyInput
name="price"
label="Price"
symbol="$"
code="USD"
rules={{ required: 'Price is required' }}
/>
```

### UI Components (standalone)

#### Input
```tsx
import { Input } from '@/components/ui/input'

<Input
label="Email"
placeholder="Enter email"
labelTooltip="Your email address"
formErrors={errors}
name="email"
/>
```

#### FieldWrapper
```tsx
import { FieldWrapper } from '@/components/ui/field-wrapper'

<FieldWrapper
label="Custom Field"
labelTooltip="Additional information"
formErrors={errors}
name="custom"
>
{(props) => <CustomInput {...props} />}
</FieldWrapper>
```

## Prerequisites

Before using these components, make sure you have:

1. **shadcn/ui initialized** in your project:
```bash
npx shadcn@latest init
```

2. **Required dependencies** installed:
```bash
npm install @medusajs/ui react-hook-form
```

3. **FormProvider setup** for controlled components:
```tsx
import { useForm, FormProvider } from 'react-hook-form'

function MyForm() {
const methods = useForm()

return (
<FormProvider {...methods}>
<form onSubmit={methods.handleSubmit(onSubmit)}>
{/* Your controlled components here */}
</form>
</FormProvider>
)
}
```

## Benefits

βœ… **Preserved Architecture**: Maintains valuable field wrapper structure
βœ… **Built-in Labels & Errors**: Superior UX with integrated label and error handling
βœ… **Automatic Dependencies**: shadcn handles all component dependencies
βœ… **No Custom CLI**: Leverage existing shadcn infrastructure
βœ… **TypeScript Support**: Full TypeScript compatibility
βœ… **Familiar UX**: Developers already know `npx shadcn@latest add`
βœ… **v0 Compatible**: Components work with v0.dev
βœ… **Single Source of Truth**: Components serve both shadcn and npm package usage

## Registry Structure

```
packages/medusa-forms/
β”œβ”€β”€ registry.json # Main registry configuration
β”œβ”€β”€ registry/ # Component registry files
β”‚ β”œβ”€β”€ controlled-*.json # Controlled components
β”‚ β”œβ”€β”€ field-wrapper.json # Core wrapper component
β”‚ β”œβ”€β”€ input.json # UI components
β”‚ └── ...
β”œβ”€β”€ src/controlled/ # Controlled component source files
β”‚ β”œβ”€β”€ ControlledInput.tsx
β”‚ └── ...
└── src/ui/ # UI wrapper components
β”œβ”€β”€ FieldWrapper.tsx # Core field wrapper
β”œβ”€β”€ Input.tsx # Input with wrapper
β”œβ”€β”€ Error.tsx # Error display
β”œβ”€β”€ Label.tsx # Label with tooltip
β”œβ”€β”€ types.d.ts # TypeScript definitions
└── ...
```

## Dependency Chain

The registry manages a complete dependency chain:

```
Controlled Components
β”œβ”€β”€ ControlledInput β†’ Input β†’ FieldWrapper β†’ [FieldError, Label]
β”œβ”€β”€ ControlledSelect β†’ Select β†’ FieldWrapper β†’ [FieldError, Label]
β”œβ”€β”€ ControlledCheckbox β†’ FieldCheckbox β†’ [FieldWrapper, Label] β†’ [FieldError]
β”œβ”€β”€ ControlledTextarea β†’ TextArea β†’ FieldWrapper β†’ [FieldError, Label]
β”œβ”€β”€ ControlledDatePicker β†’ DatePicker β†’ FieldWrapper β†’ [FieldError, Label]
└── ControlledCurrencyInput β†’ CurrencyInput β†’ FieldWrapper β†’ [FieldError, Label]

Core Components
β”œβ”€β”€ FieldWrapper (requires FieldError, Label, types.d.ts)
β”œβ”€β”€ FieldError (standalone)
└── Label (standalone)
```

## Usage Patterns

### 1. **Form with Validation**
```tsx
import { useForm, FormProvider } from 'react-hook-form'
import { ControlledInput, ControlledSelect } from '@/components/ui'

function ContactForm() {
const methods = useForm()

return (
<FormProvider {...methods}>
<form onSubmit={methods.handleSubmit(onSubmit)}>
<ControlledInput
name="name"
label="Full Name"
rules={{ required: 'Name is required' }}
/>
<ControlledSelect
name="country"
label="Country"
options={countries}
rules={{ required: 'Please select a country' }}
/>
</form>
</FormProvider>
)
}
```

### 2. **Custom Field with Wrapper**
```tsx
import { FieldWrapper } from '@/components/ui/field-wrapper'

function CustomField({ name, label, formErrors }) {
return (
<FieldWrapper
name={name}
label={label}
formErrors={formErrors}
labelTooltip="Custom field tooltip"
>
{(props) => (
<div className="custom-input">
<input {...props} />
</div>
)}
</FieldWrapper>
)
}
```

## Contributing

To add new components to the registry:

1. Create the UI component in `src/ui/` following the wrapper pattern
2. Create the controlled component in `src/controlled/`
3. Add both to the main `registry.json` with proper dependencies
4. Generate the individual JSON files
5. Update this documentation

## License

This project is licensed under the same license as the main forms repository.

Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
315 changes: 315 additions & 0 deletions packages/medusa-forms/REGISTRY.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,315 @@
# Medusa Forms shadcn/ui Registry

This package provides a custom shadcn/ui registry for medusa-forms components, allowing developers to install them using the native shadcn CLI while preserving the valuable field wrapper structure with built-in labels and error handling.

## Installation

You can install individual medusa-forms components using the shadcn CLI. The registry automatically handles dependencies, so installing a controlled component will also install the necessary UI wrapper components:

```bash
# Install controlled components (automatically includes UI dependencies)
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-input.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-select.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-checkbox.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-textarea.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-datepicker.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-currency-input.json

# Or install UI components individually if needed
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/input.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/field-wrapper.json
```

## Architecture

### πŸ—οΈ **Preserved Field Wrapper Structure**

The registry maintains the valuable field wrapper architecture that provides superior UX:

- **FieldWrapper**: Handles labels, tooltips, and error display
- **UI Components**: Input, Select, Checkbox, etc. with built-in wrapper integration
- **Controlled Components**: react-hook-form integration with wrapper components

### πŸ“¦ **Dependency Management**

The registry automatically handles the dependency chain:

```
ControlledInput
└── Input
└── FieldWrapper
β”œβ”€β”€ FieldError
└── Label
```

When you install `controlled-input`, shadcn automatically copies:
- `ControlledInput.tsx` (main component)
- `Input.tsx` (UI wrapper)
- `FieldWrapper.tsx` (field wrapper logic)
- `Error.tsx` (error display)
- `Label.tsx` (label with tooltip support)
- `types.d.ts` (TypeScript definitions)

## Available Components

### Controlled Components (with react-hook-form)

#### ControlledInput
```tsx
import { ControlledInput } from '@/components/ui/controlled-input'

<ControlledInput
name="email"
label="Email Address"
placeholder="Enter your email"
labelTooltip="We'll never share your email"
rules={{ required: 'Email is required' }}
/>
```

#### ControlledSelect
```tsx
import { ControlledSelect } from '@/components/ui/controlled-select'

const options = [
{ label: 'Option 1', value: 'option1' },
{ label: 'Option 2', value: 'option2' },
]

<ControlledSelect
name="category"
label="Category"
placeholder="Select a category"
options={options}
rules={{ required: 'Category is required' }}
/>
```

#### ControlledCheckbox
```tsx
import { ControlledCheckbox } from '@/components/ui/controlled-checkbox'

<ControlledCheckbox
name="terms"
label="I agree to the terms and conditions"
description="You must agree to continue"
rules={{ required: 'You must agree to the terms' }}
/>
```

#### ControlledTextarea
```tsx
import { ControlledTextarea } from '@/components/ui/controlled-textarea'

<ControlledTextarea
name="description"
label="Description"
placeholder="Enter a description"
rows={4}
rules={{ required: 'Description is required' }}
/>
```

#### ControlledDatePicker
```tsx
import { ControlledDatePicker } from '@/components/ui/controlled-datepicker'

<ControlledDatePicker
name="birthDate"
label="Birth Date"
placeholder="Select your birth date"
rules={{ required: 'Birth date is required' }}
/>
```

#### ControlledCurrencyInput
```tsx
import { ControlledCurrencyInput } from '@/components/ui/controlled-currency-input'

<ControlledCurrencyInput
name="price"
label="Price"
symbol="$"
code="USD"
rules={{ required: 'Price is required' }}
/>
```

### UI Components (standalone)

#### Input
```tsx
import { Input } from '@/components/ui/input'

<Input
label="Email"
placeholder="Enter email"
labelTooltip="Your email address"
formErrors={errors}
name="email"
/>
```

#### FieldWrapper
```tsx
import { FieldWrapper } from '@/components/ui/field-wrapper'

<FieldWrapper
label="Custom Field"
labelTooltip="Additional information"
formErrors={errors}
name="custom"
>
{(props) => <CustomInput {...props} />}
</FieldWrapper>
```

## Prerequisites

Before using these components, make sure you have:

1. **shadcn/ui initialized** in your project:
```bash
npx shadcn@latest init
```

2. **Required dependencies** installed:
```bash
npm install @medusajs/ui react-hook-form
```

3. **FormProvider setup** for controlled components:
```tsx
import { useForm, FormProvider } from 'react-hook-form'

function MyForm() {
const methods = useForm()

return (
<FormProvider {...methods}>
<form onSubmit={methods.handleSubmit(onSubmit)}>
{/* Your controlled components here */}
</form>
</FormProvider>
)
}
```

## Benefits

βœ… **Preserved Architecture**: Maintains valuable field wrapper structure
βœ… **Built-in Labels & Errors**: Superior UX with integrated label and error handling
βœ… **Automatic Dependencies**: shadcn handles all component dependencies
βœ… **No Custom CLI**: Leverage existing shadcn infrastructure
βœ… **TypeScript Support**: Full TypeScript compatibility
βœ… **Familiar UX**: Developers already know `npx shadcn@latest add`
βœ… **v0 Compatible**: Components work with v0.dev
βœ… **Single Source of Truth**: Components serve both shadcn and npm package usage

## Registry Structure

```
packages/medusa-forms/
β”œβ”€β”€ registry.json # Main registry configuration
β”œβ”€β”€ registry/ # Component registry files
β”‚ β”œβ”€β”€ controlled-*.json # Controlled components
β”‚ β”œβ”€β”€ field-wrapper.json # Core wrapper component
β”‚ β”œβ”€β”€ input.json # UI components
β”‚ └── ...
β”œβ”€β”€ src/controlled/ # Controlled component source files
β”‚ β”œβ”€β”€ ControlledInput.tsx
β”‚ └── ...
└── src/ui/ # UI wrapper components
β”œβ”€β”€ FieldWrapper.tsx # Core field wrapper
β”œβ”€β”€ Input.tsx # Input with wrapper
β”œβ”€β”€ Error.tsx # Error display
β”œβ”€β”€ Label.tsx # Label with tooltip
β”œβ”€β”€ types.d.ts # TypeScript definitions
└── ...
```

## Dependency Chain

The registry manages a complete dependency chain:

```
Controlled Components
β”œβ”€β”€ ControlledInput β†’ Input β†’ FieldWrapper β†’ [FieldError, Label]
β”œβ”€β”€ ControlledSelect β†’ Select β†’ FieldWrapper β†’ [FieldError, Label]
β”œβ”€β”€ ControlledCheckbox β†’ FieldCheckbox β†’ [FieldWrapper, Label] β†’ [FieldError]
β”œβ”€β”€ ControlledTextarea β†’ TextArea β†’ FieldWrapper β†’ [FieldError, Label]
β”œβ”€β”€ ControlledDatePicker β†’ DatePicker β†’ FieldWrapper β†’ [FieldError, Label]
└── ControlledCurrencyInput β†’ CurrencyInput β†’ FieldWrapper β†’ [FieldError, Label]

Core Components
β”œβ”€β”€ FieldWrapper (requires FieldError, Label, types.d.ts)
β”œβ”€β”€ FieldError (standalone)
└── Label (standalone)
```

## Usage Patterns

### 1. **Form with Validation**
```tsx
import { useForm, FormProvider } from 'react-hook-form'
import { ControlledInput, ControlledSelect } from '@/components/ui'

function ContactForm() {
const methods = useForm()

return (
<FormProvider {...methods}>
<form onSubmit={methods.handleSubmit(onSubmit)}>
<ControlledInput
name="name"
label="Full Name"
rules={{ required: 'Name is required' }}
/>
<ControlledSelect
name="country"
label="Country"
options={countries}
rules={{ required: 'Please select a country' }}
/>
</form>
</FormProvider>
)
}
```

### 2. **Custom Field with Wrapper**
```tsx
import { FieldWrapper } from '@/components/ui/field-wrapper'

function CustomField({ name, label, formErrors }) {
return (
<FieldWrapper
name={name}
label={label}
formErrors={formErrors}
labelTooltip="Custom field tooltip"
>
{(props) => (
<div className="custom-input">
<input {...props} />
</div>
)}
</FieldWrapper>
)
}
```

## Contributing

To add new components to the registry:

1. Create the UI component in `src/ui/` following the wrapper pattern
2. Create the controlled component in `src/controlled/`
3. Add both to the main `registry.json` with proper dependencies
4. Generate the individual JSON files
5. Update this documentation

## License

This project is licensed under the same license as the main forms repository.

Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
315 changes: 315 additions & 0 deletions packages/medusa-forms/REGISTRY.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,315 @@
# Medusa Forms shadcn/ui Registry

This package provides a custom shadcn/ui registry for medusa-forms components, allowing developers to install them using the native shadcn CLI while preserving the valuable field wrapper structure with built-in labels and error handling.

## Installation

You can install individual medusa-forms components using the shadcn CLI. The registry automatically handles dependencies, so installing a controlled component will also install the necessary UI wrapper components:

```bash
# Install controlled components (automatically includes UI dependencies)
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-input.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-select.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-checkbox.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-textarea.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-datepicker.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/controlled-currency-input.json

# Or install UI components individually if needed
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/input.json
npx shadcn@latest add https://raw.githubusercontent.com/lambda-curry/forms/main/packages/medusa-forms/registry/field-wrapper.json
```

## Architecture

### πŸ—οΈ **Preserved Field Wrapper Structure**

The registry maintains the valuable field wrapper architecture that provides superior UX:

- **FieldWrapper**: Handles labels, tooltips, and error display
- **UI Components**: Input, Select, Checkbox, etc. with built-in wrapper integration
- **Controlled Components**: react-hook-form integration with wrapper components

### πŸ“¦ **Dependency Management**

The registry automatically handles the dependency chain:

```
ControlledInput
└── Input
└── FieldWrapper
β”œβ”€β”€ FieldError
└── Label
```

When you install `controlled-input`, shadcn automatically copies:
- `ControlledInput.tsx` (main component)
- `Input.tsx` (UI wrapper)
- `FieldWrapper.tsx` (field wrapper logic)
- `Error.tsx` (error display)
- `Label.tsx` (label with tooltip support)
- `types.d.ts` (TypeScript definitions)

## Available Components

### Controlled Components (with react-hook-form)

#### ControlledInput
```tsx
import { ControlledInput } from '@/components/ui/controlled-input'

<ControlledInput
name="email"
label="Email Address"
placeholder="Enter your email"
labelTooltip="We'll never share your email"
rules={{ required: 'Email is required' }}
/>
```

#### ControlledSelect
```tsx
import { ControlledSelect } from '@/components/ui/controlled-select'

const options = [
{ label: 'Option 1', value: 'option1' },
{ label: 'Option 2', value: 'option2' },
]

<ControlledSelect
name="category"
label="Category"
placeholder="Select a category"
options={options}
rules={{ required: 'Category is required' }}
/>
```

#### ControlledCheckbox
```tsx
import { ControlledCheckbox } from '@/components/ui/controlled-checkbox'

<ControlledCheckbox
name="terms"
label="I agree to the terms and conditions"
description="You must agree to continue"
rules={{ required: 'You must agree to the terms' }}
/>
```

#### ControlledTextarea
```tsx
import { ControlledTextarea } from '@/components/ui/controlled-textarea'

<ControlledTextarea
name="description"
label="Description"
placeholder="Enter a description"
rows={4}
rules={{ required: 'Description is required' }}
/>
```

#### ControlledDatePicker
```tsx
import { ControlledDatePicker } from '@/components/ui/controlled-datepicker'

<ControlledDatePicker
name="birthDate"
label="Birth Date"
placeholder="Select your birth date"
rules={{ required: 'Birth date is required' }}
/>
```

#### ControlledCurrencyInput
```tsx
import { ControlledCurrencyInput } from '@/components/ui/controlled-currency-input'

<ControlledCurrencyInput
name="price"
label="Price"
symbol="$"
code="USD"
rules={{ required: 'Price is required' }}
/>
```

### UI Components (standalone)

#### Input
```tsx
import { Input } from '@/components/ui/input'

<Input
label="Email"
placeholder="Enter email"
labelTooltip="Your email address"
formErrors={errors}
name="email"
/>
```

#### FieldWrapper
```tsx
import { FieldWrapper } from '@/components/ui/field-wrapper'

<FieldWrapper
label="Custom Field"
labelTooltip="Additional information"
formErrors={errors}
name="custom"
>
{(props) => <CustomInput {...props} />}
</FieldWrapper>
```

## Prerequisites

Before using these components, make sure you have:

1. **shadcn/ui initialized** in your project:
```bash
npx shadcn@latest init
```

2. **Required dependencies** installed:
```bash
npm install @medusajs/ui react-hook-form
```

3. **FormProvider setup** for controlled components:
```tsx
import { useForm, FormProvider } from 'react-hook-form'

function MyForm() {
const methods = useForm()

return (
<FormProvider {...methods}>
<form onSubmit={methods.handleSubmit(onSubmit)}>
{/* Your controlled components here */}
</form>
</FormProvider>
)
}
```

## Benefits

βœ… **Preserved Architecture**: Maintains valuable field wrapper structure
βœ… **Built-in Labels & Errors**: Superior UX with integrated label and error handling
βœ… **Automatic Dependencies**: shadcn handles all component dependencies
βœ… **No Custom CLI**: Leverage existing shadcn infrastructure
βœ… **TypeScript Support**: Full TypeScript compatibility
βœ… **Familiar UX**: Developers already know `npx shadcn@latest add`
βœ… **v0 Compatible**: Components work with v0.dev
βœ… **Single Source of Truth**: Components serve both shadcn and npm package usage

## Registry Structure

```
packages/medusa-forms/
β”œβ”€β”€ registry.json # Main registry configuration
β”œβ”€β”€ registry/ # Component registry files
β”‚ β”œβ”€β”€ controlled-*.json # Controlled components
β”‚ β”œβ”€β”€ field-wrapper.json # Core wrapper component
β”‚ β”œβ”€β”€ input.json # UI components
β”‚ └── ...
β”œβ”€β”€ src/controlled/ # Controlled component source files
β”‚ β”œβ”€β”€ ControlledInput.tsx
β”‚ └── ...
└── src/ui/ # UI wrapper components
β”œβ”€β”€ FieldWrapper.tsx # Core field wrapper
β”œβ”€β”€ Input.tsx # Input with wrapper
β”œβ”€β”€ Error.tsx # Error display
β”œβ”€β”€ Label.tsx # Label with tooltip
β”œβ”€β”€ types.d.ts # TypeScript definitions
└── ...
```

## Dependency Chain

The registry manages a complete dependency chain:

```
Controlled Components
β”œβ”€β”€ ControlledInput β†’ Input β†’ FieldWrapper β†’ [FieldError, Label]
β”œβ”€β”€ ControlledSelect β†’ Select β†’ FieldWrapper β†’ [FieldError, Label]
β”œβ”€β”€ ControlledCheckbox β†’ FieldCheckbox β†’ [FieldWrapper, Label] β†’ [FieldError]
β”œβ”€β”€ ControlledTextarea β†’ TextArea β†’ FieldWrapper β†’ [FieldError, Label]
β”œβ”€β”€ ControlledDatePicker β†’ DatePicker β†’ FieldWrapper β†’ [FieldError, Label]
└── ControlledCurrencyInput β†’ CurrencyInput β†’ FieldWrapper β†’ [FieldError, Label]

Core Components
β”œβ”€β”€ FieldWrapper (requires FieldError, Label, types.d.ts)
β”œβ”€β”€ FieldError (standalone)
└── Label (standalone)
```

## Usage Patterns

### 1. **Form with Validation**
```tsx
import { useForm, FormProvider } from 'react-hook-form'
import { ControlledInput, ControlledSelect } from '@/components/ui'

function ContactForm() {
const methods = useForm()

return (
<FormProvider {...methods}>
<form onSubmit={methods.handleSubmit(onSubmit)}>
<ControlledInput
name="name"
label="Full Name"
rules={{ required: 'Name is required' }}
/>
<ControlledSelect
name="country"
label="Country"
options={countries}
rules={{ required: 'Please select a country' }}
/>
</form>
</FormProvider>
)
}
```

### 2. **Custom Field with Wrapper**
```tsx
import { FieldWrapper } from '@/components/ui/field-wrapper'

function CustomField({ name, label, formErrors }) {
return (
<FieldWrapper
name={name}
label={label}
formErrors={formErrors}
labelTooltip="Custom field tooltip"
>
{(props) => (
<div className="custom-input">
<input {...props} />
</div>
)}
</FieldWrapper>
)
}
```

## Contributing

To add new components to the registry:

1. Create the UI component in `src/ui/` following the wrapper pattern
2. Create the controlled component in `src/controlled/`
3. Add both to the main `registry.json` with proper dependencies
4. Generate the individual JSON files
5. Update this documentation

## License

This project is licensed under the same license as the main forms repository.

Loading