Poupe UI is a modern, themeable UI framework built with TypeScript that provides a complete solution for building beautiful, accessible, and customizable user interfaces.
- 🎨 Advanced Theming - Dynamic theming system with Material Design color utilities
- 🔌 Framework Agnostic - Core functionality works with any framework
- ⚡ Vue Integration - First-class support for Vue 3 with component library
- 🧩 Nuxt Module - Seamless integration with Nuxt applications
- 🌈 TailwindCSS Plugin - Native TailwindCSS v4 support
- 📦 Modular Architecture - Use only what you need
Package | Version | Description |
---|---|---|
@poupe/css | CSS-in-JS utilities | |
@poupe/theme-builder | Design token management and theme generation system | |
@poupe/tailwindcss | TailwindCSS v4 plugin with theme customization support | |
@poupe/vue | Vue component library with theme customization and accessibility support | |
@poupe/nuxt | Nuxt module for integrating Poupe UI framework |
- Node.js >=20.19.1
- pnpm >=10.10.0
# Install the Vue component library
npm install @poupe/vue @poupe/theme-builder tailwindcss
# Install the Nuxt module
npm install @poupe/nuxt
Add to your nuxt.config.ts
:
export default defineNuxtConfig({
modules: ['@poupe/nuxt'],
})
# Install the TailwindCSS plugin
npm install @poupe/tailwindcss @poupe/theme-builder
Add to your tailwind.config.js
:
import { poupePlugin } from '@poupe/tailwindcss'
export default {
// ...
plugins: [
poupePlugin({
// your theme configuration
}),
],
}
import { createTheme } from '@poupe/theme-builder'
const theme = createTheme({
// Define your theme
colors: {
primary: '#1976d2',
secondary: '#9c27b0',
// Add more colors as needed
},
})
import { createApp } from 'vue'
import { createPoupe } from '@poupe/vue'
import App from './App.vue'
const app = createApp(App)
app.use(createPoupe({
theme: {
colors: {
primary: '#1976d2',
secondary: '#9c27b0',
},
},
}))
app.mount('#app')
This is a monorepo managed with pnpm.
# Install dependencies
pnpm install
# Build all packages
pnpm -r build
# Run tests
pnpm -r test
- Fork the repository
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request
This project is licensed under the MIT License - see the LICENCE file for details.