Installation

Prerequisites

  • Node.js 18+
  • npm, yarn, or pnpm

Core Package

The core package is required for all usage:

npm install @cyte-editor/core

Quick Start (Bundle)

For Vue 3 projects that want all features in a single package:

npm install cyte-editor

The cyte-editor bundle includes the core engine, Vue 3 adapter, license SDK, and all Pro plugins. For other frameworks or fine-grained control, use the modular packages below.

Framework Adapter

Install the adapter that matches your framework:

# Vue 3 (requires Vue ^3.3.0)
npm install @cyte-editor/vue3

# Vue 2 (requires Vue ^2.7.0)
npm install @cyte-editor/vue2

# React (requires React ^18 || ^19)
npm install @cyte-editor/react

# Angular (requires Angular ^17 || ^18 || ^19)
npm install @cyte-editor/angular

# Svelte (requires Svelte ^4 || ^5)
npm install @cyte-editor/svelte

# Vanilla JS (no framework, supports IIFE/UMD)
npm install @cyte-editor/vanilla

CSS

Import both the core stylesheet and your adapter's stylesheet in your entry file:

import '@cyte-editor/core/style.css'
import '@cyte-editor/vue3/style.css'  // replace with your adapter package

Each framework adapter ships its own stylesheet that must be imported manually alongside the core stylesheet.

Pro Plugins (Optional)

npm install @cyte-editor/pro-export
npm install @cyte-editor/pro-paste
npm install @cyte-editor/pro-revision
  • pro-export — import/export for Markdown, Word (.docx) & HTML
  • pro-paste — intelligent clipboard handling for Word, Excel, WPS & HTML
  • pro-revision — version snapshots, rich-text diff & scroll-sync compare

Pro plugins require the @cyte-editor/license package and a valid license key:

npm install @cyte-editor/license

See Pricing for license details.

TypeScript Support

CyteEditor is written in TypeScript and provides full type definitions out of the box. No additional @types packages needed.

Next Steps