Resources & Help

Find documentation, answers to common questions, and solutions to common issues when working with Cloak UI.

📚 Resources

Here are the best places to learn more, stay updated, and get help:

Official Docs — You’re here! Bookmark this page for future reference.
shadcn/ui Documentation — https://ui.shadcn.com
Hero UI Documentation — https://heroui.com
GitHub Repository — (Coming Soon)
Community Chat — (Coming Soon: Discord/Slack)
Changelog & Releases — (Coming Soon)

❓ FAQ

1. Do I need to install Cloak UI as a package?

No. You create a wrapper folder in your project and write components that import from your chosen UI library. Cloak UI is a pattern, not a dependency.

2. Can I mix two design systems in one project?

Technically yes, but not recommended. Pick one underlying system for consistency, otherwise you’ll have conflicting styles and prop mappings.

3. How do I switch to another design system?

Install the new UI library.
Update imports inside your wrapper files.
All your JSX stays the same.

4. Does Cloak UI support TypeScript?

Yes — you can type your wrappers with a unified prop interface so IDEs give proper suggestions no matter which design system is under the hood.

5. What if my design system has a component Cloak UI doesn’t support yet?

You can extend the wrapper pattern and create your own adapter without breaking the existing API.

Cause: The new design system may require global CSS or theme setup.
Fix: Check the official installation guide of the design system and ensure required imports are added (e.g., Tailwind CSS for shadcn/ui).

Problem: Props aren’t working as expected

Cause: Mismatch between Cloak UI prop names and the design system’s props.
Fix: Update your wrapper mapping to match the target library’s API.

Problem: Type errors in TypeScript

Cause: Incorrect prop type definitions in your wrapper.
Fix: Ensure your wrapper’s interface matches the Cloak UI API and maps correctly to the library’s types.

Problem: Component not rendering

Cause: Underlying library not installed or imported incorrectly.
Fix: Verify you’ve installed the correct design system and that your wrapper imports the right component path.

💡 Tip: Always start troubleshooting by checking your wrapper files — 90% of issues come from incorrect mappings or missing imports.