<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[29057] trunk/src: Media grid attachment modal:</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/29057">29057</a></dd>
<dt>Author</dt> <dd>helen</dd>
<dt>Date</dt> <dd>2014-07-10 06:36:34 +0000 (Thu, 10 Jul 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Media grid attachment modal:
* Keyboard navigation.
* History and routes for single items and search results.
props adamsilverstein. see <a href="http://core.trac.wordpress.org/ticket/24716">#24716</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminuploadphp">trunk/src/wp-admin/upload.php</a></li>
<li><a href="#trunksrcwpincludesjsmediagridjs">trunk/src/wp-includes/js/media-grid.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminuploadphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-admin/upload.php (29056 => 29057)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-admin/upload.php 2014-07-10 03:49:28 UTC (rev 29056)
+++ trunk/src/wp-admin/upload.php 2014-07-10 06:36:34 UTC (rev 29057)
</span><span class="lines">@@ -24,6 +24,7 @@
</span><span class="cx"> wp_enqueue_media();
</span><span class="cx"> wp_enqueue_script( 'media-grid' );
</span><span class="cx"> wp_enqueue_script( 'media' );
</span><ins>+ wp_localize_script( 'media-grid', 'mediaGridSettings', array( 'adminUrl' => parse_url( self_admin_url(), PHP_URL_PATH ) ) );
</ins><span class="cx">
</span><span class="cx"> require_once( ABSPATH . 'wp-admin/admin-header.php' );
</span><span class="cx"> include( ABSPATH . 'wp-admin/admin-footer.php' );
</span></span></pre></div>
<a id="trunksrcwpincludesjsmediagridjs"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/js/media-grid.js (29056 => 29057)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/js/media-grid.js 2014-07-10 03:49:28 UTC (rev 29056)
+++ trunk/src/wp-includes/js/media-grid.js 2014-07-10 06:36:34 UTC (rev 29057)
</span><span class="lines">@@ -1,4 +1,4 @@
</span><del>-/* global _wpMediaViewsL10n, setUserSetting, deleteUserSetting, MediaElementPlayer */
</del><ins>+/* global _wpMediaViewsL10n, setUserSetting, deleteUserSetting, MediaElementPlayer, mediaGridSettings*/
</ins><span class="cx"> (function($, _, Backbone, wp) {
</span><span class="cx"> var media = wp.media, l10n;
</span><span class="cx">
</span><span class="lines">@@ -91,6 +91,7 @@
</span><span class="cx"> * @global wp.Uploader
</span><span class="cx"> */
</span><span class="cx"> initialize: function() {
</span><ins>+ var self = this;
</ins><span class="cx"> _.defaults( this.options, {
</span><span class="cx"> title: l10n.mediaLibraryTitle,
</span><span class="cx"> modal: false,
</span><span class="lines">@@ -140,6 +141,24 @@
</span><span class="cx"> this.createStates();
</span><span class="cx"> this.bindHandlers();
</span><span class="cx"> this.render();
</span><ins>+
+ // Set up the Backbone router after a brief delay
+ _.delay( function(){
+ wp.media.mediarouter = new media.view.Frame.Router( self );
+ // Verify pushState support and activate
+ if ( window.history && window.history.pushState ) {
+ Backbone.history.start({
+ root: mediaGridSettings.adminUrl,
+ pushState: true
+ });
+ }
+ }, 250);
+
+ // Update the URL when entering search string (at most once per second)
+ $( '#media-search-input' ).on( 'input', _.debounce( function() {
+ var $val = $( this ).val();
+ wp.media.mediarouter.navigate( wp.media.mediarouter.baseUrl( ( '' === $val ) ? '' : ( '?search=' + $val ) ) );
+ }, 1000 ) );
</ins><span class="cx"> },
</span><span class="cx">
</span><span class="cx"> createSelection: function() {
</span><span class="lines">@@ -218,10 +237,11 @@
</span><span class="cx"> * Open the Edit Attachment modal.
</span><span class="cx"> */
</span><span class="cx"> editAttachment: function( model ) {
</span><del>- var library = this.state().get('library');
</del><ins>+ var self = this,
+ library = this.state().get('library');
</ins><span class="cx">
</span><span class="cx"> // Create a new EditAttachment frame, passing along the library and the attachment model.
</span><del>- this.editAttachmentFrame = new media.view.Frame.EditAttachment({
</del><ins>+ this.editAttachmentFrame = new media.view.Frame.EditAttachments({
</ins><span class="cx"> library: library,
</span><span class="cx"> model: model
</span><span class="cx"> });
</span><span class="lines">@@ -229,6 +249,10 @@
</span><span class="cx"> // Listen to events on the edit attachment frame for triggering pagination callback handlers.
</span><span class="cx"> this.listenTo( this.editAttachmentFrame, 'edit:attachment:next', this.editNextAttachment );
</span><span class="cx"> this.listenTo( this.editAttachmentFrame, 'edit:attachment:previous', this.editPreviousAttachment );
</span><ins>+ // Listen to keyboard events on the modal
+ $( 'body' ).on( 'keydown.media-modal', function( e ) {
+ self.editAttachmentFrame.keyEvent( e );
+ } );
</ins><span class="cx"> },
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -300,13 +324,66 @@
</span><span class="cx"> });
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * A router for handling the browser history and application state
+ */
+ media.view.Frame.Router = Backbone.Router.extend({
+
+ mediaFrame: '',
+
+ initialize: function( mediaFrame ){
+ this.mediaFrame = mediaFrame;
+ },
+
+ routes: {
+ 'upload.php?item=:slug': 'showitem',
+ 'upload.php?search=:query': 'search',
+ ':default': 'defaultRoute'
+ },
+
+ // Map routes against the page URL
+ baseUrl: function( url ) {
+ return 'upload.php' + url;
+ },
+
+ // Respond to the search route by filling the search field and trigggering the input event
+ search: function( query ) {
+ // Ensure modal closed, see back button
+ this.closeModal();
+ $( '#media-search-input' ).val( query ).trigger( 'input' );
+ },
+
+ // Show the modal with a specific item
+ showitem: function( query ) {
+ var library = this.mediaFrame.state().get('library');
+
+ // Remove existing modal if present
+ this.closeModal();
+ // Trigger the media frame to open the correct item
+ this.mediaFrame.trigger( 'edit:attachment', library.findWhere( { id: parseInt( query, 10 ) } ) );
+ },
+
+ // Close the modal if set up
+ closeModal: function() {
+ if ( 'undefined' !== typeof this.mediaFrame.editAttachmentFrame ) {
+ this.mediaFrame.editAttachmentFrame.modal.close();
+ }
+ },
+
+ // Default route: make sure the modal and search are reset
+ defaultRoute: function() {
+ this.closeModal();
+ $( '#media-search-input' ).val( '' ).trigger( 'input' );
+ }
+ });
+
+ /**
</ins><span class="cx"> * A frame for editing the details of a specific media item.
</span><span class="cx"> *
</span><span class="cx"> * Opens in a modal by default.
</span><span class="cx"> *
</span><span class="cx"> * Requires an attachment model to be passed in the options hash under `model`.
</span><span class="cx"> */
</span><del>- media.view.Frame.EditAttachment = media.view.Frame.extend({
</del><ins>+ media.view.Frame.EditAttachments = media.view.Frame.extend({
</ins><span class="cx">
</span><span class="cx"> className: 'edit-attachment-frame',
</span><span class="cx"> template: media.template( 'edit-attachment-frame' ),
</span><span class="lines">@@ -328,13 +405,20 @@
</span><span class="cx"> state: 'edit-attachment'
</span><span class="cx"> });
</span><span class="cx">
</span><ins>+ this.library = this.options.library;
+ if ( this.options.model ) {
+ this.model = this.options.model;
+ } else {
+ this.model = this.library.at( 0 );
+ }
+
</ins><span class="cx"> this.createStates();
</span><span class="cx">
</span><span class="cx"> this.on( 'content:render:edit-metadata', this.editMetadataContent, this );
</span><span class="cx"> this.on( 'content:render:edit-image', this.editImageContentUgh, this );
</span><span class="cx">
</span><span class="cx"> // Only need a tab to Edit Image for images.
</span><del>- if ( this.model.get( 'type' ) === 'image' ) {
</del><ins>+ if ( 'undefined' !== typeof this.model && this.model.get( 'type' ) === 'image' ) {
</ins><span class="cx"> this.on( 'router:create', this.createRouter, this );
</span><span class="cx"> this.on( 'router:render', this.browseRouter, this );
</span><span class="cx"> }
</span><span class="lines">@@ -352,6 +436,7 @@
</span><span class="cx"> // Completely destroy the modal DOM element when closing it.
</span><span class="cx"> this.modal.close = function() {
</span><span class="cx"> self.modal.remove();
</span><ins>+ $( 'body' ).off( 'keydown.media-modal' ); /* remove the keydown event */
</ins><span class="cx"> };
</span><span class="cx">
</span><span class="cx"> this.modal.content( this );
</span><span class="lines">@@ -391,6 +476,8 @@
</span><span class="cx"> model: this.model
</span><span class="cx"> });
</span><span class="cx"> this.content.set( view );
</span><ins>+ // Update browser url when navigating media details
+ wp.media.mediarouter.navigate( wp.media.mediarouter.baseUrl( '?item=' + this.model.id ) );
</ins><span class="cx"> },
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -461,6 +548,48 @@
</span><span class="cx"> return;
</span><span class="cx"> this.modal.close();
</span><span class="cx"> this.trigger( 'edit:attachment:next', this.model );
</span><ins>+ },
+
+ getCurrentIndex: function() {
+ return this.library.indexOf( this.model );
+ },
+
+ hasNext: function() {
+ return ( this.getCurrentIndex() + 1 ) < this.library.length;
+ },
+
+ hasPrevious: function() {
+ return ( this.getCurrentIndex() - 1 ) > -1;
+ },
+ /**
+ * Respond to the keyboard events: right arrow, left arrow, escape.
+ */
+ keyEvent: function( event ) {
+ var $target = $( event.target );
+ // Pressing the escape key routes back to main url
+ if ( event.keyCode === 27 ) {
+ this.resetRoute();
+ return event;
+ }
+ //Don't go left/right if we are in a textarea or input field
+ if ( $target.is( 'input' ) || $target.is( 'textarea' ) ) {
+ return event;
+ }
+ // The right arrow key
+ if ( event.keyCode === 39 ) {
+ if ( ! this.hasNext ) { return; }
+ _.debounce( this.nextMediaItem(), 250 );
+ }
+ // The left arrow key
+ if ( event.keyCode === 37 ) {
+ if ( ! this.hasPrevious ) { return; }
+ _.debounce( this.previousMediaItem(), 250 );
+ }
+ },
+
+ resetRoute: function() {
+ wp.media.mediarouter.navigate( wp.media.mediarouter.baseUrl( '' ) );
+ return;
</ins><span class="cx"> }
</span><span class="cx"> });
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>