Installation
Learn how to install ChamevoJS in your project.
Package Options
| Package | Use Case |
|---|---|
@chamevo/customizer | Quick start - includes everything |
@chamevo/core | Headless mode - build your own UI |
@chamevo/components | Add pre-built UI to existing core setup |
Using npm/pnpm/yarn
Full Package (Recommended)
# npm
npm install @chamevo/customizer
# pnpm
pnpm add @chamevo/customizer
# yarn
yarn add @chamevo/customizer
Core Only (Headless)
For building your own UI on top of the canvas layer:
npm install @chamevo/core
Separate Packages
npm install @chamevo/core @chamevo/components
CDN
For quick prototyping, use the CDN:
<!-- Full bundle -->
<script src="https://cdn.jsdelivr.net/npm/@chamevo/customizer/dist/chamevo.min.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@chamevo/customizer/dist/chamevo.min.css" />
<!-- Core only -->
<script src="https://cdn.jsdelivr.net/npm/@chamevo/core/dist/chamevo-core.min.js"></script>
TypeScript Support
All packages include TypeScript definitions. For the best experience, also install the types package:
npm install @chamevo/types --save-dev
Peer Dependencies
The core package requires FabricJS v7:
npm install fabric@^7.0.0
note
@chamevo/customizer and @chamevo/components include FabricJS as a bundled dependency.
Next Steps
- Quick Start - Create your first product customizer
- Configuration - Customize ChamevoJS options