evolutionTextEditor jQuery Plugin

Ben Tiedt — Fri, 08 Mar 2024 17:51:41 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:51:41

jQuery.fn.evolutionTextEditor

This plugin supports enhancing a text area with support for editing HTML suitable for use as a primary content editor.

Usage

$('SELECTOR').evolutionTextEditor(options)

where 'SELECTOR' is a textarea.

Options

plugins: (array) list of [[evolutionComposer jQuery Plugin|evolutionComposer]] plugins to enable for this text editor
- default []
readOnlyMessage: (string) message to show when a user attempts to edit content that cannot be edited in plain text mode
- default ``

Methods

val

Returns (and sets if passed a second optional value) the current HTML result of the text editor

// get the value
var value = $('SELECTOR').evolutionTextEditor('val');

// set the value
$('SELECTOR').evolutionTextEditor('val', '<p>New content</p>');

focus

Focuses on the editor.

$('SELECTOR').evolutionTextEditor('focus');

resize

Resizes the editor to a specific width/height.

$('SELECTOR').evolutionTextEditor('resize', width, height);

onKeyDown

Registers a function to be called when a key is pressed.

$('SELECTOR').evolutionTextEditor('onKeyDown', callback);