2 * Text pattern plugin for TinyMCE
6 * This plugin can automatically format text patterns as you type. It includes several groups of patterns.
8 * Start of line patterns:
10 * - Unordered list (`* ` and `- `).
11 * - Ordered list (`1. ` and `1) `).
23 * - <code> (`) (backtick).
25 * If the transformation in unwanted, the user can undo the change by pressing backspace,
26 * using the undo shortcut, or the undo button in the toolbar.
28 * Setting for the patterns can be overridden by plugins by using the `tiny_mce_before_init` PHP filter.
29 * The setting name is `wptextpattern` and the value is an object containing override arrays for each
30 * patterns group. There are three groups: "space", "enter", and "inline". Example (PHP):
32 * add_filter( 'tiny_mce_before_init', 'my_mce_init_wptextpattern' );
33 * function my_mce_init_wptextpattern( $init ) {
34 * $init['wptextpattern'] = wp_json_encode( array(
36 * array( 'delimiter' => '**', 'format' => 'bold' ),
37 * array( 'delimiter' => '__', 'format' => 'italic' ),
44 * Note that setting this will override the default text patterns. You will need to include them
45 * in your settings array if you want to keep them working.
47 ( function( tinymce, setTimeout ) {
48 if ( tinymce.Env.ie && tinymce.Env.ie < 9 ) {
53 * Escapes characters for use in a Regular Expression.
55 * @param {String} string Characters to escape
57 * @return {String} Escaped characters
59 function escapeRegExp( string ) {
60 return string.replace( /[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, '\\$&' );
63 tinymce.PluginManager.add( 'wptextpattern', function( editor ) {
64 var VK = tinymce.util.VK;
65 var settings = editor.settings.wptextpattern || {};
67 var spacePatterns = settings.space || [
68 { regExp: /^[*-]\s/, cmd: 'InsertUnorderedList' },
69 { regExp: /^1[.)]\s/, cmd: 'InsertOrderedList' }
72 var enterPatterns = settings.enter || [
73 { start: '##', format: 'h2' },
74 { start: '###', format: 'h3' },
75 { start: '####', format: 'h4' },
76 { start: '#####', format: 'h5' },
77 { start: '######', format: 'h6' },
78 { start: '>', format: 'blockquote' },
79 { regExp: /^(-){3,}$/, element: 'hr' }
82 var inlinePatterns = settings.inline || [
83 { delimiter: '`', format: 'code' }
88 editor.on( 'selectionchange', function() {
92 editor.on( 'keydown', function( event ) {
93 if ( ( canUndo && event.keyCode === 27 /* ESCAPE */ ) || ( canUndo === 'space' && event.keyCode === VK.BACKSPACE ) ) {
94 editor.undoManager.undo();
95 event.preventDefault();
96 event.stopImmediatePropagation();
99 if ( VK.metaKeyPressed( event ) ) {
103 if ( event.keyCode === VK.ENTER ) {
105 // Wait for the browser to insert the character.
106 } else if ( event.keyCode === VK.SPACEBAR ) {
108 } else if ( event.keyCode > 47 && ! ( event.keyCode >= 91 && event.keyCode <= 93 ) ) {
109 setTimeout( inline );
114 var rng = editor.selection.getRng();
115 var node = rng.startContainer;
116 var offset = rng.startOffset;
123 // We need a non empty text node with an offset greater than zero.
124 if ( ! node || node.nodeType !== 3 || ! node.data.length || ! offset ) {
128 var string = node.data.slice( 0, offset );
129 var lastChar = node.data.charAt( offset - 1 );
131 tinymce.each( inlinePatterns, function( p ) {
132 // Character before selection should be delimiter.
133 if ( lastChar !== p.delimiter.slice( -1 ) ) {
137 var escDelimiter = escapeRegExp( p.delimiter );
138 var delimiterFirstChar = p.delimiter.charAt( 0 );
139 var regExp = new RegExp( '(.*)' + escDelimiter + '.+' + escDelimiter + '$' );
140 var match = string.match( regExp );
146 startOffset = match[1].length;
147 endOffset = offset - p.delimiter.length;
149 var before = string.charAt( startOffset - 1 );
150 var after = string.charAt( startOffset + p.delimiter.length );
152 // test*test* => format applied
153 // test *test* => applied
154 // test* test* => not applied
155 if ( startOffset && /\S/.test( before ) ) {
156 if ( /\s/.test( after ) || before === delimiterFirstChar ) {
161 // Do not replace when only whitespace and delimiter characters.
162 if ( ( new RegExp( '^[\\s' + escapeRegExp( delimiterFirstChar ) + ']+$' ) ).test( string.slice( startOffset, endOffset ) ) ) {
175 format = editor.formatter.get( pattern.format );
177 if ( format && format[0].inline ) {
178 editor.undoManager.add();
180 editor.undoManager.transact( function() {
181 node.insertData( offset, '\uFEFF' );
183 node = node.splitText( startOffset );
184 zero = node.splitText( offset - startOffset );
186 node.deleteData( 0, pattern.delimiter.length );
187 node.deleteData( node.data.length - pattern.delimiter.length, pattern.delimiter.length );
189 editor.formatter.apply( pattern.format, {}, node );
191 editor.selection.setCursorLocation( zero, 1 );
194 // We need to wait for native events to be triggered.
195 setTimeout( function() {
198 editor.once( 'selectionchange', function() {
202 offset = zero.data.indexOf( '\uFEFF' );
204 if ( offset !== -1 ) {
205 zero.deleteData( offset, offset + 1 );
213 function firstTextNode( node ) {
214 var parent = editor.dom.getParent( node, 'p' ),
221 while ( child = parent.firstChild ) {
222 if ( child.nodeType !== 3 ) {
233 if ( ! child.data ) {
234 if ( child.nextSibling && child.nextSibling.nodeType === 3 ) {
235 child = child.nextSibling;
245 var rng = editor.selection.getRng(),
246 node = rng.startContainer,
250 if ( ! node || firstTextNode( node ) !== node ) {
254 parent = node.parentNode;
257 tinymce.each( spacePatterns, function( pattern ) {
258 var match = text.match( pattern.regExp );
260 if ( ! match || rng.startOffset !== match[0].length ) {
264 editor.undoManager.add();
266 editor.undoManager.transact( function() {
267 node.deleteData( 0, match[0].length );
269 if ( ! parent.innerHTML ) {
270 parent.appendChild( document.createElement( 'br' ) );
273 editor.selection.setCursorLocation( parent );
274 editor.execCommand( pattern.cmd );
277 // We need to wait for native events to be triggered.
278 setTimeout( function() {
287 var rng = editor.selection.getRng(),
288 start = rng.startContainer,
289 node = firstTextNode( start ),
290 i = enterPatterns.length,
291 text, pattern, parent;
300 if ( enterPatterns[ i ].start ) {
301 if ( text.indexOf( enterPatterns[ i ].start ) === 0 ) {
302 pattern = enterPatterns[ i ];
305 } else if ( enterPatterns[ i ].regExp ) {
306 if ( enterPatterns[ i ].regExp.test( text ) ) {
307 pattern = enterPatterns[ i ];
317 if ( node === start && tinymce.trim( text ) === pattern.start ) {
321 editor.once( 'keyup', function() {
322 editor.undoManager.add();
324 editor.undoManager.transact( function() {
325 if ( pattern.format ) {
326 editor.formatter.apply( pattern.format, {}, node );
327 node.replaceData( 0, node.data.length, ltrim( node.data.slice( pattern.start.length ) ) );
328 } else if ( pattern.element ) {
329 parent = node.parentNode && node.parentNode.parentNode;
332 parent.replaceChild( document.createElement( pattern.element ), node.parentNode );
337 // We need to wait for native events to be triggered.
338 setTimeout( function() {
344 function ltrim( text ) {
345 return text ? text.replace( /^\s+/, '' ) : '';
348 } )( window.tinymce, window.setTimeout );