@topol.io/editor-vue 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-vue

//or

yarn add @topol.io/editor-vue

Use in Component

In your Vue component import and add the simplest options.

For more options see the docs for TopolOptions configuration

import { TopolEditor } from '@topol.io/editor-vue';

const customOptions = {
  authorize: {
    apiKey: 'YOUR_API_TOKEN',
    userId: 'some-user-id',
  },
};

<TopolEditor :options="customOptions"></TopolEditor>

Call Topol Plugin actions

To call actions to the editor import:

import { TopolPlugin } from '@topol.io/editor-vue';

TopolPlugin.save();

For more TopolPlugin functions refer to the TopolPlugin actions

Editor Events

The callbacks from editor are received as component events.

<TopolEditor
  :options="customOptions"
  @onSave="handleOnSave"
></TopolEditor>

List of all editor events

TypeScript

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

<script setup lang="ts">
import {
  ITopolOptions,
  INotification,
  ISavedBlock,
} from '@topol.io/editor-vue';
</script>