@topol.io/editor v0.2.0

Easy and quick! Drag and drop HTML editor and builder for beautiful responsive email templates.

Documentation

Installation

Install Editor from NPM using:

npm install @topol.io/editor

//or

yarn add @topol.io/editor

Usage

Add HTML element Editor will load to

<div id="app" style="position: absolute; width: 100%; height: 100%"></div>

In your JS or TS file import TopolPlugin, initialize the editor, as an ID provide the id you defined the HTML, in this example its app

For more options see the docs for TopolOptions configuration

import TopolPlugin from "@topol.io/editor";

const TOPOL_OPTIONS = {
  id: "#app",
  authorize: {
    apiKey: "YOUR_API_TOKEN",
    userId: "some-user-id",
  },
  callbacks: {
    onSave(json, html) {},
  },
};

TopolPlugin.init(TOPOL_OPTIONS);

Call Topol Plugin actions

To call actions to the editor import:

import { TopolPlugin } from "@topol.io/editor";

TopolPlugin.save();

List of all available TopolPlugin actions:

List of all editor callbacks

TypeScript

Topol Editor provides full TypeScript integration and exports all necessary types.

import { ITopolOptions, INotification, ISavedBlock } from "@topol.io/editor";