Archivo de origen del README: README.md
Leer el README original<p align="center"><img src=".github/assets/shuip-mark.svg" width="96" alt="shuip"></p>
# shuip
[**shuip**](https://shuip.plvo.dev) _(ship + ui)_ is an open-source React component library designed to **accelerate the development** of your Next.js applications. Built on top of [shadcn/ui](https://ui.shadcn.com), shuip provides ready-to-use, business-focused components that help you **ship** faster.
For more details, see the full documentation: https://shuip.plvo.dev/docs
## Quick Start
Declare the shuip namespace once in your `components.json`:
```json
{
"registries": {
"@shuip": "https://shuip.plvo.dev/r/{style}/{name}.json"
}
}
```
Then use the shadcn/ui CLI to add shuip components to your project:
```bash
npx shadcn@latest add @shuip/submit-button
```
The command is the same for both bases: the `style` in your `components.json` picks the variant.
| `style` | Variant |
| ------- | ------- |
| `base-*` | Base UI |
| `radix-*`, `new-york`, `new-york-v4`, `default` | Radix |
| `aria-*` | Not supported (React Aria) |
Triggers compose with `render` in `base-*` projects and with `asChild` in Radix projects.
More information in the [documentation](https://shuip.plvo.dev/docs/installation#picking-the-base).
## Usage Example
Here's how shuip simplifies form development:
### Before
```tsx
<FormField
control={form.control}
name="email"
render={({ field }) => (
<FormItem>
<FormLabel>Email</FormLabel>
<FormControl>
<Input placeholder="your@email.com" {...field} />
</FormControl>
<FormDescription>Your email address</FormDescription>
<FormMessage />
</FormItem>
)}
/>
```
### After with shuip
```tsx
<InputField register={form.register('email')} label="Email" description="Your email address" placeholder="your@email.com" />
```
## 🤝 Contributing
Want to contribute? Check out the [Contribution guide](https://shuip.plvo.dev/docs/contribution).
## 📄 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Leer el README original