Editor

Option Type Default Description
wrapperClass String wysiwyg-wrapper $('element').wysiwyg('option', 'wrapperClass')
$('element').wysiwyg({wrapperClass: 'wrapper'})
toolbarWrapperClass String wysiwyg-toolbar $('element').wysiwyg('option', 'toolbarWrapperClass')
$('element').wysiwyg({toolbarWrapperClass: 'wrapper'})
frameWrapperClass String wysiwyg-frame $('element').wysiwyg('option', 'frameWrapperClass')
$('element').wysiwyg({frameWrapperClass: 'wrapper'})
resizable Object {handles: 's'} $('element').wysiwyg('option', 'resizable')
$('element').wysiwyg('option', 'resizable', {handles: 'se'})
ui Boolen true $('element').wysiwyg('option', 'ui')
$('element').wysiwyg('option', 'ui', false)
autosave Object {url: null, enabled: true, interval: 5} $('element').wysiwyg('option', 'autosave')
$('element').wysiwyg({autosave: {url: '/save'}})
css String NULL $('element').wysiwyg('option', 'css')
$('element').wysiwyg({css: 'frame.css'})
commandsMap Object EditorCommandsMap $('element').wysiwyg('option', 'commandsMap')
$('element').wysiwyg('option', 'commandsMap', {commandName: function(){}})
eventsMap Object EditorEventsMap $('element').wysiwyg('option', 'eventsMap')
$('element').wysiwyg('option', 'eventsMap', {eventName: function(e){}})
template String <!DOCTYPE html><html><head></head><body><p></p></body></html> $('element').wysiwyg({template: '<!DOCTYPE html><html><head></head><body><p></p></body></html>'})

Toolbar

Option Type Default Description
editor Array [] $('element').wysiwyg('option', 'editor')
$('element').wysiwyg('option', 'editor', $('textarea').wysiwyg())
ui Boolen true $('element').wysiwyg('option', 'ui')
$('element').wysiwyg('option', 'ui', false)

Editor

Method Description Example
commands Add new editor commands $('element').wysiwyg('commands', {commandName: function(){}})
events Add new editor events $('element').wysiwyg('events', {keypress: function(e){}})
clean Remove garbage from editor content $('element').wysiwyg('clean')
activeNode Get editor active node $('element').wysiwyg('activeNode')
show Show widget $('element').wysiwyg('show')
hide Hide widget $('element').wysiwyg('hide')
exec Execute editor command

Default commands https://developer.mozilla.org/en/Rich-Text_Editing_in_Mozilla

Additional commands can be added via commandsMap

 $('element').wysiwyg('exec', 'insertdtml', '<b>bold text</b>')
widget Get widget selector $('element').wysiwyg('widget')
selected Get selected text inside editor $('element').wysiwyg('selected')
html Get or set editor content $('element').wysiwyg('html', '<p>new contents</p>')
$('element').wysiwyg('html')
destroy Destroy widget $('element').wysiwyg('destroy')
enable Enable widget $('element').wysiwyg('enable')
disable Disable widget $('element').wysiwyg('disable')
toolbar Add or get toolbars $('element').wysiwyg('toolbar')
$('element').wysiwyg('toolbar', $('#toolbar'))
$('element').wysiwyg('toolbar', '#toolbar')

Toolbar

Method Description Example
editor Set editor $('element').wysiwygToolbar('editor', $('textarea').wysiwyg());
show Show widget $('element').wysiwygToolbar('show')
hide Hide widget $('element').wysiwygToolbar('hide')
widget Get widget selector $('element').wysiwygToolbar('widget')
destroy Destroy widget $('element').wysiwygToolbar('destroy')

CommandsMap

Method Description Example
justify Justify current text block $('element').wysiwyg('exec', 'justify', 'right');
strike Strike selected text $('element').wysiwyg('exec', 'strike');
format Wrap text with html tag $('element').wysiwyg('exec', 'format', 'p');
tag Insert new html tag (br or hr) $('element').wysiwyg('exec', 'tag', 'br');
quote Wrap selected text with "e; $('element').wysiwyg('exec', 'quote', 'br');
list Insert list. if argument is true - ordered $('element').wysiwyg('exec', 'list', true);
link Wrap selected text with <a> tag $('element').wysiwyg('exec', 'tag', 'br');
html Insert html $('element').wysiwyg('exec', 'html', '<p>hello</p>');
isFontSize Check if font size equals to an argument $('element').wysiwyg('exec', 'isFontSize', 2);
isFontFace Check if font family equals to an argument $('element').wysiwyg('exec', 'isFontFace', 'Arial');
isBold Check if text is bold $('element').wysiwyg('exec', 'isBold');
isUnderline Check if text is underlined $('element').wysiwyg('exec', 'isUnderline');
isItalic Check if text is italic $('element').wysiwyg('exec', 'isItalic');
isJustify Check if text is justified to an argument $('element').wysiwyg('exec', 'isJustify', 'left');

Minimal New window

Medium New window

Full New window

Wym Mode New window

Theming New window