ux4g-ui
v0.0.4
Published
A CLI tool to install UX4G UI components into your project with a clean, shadcn-style copy-and-own workflow.
Downloads
8
Maintainers
Readme
📦 ux4g-ui
A simple command-line tool to install UX4G React components into your project — similar to shadcn/ui.
Each component is copied directly into your codebase so you fully own and customize it.
📚 View Documentation & Available Components
🚀 Installation
Use npx to run the CLI:
npx ux4g-ui add <component>Example
npx ux4g-ui add accordion🧩 How It Works
- Fetches component source files from the ux4g-react registry
- Copies them into your project's folder (default:
src/components/<component>) - Lets you choose a custom installation path
- You own the component source — edit freely
✨ Features
- 📦 Install components on demand
- 📁 Custom installation directory
- 🎨 Beautiful CLI output
- 🛠 No build step needed
- 🧠 TypeScript-ready components
- 🔗 Always fetches latest component definitions from GitHub
📥 Usage
Add a Component
npx ux4g-ui add accordionChoose Installation Path
The CLI will prompt you:
Where should the component be installed?
(default: src/components/accordion)You can enter any folder, for example:
src/ui/accordion
src/lib/accordion
components/ui/accordionThe CLI will create the needed folders automatically.
