241 lines
6.7 KiB
JavaScript
241 lines
6.7 KiB
JavaScript
// Ensure the global `wp` object exists.
|
|
if ( typeof wp === 'undefined' )
|
|
var wp = {};
|
|
|
|
(function($){
|
|
var views = {},
|
|
instances = {};
|
|
|
|
// Create the `wp.mce` object if necessary.
|
|
wp.mce = wp.mce || {};
|
|
|
|
// wp.mce.view
|
|
// -----------
|
|
//
|
|
// A set of utilities that simplifies adding custom UI within a TinyMCE editor.
|
|
// At its core, it serves as a series of converters, transforming text to a
|
|
// custom UI, and back again.
|
|
wp.mce.view = {
|
|
// ### defaults
|
|
// The default properties used for the objects in `wp.mce.view.add()`.
|
|
defaults: {
|
|
view: Backbone.View,
|
|
text: function( instance ) {
|
|
return instance.options.original;
|
|
},
|
|
|
|
toView: function( content ) {
|
|
if ( ! this.pattern )
|
|
return;
|
|
|
|
this.pattern.lastIndex = 0;
|
|
var match = this.pattern.exec( content );
|
|
|
|
if ( ! match )
|
|
return;
|
|
|
|
return {
|
|
index: match.index,
|
|
content: match[0],
|
|
options: {
|
|
original: match[0],
|
|
results: _.toArray( arguments )
|
|
}
|
|
};
|
|
}
|
|
},
|
|
|
|
shortcode: {
|
|
view: Backbone.View,
|
|
text: function( instance ) {
|
|
return instance.options.shortcode.text();
|
|
},
|
|
|
|
toView: function( content ) {
|
|
var match = wp.shortcode.next( this.tag, content );
|
|
|
|
if ( ! match )
|
|
return;
|
|
|
|
return {
|
|
index: match.index,
|
|
content: match.content,
|
|
options: {
|
|
shortcode: match.shortcode
|
|
}
|
|
};
|
|
}
|
|
},
|
|
|
|
// ### add( id, options )
|
|
// Registers a new TinyMCE view.
|
|
//
|
|
// Accepts a unique `id` and an `options` object.
|
|
//
|
|
// `options` accepts the following properties:
|
|
//
|
|
// * `pattern` is the regular expression used to scan the content and
|
|
// detect matching views.
|
|
//
|
|
// * `view` is a `Backbone.View` constructor. If a plain object is
|
|
// provided, it will automatically extend the parent constructor
|
|
// (usually `Backbone.View`). Views are instantiated when the `pattern`
|
|
// is successfully matched. The instance's `options` object is provided
|
|
// with the `original` matched value, the match `results` including
|
|
// capture groups, and the `viewType`, which is the constructor's `id`.
|
|
//
|
|
// * `extend` an existing view by passing in its `id`. The current
|
|
// view will inherit all properties from the parent view, and if
|
|
// `view` is set to a plain object, it will extend the parent `view`
|
|
// constructor.
|
|
//
|
|
// * `text` is a method that accepts an instance of the `view`
|
|
// constructor and transforms it into a text representation.
|
|
add: function( id, options ) {
|
|
// Fetch the parent view or the default options.
|
|
var parent = options.extend ? wp.mce.view.get( options.extend ) : wp.mce.view.defaults;
|
|
|
|
// Extend the `options` object with the parent's properties.
|
|
_.defaults( options, parent );
|
|
options.id = id;
|
|
|
|
// If the `view` provided was an object, automatically create
|
|
// a new `Backbone.View` constructor, using the parent's `view`
|
|
// constructor as a base.
|
|
if ( ! _.isFunction( options.view ) )
|
|
options.view = parent.view.extend( options.view );
|
|
|
|
views[ id ] = options;
|
|
},
|
|
|
|
// ### get( id )
|
|
// Returns a TinyMCE view options object.
|
|
get: function( id ) {
|
|
return views[ id ];
|
|
},
|
|
|
|
// ### remove( id )
|
|
// Unregisters a TinyMCE view.
|
|
remove: function( id ) {
|
|
delete views[ id ];
|
|
},
|
|
|
|
// ### toViews( content )
|
|
// Scans a `content` string for each view's pattern, replacing any
|
|
// matches with wrapper elements, and creates a new view instance for
|
|
// every match.
|
|
//
|
|
// To render the views, call `wp.mce.view.render( scope )`.
|
|
toViews: function( content ) {
|
|
var pieces = [ { content: content } ],
|
|
current;
|
|
|
|
_.each( views, function( view, viewType ) {
|
|
current = pieces.slice();
|
|
pieces = [];
|
|
|
|
_.each( current, function( piece ) {
|
|
var remaining = piece.content,
|
|
result;
|
|
|
|
// Ignore processed pieces, but retain their location.
|
|
if ( piece.processed ) {
|
|
pieces.push( piece );
|
|
return;
|
|
}
|
|
|
|
// Iterate through the string progressively matching views
|
|
// and slicing the string as we go.
|
|
while ( remaining && (result = view.toView( remaining )) ) {
|
|
// Any text before the match becomes an unprocessed piece.
|
|
if ( result.index )
|
|
pieces.push({ content: remaining.substring( 0, result.index ) });
|
|
|
|
// Add the processed piece for the match.
|
|
pieces.push({
|
|
content: wp.mce.view.toView( viewType, result.options ),
|
|
processed: true
|
|
});
|
|
|
|
// Update the remaining content.
|
|
remaining = remaining.slice( result.index + result.content.length );
|
|
}
|
|
|
|
// There are no additional matches. If any content remains,
|
|
// add it as an unprocessed piece.
|
|
if ( remaining )
|
|
pieces.push({ content: remaining });
|
|
});
|
|
});
|
|
|
|
return _.pluck( pieces, 'content' ).join('');
|
|
},
|
|
|
|
toView: function( viewType, options ) {
|
|
var view = wp.mce.view.get( viewType ),
|
|
instance, id, tag;
|
|
|
|
if ( ! view )
|
|
return '';
|
|
|
|
// Create a new view instance.
|
|
instance = new view.view( _.extend( options || {}, {
|
|
viewType: viewType
|
|
}) );
|
|
|
|
// Use the view's `id` if it already exists. Otherwise,
|
|
// create a new `id`.
|
|
id = instance.el.id = instance.el.id || _.uniqueId('__wpmce-');
|
|
instances[ id ] = instance;
|
|
|
|
// If the view is a span, wrap it in a span.
|
|
tag = 'span' === instance.tagName ? 'span' : 'div';
|
|
|
|
return '<' + tag + ' class="wp-view-wrap" data-wp-view="' + id + '" contenteditable="false"></' + tag + '>';
|
|
},
|
|
|
|
// ### render( scope )
|
|
// Renders any view instances inside a DOM node `scope`.
|
|
//
|
|
// View instances are detected by the presence of wrapper elements.
|
|
// To generate wrapper elements, pass your content through
|
|
// `wp.mce.view.toViews( content )`.
|
|
render: function( scope ) {
|
|
$( '.wp-view-wrap', scope ).each( function() {
|
|
var wrapper = $(this),
|
|
id = wrapper.data('wp-view'),
|
|
view = instances[ id ];
|
|
|
|
if ( ! view )
|
|
return;
|
|
|
|
// Render the view.
|
|
view.render();
|
|
// Detach the view element to ensure events are not unbound.
|
|
view.$el.detach();
|
|
|
|
// Empty the wrapper, attach the view element to the wrapper,
|
|
// and add an ending marker to the wrapper to help regexes
|
|
// scan the HTML string.
|
|
wrapper.empty().append( view.el ).append('<span data-wp-view-end></span>');
|
|
});
|
|
},
|
|
|
|
// ### toText( content )
|
|
// Scans an HTML `content` string and replaces any view instances with
|
|
// their respective text representations.
|
|
toText: function( content ) {
|
|
return content.replace( /<(?:div|span)[^>]+data-wp-view="([^"]+)"[^>]*>.*?<span data-wp-view-end[^>]*><\/span><\/(?:div|span)>/g, function( match, id ) {
|
|
var instance = instances[ id ],
|
|
view;
|
|
|
|
if ( instance )
|
|
view = wp.mce.view.get( instance.options.viewType );
|
|
|
|
return instance && view ? view.text( instance ) : '';
|
|
});
|
|
}
|
|
};
|
|
|
|
}(jQuery));
|