Skip to content

octacn/ui-v2

Repository files navigation

ShadwUI

Beautiful UI components built with Tailwind CSS and React.

ShadwUI is an extensive collection of copy-and-paste components for quickly building app UIs. It includes hundreds of components and is constantly updated with new designs.

Livehttps://shadwui.com

Banner

ShadwUI

ShadwUI

Getting Started

shadw UI is designed to integrate seamlessly with Next.js, react and vite projects, but the components are also compatible with any React-based project. The components follow shadcn conventions, so they'll feel familiar to anyone who has used shadcn before.

1. Set up the required files:

After completing these steps, you can copy and use the components in your project. Note that some components (e.g., number inputs, date pickers, time pickers, phone number inputs) may require additional libraries.

Tailwind v4 support

Our UI library has been updated to Tailwind CSS v4 as of February 25, 2025. Legacy components built with v3 remain available by adding /legacy/ to the component URL:

# v3 component
pnpm dlx shadcn@latest add https://shadwui.com/r/input.json

Note: New components will only be developed for Tailwind v4.

Contributing

We welcome contributions to our Shadwui! Please follow these steps to contribute:

  1. Fork the repository on GitHub.

  2. Clone your forked repository to your local machine:

    git clone https://github.com/your-username/shadwui.git
    
  3. Navigate to the project directory:

    cd shadwui
    
  4. Create a new branch for your feature or bug fix:

    git checkout -b your-branch-name
    
  5. Install the project dependencies:

    pnpm install
    
  6. Make your changes to the codebase.

  7. Before building, format your code:

  8. Build the project:

    pnpm run build
    
  9. Test the application to ensure your changes work as expected.

  10. Commit your changes:

    git commit -m "Your descriptive commit message"
    
  11. Push your changes to your fork:

    git push origin your-branch-name
    
  12. Open a pull request on the original repository.

Thank you for contributing to our project!

License

Licensed under the MIT License.

If you have any questions or just want to say hi, feel free to reach out to us on Linkedin 👉 @sahilkumardev

About

This is shadwui official documentation based on their use case

Topics

Resources

License

Stars

Watchers

Forks

Languages