Skip to content

README.md

Latest commit

 

History

History
50 lines (36 loc) · 1.41 KB

README.md

File metadata and controls

50 lines (36 loc) · 1.41 KB

shuip

shuip (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, 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

Use the shadcn/ui CLI to add shuip components to your project:

npx shadcn@latest add "https://shuip.plvo.dev/r/submit-button"

More informations on the documentation

Usage Example

Here's how shuip simplifies form development:

Before

<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

<InputField register={form.register('email')} label="Email" description="Your email address" placeholder="your@email.com" />

🤝 Contributing

Want to contribute? Check out the Contribution guide.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.