Skip to content

Latest commit

 

History

History
76 lines (52 loc) · 4.96 KB

File metadata and controls

76 lines (52 loc) · 4.96 KB

PrimeUI Pro Examples

Framework-specific quickstarts for PrimeUI Pro.

Each quickstart is a standalone application with one focused component example and a minimal topbar and footer. It shows package installation, license setup, styles, UI parts, and the component integration without turning the starter into a full application template.

Available Quickstarts

Component Vue React Angular
Scheduler Vite, Nuxt, Vite + Tailwind, Nuxt + Tailwind Vite, Vite + Tailwind Quickstart, Tailwind
TextEditor Vite, Nuxt, Vite + Tailwind, Nuxt + Tailwind Vite, Vite + Tailwind Quickstart, Tailwind
TaskBoard Vite, Nuxt, Vite + Tailwind, Nuxt + Tailwind Vite, Vite + Tailwind Quickstart, Tailwind
Charts Vite, Nuxt Vite Quickstart

A folder is listed as available only when it contains a runnable application and its own README.

Documentation

Repository Structure

Examples are grouped by component, framework, and quickstart application:

{component}/{framework}/{quickstart}

The planned Vue quickstart matrix is:

vite-quickstart
nuxt-quickstart
vite-tailwind-quickstart
nuxt-tailwind-quickstart

The Angular quickstart matrix is:

quickstart
tailwind-quickstart

The React quickstart matrix is:

vite-quickstart
vite-tailwind-quickstart

Angular ships a single official build tool, so its folders are named after the UI baseline rather than the bundler.

The default quickstarts use PrimeOne UI parts with the framework's Prime UI library, such as PrimeVue or PrimeNG. The Tailwind quickstarts use the component's editable Tailwind UI parts without requiring PrimeVue, PrimeReact, or PrimeNG.

Working With an Example

Every runnable quickstart has its own dependencies, lockfile, and setup instructions. Run package manager commands from that quickstart's directory rather than from the repository root.

The Vue quickstarts read the PrimeUI Pro license key from a .env file. Angular has no .env support, so the Angular quickstarts read it from src/environments/environment.ts instead. Each app README shows the exact step.

The example page, fixture data, and lightweight shell are starter code. Each app README identifies what is required for the PrimeUI Pro integration and what can be replaced or removed.

License

This public repository contains example application source. Running an example that imports PrimeUI Pro packages requires your own valid PrimeUI Pro license key and is subject to the PrimeUI License. Follow the environment setup in the selected quickstart README.