@optimuscms/editor

The Optimus CMS WYSIWYG editor powered by TinyMCE.

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@optimuscms/editor
Minified + gzip package size for @optimuscms/editor in KB

Readme

Optimus Editor

The Optimus CMS WYSIWYG editor powered by TinyMCE.

Installation

# npm
npm install @optimuscms/editor --save

# yarn
yarn add @optimuscms/editor

Javascript

import Editor from '@optimuscms/editor';

Vue.use(Editor, {
    apiKey: 'your-api-key'
});

SCSS

@import '~@optimuscms/editor/dist/styles.css';

Usage

Configuration

The default configuration options can be modified using any of the TinyMCE options.

import Editor, { config } from '@optimuscms/editor';

config.branding = true;

Vue.use(Editor, {
    apiKey: 'your-api-key',
    config: config
});

An optional parameter of componentName can be passed allowing you to set a custom component name for the editor, by default this is editor.

Component

By default the plugin registers an <editor> component.

<editor v-model="content"></editor>

It's also possible to modifiy a specific component's configuration options via the config prop.

<editor v-model="content" :config="{ branding: true }"></editor>

License

The MIT License (MIT). Please see License File for more information.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.