pgo-uiux
v1.0.13
Published
PGO UI/UX components and theming for Vue 3
Readme
pgo-uiux
Reusable Vue 3 components and theming for PGO apps. Ships a plugin that:
- Registers all components under
src/components/pgo/**globally (exceptTimeline.vue). - Installs an SSR-safe theme plugin (CSS variables, prefix
--vts-). - Auto-injects a default AppBar + NavDrawer and a dv/en language toggle (persists to
localStorage). - Auto-loads baseline CSS (
tokens.css) and Faruma font.
Install
npm install pgo-uiuxQuick start
// main.ts
import { createApp } from 'vue'
import App from './App.vue'
import PgoUIUX from 'pgo-uiux'
createApp(App)
.use(PgoUIUX, {
theme: { enable: true },
layout: { enable: true }, // Auto AppBar + NavDrawer
lang: { enable: true, default: 'en' },
autoRegister: { exclude: ['Timeline.vue'] } // default
})
.mount('#app')Per-component import (tree-shakeable):
import { Timeline } from 'pgo-uiux'Theming
- CSS variables with prefix
--vts-are applied todocument.documentElement. - Variants:
light,dark,system. - Subpath exports:
import { createThemePlugin } from 'pgo-uiux/plugin'andimport { themes } from 'pgo-uiux/themes'.
Language (dv/en)
- Minimal internal store toggles
langand setsdir(en→ltr,dv→rtl). - Persists to
localStorageunderpgo:lang.
Tailwind v4+
- Tokens are standard CSS variables; use
var(--vts-color-primary)etc. No Tailwind plugin required.
Fonts
- Includes Faruma.ttf via
@font-face. Confirmed license permits redistribution.
Build locally
npm run buildNotes
- Only
dist/is published. Example/demo files are not included in the package.
