0.2.0 • Published 4 months ago

@topol.io/editor-svelte v0.2.0

Weekly downloads
-
License
Apache-2.0
Repository
-
Last release
4 months ago

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-svelte

//or

yarn add @topol.io/editor-svelte

Use in Component

In your Svelte component import and add the simplest options.

For more options see the docs for TopolOptions configuration

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

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-svelte';

const save = () => {
  TopolPlugin.save();
};

For more TopolPlugion functions refer to the TopolPlugin actions

Editor Events

The callbacks from editor are received as component events.

<TopolEditor
  options="{customOptions}"
  on:onSave="{onSave}"
></TopolEditor>

List of all editor events

EventDescription
@onSaveReturns object which contains html and json of the template more info
@onSaveAndCloseReturns object which contains html and json of the template more info
@onTestSendReturns object which contains email, html and json of the template more info
@onOpenFileManagerWhen user clicks file manager open more info
@onLoadedAfter editor template is loaded using TopolPlugin.load() more info
@onInitWhen editor inits more info
@onBlockSaveWhen user saves block in editor, returns object of type ISavedBlock more info
@onBlockRemoveWhen user removes saved block, returns id of saved block to be removed more info
@onBlockEditWhen user edits saved block, returns id of saved block to be updated more info
@onUndoChangeWhen user clicks undo button, retunrs number of steps user undone more info
@onRedoChangeWhen user clicks redo button, retunrs number of steps user redone more info
@onPreviewWhen user switches to preview more info
@onAlertWhen alert appears in editor more info
@onCloseWhen close is click inside WindowBar more info
@onEdittedWithoutSaveChangedWhen user is about to leave an editor with unsaved changes more info
@onOpenCustomBlockDialogWhen user clicks on the open dialog in custom block more info
@onTemplateRenameWhen user clicks on the pencil icon next to the template name more info
@updateTestingEmailAddressesWhen user edits the email list in preview more info
@onErrorWhen an error that cannot be handled happened in the editor more info

TypeScript

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

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

4 months ago

0.1.0

7 months ago

0.0.4

1 year ago

0.0.3

1 year ago

0.0.2

1 year ago

0.0.1

1 year ago