@corex-ui/vite
v1.0.1
Published
Vite plugin for rendering Corex UI static components post-build.
Maintainers
Readme
@corex-ui/vite
Vite plugin for rendering Corex UI static components post-build. Ensures your Corex UI components are hydrated and rendered into static HTML after Vite builds your project.
For the complete Corex UI ecosystem, documentation, and advanced guides, visit Corex UI Official Docs.
✨ Features
- 🔌 Vite integration (
buildhook) - 🏗️ Renders Corex UI components in generated HTML
- 🎯 Selective rendering: choose which components to render
- ⚡ Works seamlessly with @corex-ui/static
📦 Installation
npm install @corex-ui/vite
# or
pnpm add @corex-ui/vite🚀 Usage
Minimal usage
import { defineConfig } from "vite";
import corex from "@corex-ui/vite";
export default defineConfig({
plugins: [corex()],
});Usage with options
import { defineConfig } from "vite";
import corex from "@corex-ui/vite";
export default defineConfig({
plugins: [
corex({
components: ["accordion", "tabs"],
uiDist: "./node_modules/@corex-ui/static/dist",
buildDir: "dist",
}),
],
});components: Array of component names to render (default: all)uiDist: Path to the Corex UIdistfolder (default: auto-detected)buildDir: Path to your Vite build output folder (default:dist)
⚙️ Options Table
| Option | Type | Default | Description |
| ------------ | ---------- | ---------------------------------------------------- | ------------------------------------------------------------------------------------- |
| components | string[] | undefined (all components) | Restrict rendering to a specific set of components. Example: ['accordion', 'tabs']. |
| uiDist | string | Auto-detected (node_modules/@corex-ui/static/dist) | Override the Corex UI distribution directory if located elsewhere. |
| buildDir | string | dist | Vite output folder where HTML files are rendered. |
🛠️ Example
# Render only accordion + tabs after Vite build
vite buildOutput logs:
[Corex] Rendering components
[Corex] Components: 5 found
[Corex] HTML files: 12 found
[Corex] dist/index.html → 2 rendered
[Corex] dist/docs/components.html → 1 rendered
[Corex] Rendering complete📚 How It Works
- Runs after Vite finishes building (
closeBundlehook) - Scans the output folder (
dist/) for HTML files - Loads Corex UI component modules from
@corex-ui/static/dist/components - Detects matching component placeholders in HTML
- Calls each component's
init<ComponentName>function inside a JSDOM instance - Writes the modified HTML back to disk
