1 /* global _wpThemeSettings, confirm */
2 window.wp = window.wp || {};
6 // Set up our namespace...
8 themes = wp.themes = wp.themes || {};
10 // Store the theme data and settings for organized and quick access
11 // themes.data.settings, themes.data.themes, themes.data.l10n
12 themes.data = _wpThemeSettings;
13 l10n = themes.data.l10n;
15 // Shortcut for isInstall check
16 themes.isInstall = !! themes.data.settings.isInstall;
18 // Setup app structure
19 _.extend( themes, { model: {}, view: {}, routes: {}, router: {}, template: wp.template });
21 themes.Model = Backbone.Model.extend({
22 // Adds attributes to the default data coming through the .org themes api
23 // Map `id` to `slug` for shared code
24 initialize: function() {
27 // If theme is already installed, set an attribute.
28 if ( _.indexOf( themes.data.installedThemes, this.get( 'slug' ) ) !== -1 ) {
29 this.set({ installed: true });
34 // slug is for installation, id is for existing.
35 id: this.get( 'slug' ) || this.get( 'id' )
38 // Map `section.description` to `description`
39 // as the API sometimes returns it differently
40 if ( this.has( 'sections' ) ) {
41 description = this.get( 'sections' ).description;
42 this.set({ description: description });
47 // Main view controller for themes.php
48 // Unifies and renders all available views
49 themes.view.Appearance = wp.Backbone.View.extend({
51 el: '#wpbody-content .wrap .theme-browser',
54 // Pagination instance
57 // Sets up a throttler for binding to 'scroll'
58 initialize: function( options ) {
59 // Scroller checks how far the scroll position is
60 _.bindAll( this, 'scroller' );
62 this.SearchView = options.SearchView ? options.SearchView : themes.view.Search;
63 // Bind to the scroll event and throttle
64 // the results from this.scroller
65 this.window.bind( 'scroll', _.throttle( this.scroller, 300 ) );
68 // Main render control
70 // Setup the main theme view
71 // with the current theme collection
72 this.view = new themes.view.Themes({
73 collection: this.collection,
77 // Render search form.
82 this.$el.empty().append( this.view.el ).addClass( 'rendered' );
83 this.$el.append( '<br class="clear"/>' );
86 // Defines search element container
87 searchContainer: $( '#wpbody h2:first' ),
89 // Search input and view
90 // for current theme collection
95 // Don't render the search if there is only one theme
96 if ( themes.data.themes.length === 1 ) {
100 view = new this.SearchView({
101 collection: self.collection,
105 // Render and append after screen title
108 .append( $.parseHTML( '<label class="screen-reader-text" for="wp-filter-search-input">' + l10n.search + '</label>' ) )
112 // Checks when the user gets close to the bottom
113 // of the mage and triggers a theme:scroll event
114 scroller: function() {
118 bottom = this.window.scrollTop() + self.window.height();
119 threshold = self.$el.offset().top + self.$el.outerHeight( false ) - self.window.height();
120 threshold = Math.round( threshold * 0.9 );
122 if ( bottom > threshold ) {
123 this.trigger( 'theme:scroll' );
128 // Set up the Collection for our theme data
129 // @has 'id' 'name' 'screenshot' 'author' 'authorURI' 'version' 'active' ...
130 themes.Collection = Backbone.Collection.extend({
137 // Controls searching on the current theme collection
138 // and triggers an update event
139 doSearch: function( value ) {
141 // Don't do anything if we've already done this search
142 // Useful because the Search handler fires multiple times per keystroke
143 if ( this.terms === value ) {
147 // Updates terms with the value passed
150 // If we have terms, run a search...
151 if ( this.terms.length > 0 ) {
152 this.search( this.terms );
155 // If search is blank, show all themes
156 // Useful for resetting the views when you clean the input
157 if ( this.terms === '' ) {
158 this.reset( themes.data.themes );
159 $( 'body' ).removeClass( 'no-results' );
162 // Trigger an 'update' event
163 this.trigger( 'update' );
166 // Performs a search within the collection
168 search: function( term ) {
169 var match, results, haystack, name, description, author;
171 // Start with a full collection
172 this.reset( themes.data.themes, { silent: true } );
174 // Escape the term string for RegExp meta characters
175 term = term.replace( /[-\/\\^$*+?.()|[\]{}]/g, '\\$&' );
177 // Consider spaces as word delimiters and match the whole string
178 // so matching terms can be combined
179 term = term.replace( / /g, ')(?=.*' );
180 match = new RegExp( '^(?=.*' + term + ').+', 'i' );
183 // _.filter and .test
184 results = this.filter( function( data ) {
185 name = data.get( 'name' ).replace( /(<([^>]+)>)/ig, '' );
186 description = data.get( 'description' ).replace( /(<([^>]+)>)/ig, '' );
187 author = data.get( 'author' ).replace( /(<([^>]+)>)/ig, '' );
189 haystack = _.union( name, data.get( 'id' ), description, author, data.get( 'tags' ) );
191 if ( match.test( data.get( 'author' ) ) && term.length > 2 ) {
192 data.set( 'displayAuthor', true );
195 return match.test( haystack );
198 if ( results.length === 0 ) {
199 this.trigger( 'query:empty' );
201 $( 'body' ).removeClass( 'no-results' );
204 this.reset( results );
207 // Paginates the collection with a helper method
208 // that slices the collection
209 paginate: function( instance ) {
210 var collection = this;
211 instance = instance || 0;
213 // Themes per instance are set at 20
214 collection = _( collection.rest( 20 * instance ) );
215 collection = _( collection.first( 20 ) );
222 // Handles requests for more themes
223 // and caches results
225 // When we are missing a cache object we fire an apiCall()
226 // which triggers events of `query:success` or `query:fail`
227 query: function( request ) {
232 var queries = this.queries,
234 query, isPaginated, count;
236 // Store current query request args
237 // for later use with the event `theme:end`
238 this.currentQuery.request = request;
240 // Search the query cache for matches.
241 query = _.find( queries, function( query ) {
242 return _.isEqual( query.request, request );
245 // If the request matches the stored currentQuery.request
246 // it means we have a paginated request.
247 isPaginated = _.has( request, 'page' );
249 // Reset the internal api page counter for non paginated queries.
250 if ( ! isPaginated ) {
251 this.currentQuery.page = 1;
254 // Otherwise, send a new API call and add it to the cache.
255 if ( ! query && ! isPaginated ) {
256 query = this.apiCall( request ).done( function( data ) {
258 // Update the collection with the queried data.
260 self.reset( data.themes );
261 count = data.info.results;
262 // Store the results and the query request
263 queries.push( { themes: data.themes, request: request, total: count } );
266 // Trigger a collection refresh event
267 // and a `query:success` event with a `count` argument.
268 self.trigger( 'update' );
269 self.trigger( 'query:success', count );
271 if ( data.themes && data.themes.length === 0 ) {
272 self.trigger( 'query:empty' );
275 }).fail( function() {
276 self.trigger( 'query:fail' );
279 // If it's a paginated request we need to fetch more themes...
281 return this.apiCall( request, isPaginated ).done( function( data ) {
282 // Add the new themes to the current collection
283 // @todo update counter
284 self.add( data.themes );
285 self.trigger( 'query:success' );
287 // We are done loading themes for now.
288 self.loadingThemes = false;
290 }).fail( function() {
291 self.trigger( 'query:fail' );
295 if ( query.themes.length === 0 ) {
296 self.trigger( 'query:empty' );
298 $( 'body' ).removeClass( 'no-results' );
301 // Only trigger an update event since we already have the themes
302 // on our cached object
303 if ( _.isNumber( query.total ) ) {
304 this.count = query.total;
307 this.reset( query.themes );
308 if ( ! query.total ) {
309 this.count = this.length;
312 this.trigger( 'update' );
313 this.trigger( 'query:success', this.count );
317 // Local cache array for API queries
320 // Keep track of current query so we can handle pagination
326 // Send request to api.wordpress.org/themes
327 apiCall: function( request, paginated ) {
328 return wp.ajax.send( 'query-themes', {
347 beforeSend: function() {
350 $( 'body' ).addClass( 'loading-content' ).removeClass( 'no-results' );
356 // Static status controller for when we are loading themes.
360 // This is the view that controls each theme item
361 // that will be displayed on the screen
362 themes.view.Theme = wp.Backbone.View.extend({
364 // Wrap theme data on a div.theme element
367 // Reflects which theme view we have
368 // 'grid' (default) or 'detail'
371 // The HTML template for each element to be rendered
372 html: themes.template( 'theme' ),
375 'click': themes.isInstall ? 'preview': 'expand',
376 'keydown': themes.isInstall ? 'preview': 'expand',
377 'touchend': themes.isInstall ? 'preview': 'expand',
379 'touchmove': 'preventExpand'
385 var data = this.model.toJSON();
386 // Render themes using the html template
387 this.$el.html( this.html( data ) ).attr({
389 'aria-describedby' : data.id + '-action ' + data.id + '-name'
392 // Renders active theme styles
395 if ( this.model.get( 'displayAuthor' ) ) {
396 this.$el.addClass( 'display-author' );
399 if ( this.model.get( 'installed' ) ) {
400 this.$el.addClass( 'is-installed' );
404 // Adds a class to the currently active theme
405 // and to the overlay in detailed view mode
406 activeTheme: function() {
407 if ( this.model.get( 'active' ) ) {
408 this.$el.addClass( 'active' );
412 // Add class of focus to the theme we are focused on.
413 addFocus: function() {
414 var $themeToFocus = ( $( ':focus' ).hasClass( 'theme' ) ) ? $( ':focus' ) : $(':focus').parents('.theme');
416 $('.theme.focus').removeClass('focus');
417 $themeToFocus.addClass('focus');
420 // Single theme overlay screen
421 // It's shown when clicking a theme
422 expand: function( event ) {
425 event = event || window.event;
427 // 'enter' and 'space' keys expand the details view when a theme is :focused
428 if ( event.type === 'keydown' && ( event.which !== 13 && event.which !== 32 ) ) {
432 // Bail if the user scrolled on a touch device
433 if ( this.touchDrag === true ) {
434 return this.touchDrag = false;
437 // Prevent the modal from showing when the user clicks
438 // one of the direct action buttons
439 if ( $( event.target ).is( '.theme-actions a' ) ) {
443 // Set focused theme to current element
444 themes.focusedTheme = this.$el;
446 this.trigger( 'theme:expand', self.model.cid );
449 preventExpand: function() {
450 this.touchDrag = true;
453 preview: function( event ) {
457 // Bail if the user scrolled on a touch device
458 if ( this.touchDrag === true ) {
459 return this.touchDrag = false;
462 // Allow direct link path to installing a theme.
463 if ( $( event.target ).hasClass( 'button-primary' ) ) {
467 // 'enter' and 'space' keys expand the details view when a theme is :focused
468 if ( event.type === 'keydown' && ( event.which !== 13 && event.which !== 32 ) ) {
472 // pressing enter while focused on the buttons shouldn't open the preview
473 if ( event.type === 'keydown' && event.which !== 13 && $( ':focus' ).hasClass( 'button' ) ) {
477 event.preventDefault();
479 event = event || window.event;
481 // Set focus to current theme.
482 themes.focusedTheme = this.$el;
484 // Construct a new Preview view.
485 preview = new themes.view.Preview({
489 // Render the view and append it.
491 this.setNavButtonsState();
493 // Hide previous/next navigation if there is only one theme
494 if ( this.model.collection.length === 1 ) {
495 preview.$el.addClass( 'no-navigation' );
497 preview.$el.removeClass( 'no-navigation' );
501 $( 'div.wrap' ).append( preview.el );
503 // Listen to our preview object
504 // for `theme:next` and `theme:previous` events.
505 this.listenTo( preview, 'theme:next', function() {
507 // Keep local track of current theme model.
508 current = self.model;
510 // If we have ventured away from current model update the current model position.
511 if ( ! _.isUndefined( self.current ) ) {
512 current = self.current;
515 // Get next theme model.
516 self.current = self.model.collection.at( self.model.collection.indexOf( current ) + 1 );
518 // If we have no more themes, bail.
519 if ( _.isUndefined( self.current ) ) {
520 self.options.parent.parent.trigger( 'theme:end' );
521 return self.current = current;
524 preview.model = self.current;
526 // Render and append.
528 this.setNavButtonsState();
529 $( '.next-theme' ).focus();
531 .listenTo( preview, 'theme:previous', function() {
533 // Keep track of current theme model.
534 current = self.model;
536 // Bail early if we are at the beginning of the collection
537 if ( self.model.collection.indexOf( self.current ) === 0 ) {
541 // If we have ventured away from current model update the current model position.
542 if ( ! _.isUndefined( self.current ) ) {
543 current = self.current;
546 // Get previous theme model.
547 self.current = self.model.collection.at( self.model.collection.indexOf( current ) - 1 );
549 // If we have no more themes, bail.
550 if ( _.isUndefined( self.current ) ) {
554 preview.model = self.current;
556 // Render and append.
558 this.setNavButtonsState();
559 $( '.previous-theme' ).focus();
562 this.listenTo( preview, 'preview:close', function() {
563 self.current = self.model;
567 // Handles .disabled classes for previous/next buttons in theme installer preview
568 setNavButtonsState: function() {
569 var $themeInstaller = $( '.theme-install-overlay' ),
570 current = _.isUndefined( this.current ) ? this.model : this.current;
572 // Disable previous at the zero position
573 if ( 0 === this.model.collection.indexOf( current ) ) {
574 $themeInstaller.find( '.previous-theme' ).addClass( 'disabled' );
577 // Disable next if the next model is undefined
578 if ( _.isUndefined( this.model.collection.at( this.model.collection.indexOf( current ) + 1 ) ) ) {
579 $themeInstaller.find( '.next-theme' ).addClass( 'disabled' );
584 // Theme Details view
585 // Set ups a modal overlay with the expanded theme data
586 themes.view.Details = wp.Backbone.View.extend({
588 // Wrap theme data on a div.theme element
589 className: 'theme-overlay',
593 'click .delete-theme': 'deleteTheme',
594 'click .left': 'previousTheme',
595 'click .right': 'nextTheme'
598 // The HTML template for the theme overlay
599 html: themes.template( 'theme-single' ),
602 var data = this.model.toJSON();
603 this.$el.html( this.html( data ) );
604 // Renders active theme styles
606 // Set up navigation events
608 // Checks screenshot size
609 this.screenshotCheck( this.$el );
610 // Contain "tabbing" inside the overlay
611 this.containFocus( this.$el );
614 // Adds a class to the currently active theme
615 // and to the overlay in detailed view mode
616 activeTheme: function() {
617 // Check the model has the active property
618 this.$el.toggleClass( 'active', this.model.get( 'active' ) );
621 // Keeps :focus within the theme details elements
622 containFocus: function( $el ) {
625 // Move focus to the primary action
626 _.delay( function() {
627 $( '.theme-wrap a.button-primary:visible' ).focus();
630 $el.on( 'keydown.wp-themes', function( event ) {
633 if ( event.which === 9 ) {
634 $target = $( event.target );
636 // Keep focus within the overlay by making the last link on theme actions
637 // switch focus to button.left on tabbing and vice versa
638 if ( $target.is( 'button.left' ) && event.shiftKey ) {
639 $el.find( '.theme-actions a:last-child' ).focus();
640 event.preventDefault();
641 } else if ( $target.is( '.theme-actions a:last-child' ) ) {
642 $el.find( 'button.left' ).focus();
643 event.preventDefault();
649 // Single theme overlay screen
650 // It's shown when clicking a theme
651 collapse: function( event ) {
655 event = event || window.event;
657 // Prevent collapsing detailed view when there is only one theme available
658 if ( themes.data.themes.length === 1 ) {
662 // Detect if the click is inside the overlay
663 // and don't close it unless the target was
664 // the div.back button
665 if ( $( event.target ).is( '.theme-backdrop' ) || $( event.target ).is( '.close' ) || event.keyCode === 27 ) {
667 // Add a temporary closing class while overlay fades out
668 $( 'body' ).addClass( 'closing-overlay' );
670 // With a quick fade out animation
671 this.$el.fadeOut( 130, function() {
672 // Clicking outside the modal box closes the overlay
673 $( 'body' ).removeClass( 'closing-overlay' );
674 // Handle event cleanup
677 // Get scroll position to avoid jumping to the top
678 scroll = document.body.scrollTop;
680 // Clean the url structure
681 themes.router.navigate( themes.router.baseUrl( '' ) );
683 // Restore scroll position
684 document.body.scrollTop = scroll;
686 // Return focus to the theme div
687 if ( themes.focusedTheme ) {
688 themes.focusedTheme.focus();
694 // Handles .disabled classes for next/previous buttons
695 navigation: function() {
697 // Disable Left/Right when at the start or end of the collection
698 if ( this.model.cid === this.model.collection.at(0).cid ) {
699 this.$el.find( '.left' ).addClass( 'disabled' );
701 if ( this.model.cid === this.model.collection.at( this.model.collection.length - 1 ).cid ) {
702 this.$el.find( '.right' ).addClass( 'disabled' );
706 // Performs the actions to effectively close
707 // the theme details overlay
708 closeOverlay: function() {
709 $( 'body' ).removeClass( 'modal-open' );
712 this.trigger( 'theme:collapse' );
715 // Confirmation dialog for deleting a theme
716 deleteTheme: function() {
717 return confirm( themes.data.settings.confirmDelete );
720 nextTheme: function() {
722 self.trigger( 'theme:next', self.model.cid );
726 previousTheme: function() {
728 self.trigger( 'theme:previous', self.model.cid );
732 // Checks if the theme screenshot is the old 300px width version
733 // and adds a corresponding class if it's true
734 screenshotCheck: function( el ) {
735 var screenshot, image;
737 screenshot = el.find( '.screenshot img' );
739 image.src = screenshot.attr( 'src' );
742 if ( image.width && image.width <= 300 ) {
743 el.addClass( 'small-screenshot' );
748 // Theme Preview view
749 // Set ups a modal overlay with the expanded theme data
750 themes.view.Preview = themes.view.Details.extend({
752 className: 'wp-full-overlay expanded',
753 el: '.theme-install-overlay',
756 'click .close-full-overlay': 'close',
757 'click .collapse-sidebar': 'collapse',
758 'click .previous-theme': 'previousTheme',
759 'click .next-theme': 'nextTheme',
763 // The HTML template for the theme preview
764 html: themes.template( 'theme-preview' ),
767 var data = this.model.toJSON();
769 this.$el.html( this.html( data ) );
771 themes.router.navigate( themes.router.baseUrl( themes.router.themePath + this.model.get( 'id' ) ), { replace: true } );
773 this.$el.fadeIn( 200, function() {
774 $( 'body' ).addClass( 'theme-installer-active full-overlay-active' );
775 $( '.close-full-overlay' ).focus();
780 this.$el.fadeOut( 200, function() {
781 $( 'body' ).removeClass( 'theme-installer-active full-overlay-active' );
783 // Return focus to the theme div
784 if ( themes.focusedTheme ) {
785 themes.focusedTheme.focus();
789 themes.router.navigate( themes.router.baseUrl( '' ) );
790 this.trigger( 'preview:close' );
791 this.undelegateEvents();
796 collapse: function() {
798 this.$el.toggleClass( 'collapsed' ).toggleClass( 'expanded' );
802 keyEvent: function( event ) {
803 // The escape key closes the preview
804 if ( event.keyCode === 27 ) {
805 this.undelegateEvents();
808 // The right arrow key, next theme
809 if ( event.keyCode === 39 ) {
810 _.once( this.nextTheme() );
813 // The left arrow key, previous theme
814 if ( event.keyCode === 37 ) {
815 this.previousTheme();
820 // Controls the rendering of div.themes,
821 // a wrapper that will hold all the theme elements
822 themes.view.Themes = wp.Backbone.View.extend({
825 $overlay: $( 'div.theme-overlay' ),
827 // Number to keep track of scroll position
828 // while in theme-overlay mode
831 // The theme count element
832 count: $( '.wp-core-ui .theme-count' ),
834 // The live themes count
837 initialize: function( options ) {
841 this.parent = options.parent;
843 // Set current view to [grid]
844 this.setView( 'grid' );
846 // Move the active theme to the beginning of the collection
849 // When the collection is updated by user input...
850 this.listenTo( self.collection, 'update', function() {
851 self.parent.page = 0;
856 // Update theme count to full result set when available.
857 this.listenTo( self.collection, 'query:success', function( count ) {
858 if ( _.isNumber( count ) ) {
859 self.count.text( count );
860 self.announceSearchResults( count );
862 self.count.text( self.collection.length );
863 self.announceSearchResults( self.collection.length );
867 this.listenTo( self.collection, 'query:empty', function() {
868 $( 'body' ).addClass( 'no-results' );
871 this.listenTo( this.parent, 'theme:scroll', function() {
872 self.renderThemes( self.parent.page );
875 this.listenTo( this.parent, 'theme:close', function() {
876 if ( self.overlay ) {
877 self.overlay.closeOverlay();
881 // Bind keyboard events.
882 $( 'body' ).on( 'keyup', function( event ) {
883 if ( ! self.overlay ) {
887 // Pressing the right arrow key fires a theme:next event
888 if ( event.keyCode === 39 ) {
889 self.overlay.nextTheme();
892 // Pressing the left arrow key fires a theme:previous event
893 if ( event.keyCode === 37 ) {
894 self.overlay.previousTheme();
897 // Pressing the escape key fires a theme:collapse event
898 if ( event.keyCode === 27 ) {
899 self.overlay.collapse( event );
904 // Manages rendering of theme pages
905 // and keeping theme count in sync
907 // Clear the DOM, please
910 // If the user doesn't have switch capabilities
911 // or there is only one theme in the collection
912 // render the detailed view of the active theme
913 if ( themes.data.themes.length === 1 ) {
915 // Constructs the view
916 this.singleTheme = new themes.view.Details({
917 model: this.collection.models[0]
920 // Render and apply a 'single-theme' class to our container
921 this.singleTheme.render();
922 this.$el.addClass( 'single-theme' );
923 this.$el.append( this.singleTheme.el );
926 // Generate the themes
927 // Using page instance
928 // While checking the collection has items
929 if ( this.options.collection.size() > 0 ) {
930 this.renderThemes( this.parent.page );
933 // Display a live theme count for the collection
934 this.liveThemeCount = this.collection.count ? this.collection.count : this.collection.length;
935 this.count.text( this.liveThemeCount );
937 this.announceSearchResults( this.liveThemeCount );
940 // Iterates through each instance of the collection
941 // and renders each theme module
942 renderThemes: function( page ) {
945 self.instance = self.collection.paginate( page );
947 // If we have no more themes bail
948 if ( self.instance.size() === 0 ) {
949 // Fire a no-more-themes event.
950 this.parent.trigger( 'theme:end' );
954 // Make sure the add-new stays at the end
956 $( '.add-new-theme' ).remove();
959 // Loop through the themes and setup each theme view
960 self.instance.each( function( theme ) {
961 self.theme = new themes.view.Theme({
966 // Render the views...
968 // and append them to div.themes
969 self.$el.append( self.theme.el );
971 // Binds to theme:expand to show the modal box
972 // with the theme details
973 self.listenTo( self.theme, 'theme:expand', self.expand, self );
976 // 'Add new theme' element shown at the end of the grid
977 if ( themes.data.settings.canInstall ) {
978 this.$el.append( '<div class="theme add-new-theme"><a href="' + themes.data.settings.installURI + '"><div class="theme-screenshot"><span></span></div><h3 class="theme-name">' + l10n.addNew + '</h3></a></div>' );
984 // Grabs current theme and puts it at the beginning of the collection
985 currentTheme: function() {
989 current = self.collection.findWhere({ active: true });
991 // Move the active theme to the beginning of the collection
993 self.collection.remove( current );
994 self.collection.add( current, { at:0 } );
999 setView: function( view ) {
1003 // Renders the overlay with the ThemeDetails view
1004 // Uses the current model data
1005 expand: function( id ) {
1008 // Set the current theme model
1009 this.model = self.collection.get( id );
1011 // Trigger a route update for the current model
1012 themes.router.navigate( themes.router.baseUrl( themes.router.themePath + this.model.id ) );
1014 // Sets this.view to 'detail'
1015 this.setView( 'detail' );
1016 $( 'body' ).addClass( 'modal-open' );
1018 // Set up the theme details view
1019 this.overlay = new themes.view.Details({
1023 this.overlay.render();
1024 this.$overlay.html( this.overlay.el );
1026 // Bind to theme:next and theme:previous
1027 // triggered by the arrow keys
1029 // Keep track of the current model so we
1030 // can infer an index position
1031 this.listenTo( this.overlay, 'theme:next', function() {
1032 // Renders the next theme on the overlay
1033 self.next( [ self.model.cid ] );
1036 .listenTo( this.overlay, 'theme:previous', function() {
1037 // Renders the previous theme on the overlay
1038 self.previous( [ self.model.cid ] );
1042 // This method renders the next theme on the overlay modal
1043 // based on the current position in the collection
1044 // @params [model cid]
1045 next: function( args ) {
1049 // Get the current theme
1050 model = self.collection.get( args[0] );
1051 // Find the next model within the collection
1052 nextModel = self.collection.at( self.collection.indexOf( model ) + 1 );
1054 // Sanity check which also serves as a boundary test
1055 if ( nextModel !== undefined ) {
1057 // We have a new theme...
1058 // Close the overlay
1059 this.overlay.closeOverlay();
1061 // Trigger a route update for the current model
1062 self.theme.trigger( 'theme:expand', nextModel.cid );
1067 // This method renders the previous theme on the overlay modal
1068 // based on the current position in the collection
1069 // @params [model cid]
1070 previous: function( args ) {
1072 model, previousModel;
1074 // Get the current theme
1075 model = self.collection.get( args[0] );
1076 // Find the previous model within the collection
1077 previousModel = self.collection.at( self.collection.indexOf( model ) - 1 );
1079 if ( previousModel !== undefined ) {
1081 // We have a new theme...
1082 // Close the overlay
1083 this.overlay.closeOverlay();
1085 // Trigger a route update for the current model
1086 self.theme.trigger( 'theme:expand', previousModel.cid );
1091 // Dispatch audible search results feedback message
1092 announceSearchResults: function( count ) {
1093 if ( 0 === count ) {
1094 wp.a11y.speak( l10n.noThemesFound );
1096 wp.a11y.speak( l10n.themesFound.replace( '%d', count ) );
1101 // Search input view controller.
1102 themes.view.Search = wp.Backbone.View.extend({
1105 className: 'wp-filter-search',
1106 id: 'wp-filter-search-input',
1110 placeholder: l10n.searchPlaceholder,
1112 'aria-describedby': 'live-search-desc'
1121 initialize: function( options ) {
1123 this.parent = options.parent;
1125 this.listenTo( this.parent, 'theme:close', function() {
1126 this.searching = false;
1131 search: function( event ) {
1133 if ( event.type === 'keyup' && event.which === 27 ) {
1134 event.target.value = '';
1138 * Since doSearch is debounced, it will only run when user input comes to a rest
1140 this.doSearch( event );
1143 // Runs a search on the theme collection.
1144 doSearch: _.debounce( function( event ) {
1147 this.collection.doSearch( event.target.value );
1149 // if search is initiated and key is not return
1150 if ( this.searching && event.which !== 13 ) {
1151 options.replace = true;
1153 this.searching = true;
1156 // Update the URL hash
1157 if ( event.target.value ) {
1158 themes.router.navigate( themes.router.baseUrl( themes.router.searchPath + event.target.value ), options );
1160 themes.router.navigate( themes.router.baseUrl( '' ) );
1164 pushState: function( event ) {
1165 var url = themes.router.baseUrl( '' );
1167 if ( event.target.value ) {
1168 url = themes.router.baseUrl( themes.router.searchPath + event.target.value );
1171 this.searching = false;
1172 themes.router.navigate( url );
1177 // Sets up the routes events for relevant url queries
1178 // Listens to [theme] and [search] params
1179 themes.Router = Backbone.Router.extend({
1182 'themes.php?theme=:slug': 'theme',
1183 'themes.php?search=:query': 'search',
1184 'themes.php?s=:query': 'search',
1185 'themes.php': 'themes',
1189 baseUrl: function( url ) {
1190 return 'themes.php' + url;
1193 themePath: '?theme=',
1194 searchPath: '?search=',
1196 search: function( query ) {
1197 $( '.wp-filter-search' ).val( query );
1200 themes: function() {
1201 $( '.wp-filter-search' ).val( '' );
1204 navigate: function() {
1205 if ( Backbone.history._hasPushState ) {
1206 Backbone.Router.prototype.navigate.apply( this, arguments );
1212 // Execute and setup the application
1215 // Initializes the blog's theme library view
1216 // Create a new collection with data
1217 this.themes = new themes.Collection( themes.data.themes );
1220 this.view = new themes.view.Appearance({
1221 collection: this.themes
1227 render: function() {
1233 Backbone.history.start({
1234 root: themes.data.settings.adminUrl,
1240 routes: function() {
1242 // Bind to our global thx object
1243 // so that the object is available to sub-views
1244 themes.router = new themes.Router();
1246 // Handles theme details route event
1247 themes.router.on( 'route:theme', function( slug ) {
1248 self.view.view.expand( slug );
1251 themes.router.on( 'route:themes', function() {
1252 self.themes.doSearch( '' );
1253 self.view.trigger( 'theme:close' );
1256 // Handles search route event
1257 themes.router.on( 'route:search', function() {
1258 $( '.wp-filter-search' ).trigger( 'keyup' );
1264 extraRoutes: function() {
1269 // Extend the main Search view
1270 themes.view.InstallerSearch = themes.view.Search.extend({
1277 // Handles Ajax request for searching through themes in public repo
1278 search: function( event ) {
1280 // Tabbing or reverse tabbing into the search input shouldn't trigger a search
1281 if ( event.type === 'keyup' && ( event.which === 9 || event.which === 16 ) ) {
1285 this.collection = this.options.parent.view.collection;
1288 if ( event.type === 'keyup' && event.which === 27 ) {
1289 event.target.value = '';
1292 this.doSearch( event.target.value );
1295 doSearch: _.debounce( function( value ) {
1298 request.search = value;
1300 // Intercept an [author] search.
1302 // If input value starts with `author:` send a request
1303 // for `author` instead of a regular `search`
1304 if ( value.substring( 0, 7 ) === 'author:' ) {
1305 request.search = '';
1306 request.author = value.slice( 7 );
1309 // Intercept a [tag] search.
1311 // If input value starts with `tag:` send a request
1312 // for `tag` instead of a regular `search`
1313 if ( value.substring( 0, 4 ) === 'tag:' ) {
1314 request.search = '';
1315 request.tag = [ value.slice( 4 ) ];
1318 $( '.filter-links li > a.current' ).removeClass( 'current' );
1319 $( 'body' ).removeClass( 'show-filters filters-applied' );
1321 // Get the themes by sending Ajax POST request to api.wordpress.org/themes
1322 // or searching the local cache
1323 this.collection.query( request );
1326 themes.router.navigate( themes.router.baseUrl( themes.router.searchPath + value ), { replace: true } );
1330 themes.view.Installer = themes.view.Appearance.extend({
1332 el: '#wpbody-content .wrap',
1334 // Register events for sorting and filters in theme-navigation
1336 'click .filter-links li > a': 'onSort',
1337 'click .theme-filter': 'onFilter',
1338 'click .drawer-toggle': 'moreFilters',
1339 'click .filter-drawer .apply-filters': 'applyFilters',
1340 'click .filter-group [type="checkbox"]': 'addFilter',
1341 'click .filter-drawer .clear-filters': 'clearFilters',
1342 'click .filtered-by': 'backToFilters'
1345 // Initial render method
1346 render: function() {
1352 this.collection = new themes.Collection();
1354 // Bump `collection.currentQuery.page` and request more themes if we hit the end of the page.
1355 this.listenTo( this, 'theme:end', function() {
1357 // Make sure we are not already loading
1358 if ( self.collection.loadingThemes ) {
1362 // Set loadingThemes to true and bump page instance of currentQuery.
1363 self.collection.loadingThemes = true;
1364 self.collection.currentQuery.page++;
1366 // Use currentQuery.page to build the themes request.
1367 _.extend( self.collection.currentQuery.request, { page: self.collection.currentQuery.page } );
1368 self.collection.query( self.collection.currentQuery.request );
1371 this.listenTo( this.collection, 'query:success', function() {
1372 $( 'body' ).removeClass( 'loading-content' );
1373 $( '.theme-browser' ).find( 'div.error' ).remove();
1376 this.listenTo( this.collection, 'query:fail', function() {
1377 $( 'body' ).removeClass( 'loading-content' );
1378 $( '.theme-browser' ).find( 'div.error' ).remove();
1379 $( '.theme-browser' ).find( 'div.themes' ).before( '<div class="error"><p>' + l10n.error + '</p></div>' );
1386 // Set ups the view and passes the section argument
1387 this.view = new themes.view.Themes({
1388 collection: this.collection,
1392 // Reset pagination every time the install view handler is run
1395 // Render and append
1396 this.$el.find( '.themes' ).remove();
1398 this.$el.find( '.theme-browser' ).append( this.view.el ).addClass( 'rendered' );
1401 // Handles all the rendering of the public theme directory
1402 browse: function( section ) {
1403 // Create a new collection with the proper theme data
1405 this.collection.query( { browse: section } );
1408 // Sorting navigation
1409 onSort: function( event ) {
1410 var $el = $( event.target ),
1411 sort = $el.data( 'sort' );
1413 event.preventDefault();
1415 $( 'body' ).removeClass( 'filters-applied show-filters' );
1417 // Bail if this is already active
1418 if ( $el.hasClass( this.activeClass ) ) {
1424 // Trigger a router.naviagte update
1425 themes.router.navigate( themes.router.baseUrl( themes.router.browsePath + sort ) );
1428 sort: function( sort ) {
1431 $( '.filter-links li > a, .theme-filter' ).removeClass( this.activeClass );
1432 $( '[data-sort="' + sort + '"]' ).addClass( this.activeClass );
1434 this.browse( sort );
1438 onFilter: function( event ) {
1440 $el = $( event.target ),
1441 filter = $el.data( 'filter' );
1443 // Bail if this is already active
1444 if ( $el.hasClass( this.activeClass ) ) {
1448 $( '.filter-links li > a, .theme-section' ).removeClass( this.activeClass );
1449 $el.addClass( this.activeClass );
1455 // Construct the filter request
1456 // using the default values
1457 filter = _.union( filter, this.filtersChecked() );
1458 request = { tag: [ filter ] };
1460 // Get the themes by sending Ajax POST request to api.wordpress.org/themes
1461 // or searching the local cache
1462 this.collection.query( request );
1465 // Clicking on a checkbox to add another filter to the request
1466 addFilter: function() {
1467 this.filtersChecked();
1470 // Applying filters triggers a tag request
1471 applyFilters: function( event ) {
1473 tags = this.filtersChecked(),
1474 request = { tag: tags },
1475 filteringBy = $( '.filtered-by .tags' );
1478 event.preventDefault();
1481 $( 'body' ).addClass( 'filters-applied' );
1482 $( '.filter-links li > a.current' ).removeClass( 'current' );
1483 filteringBy.empty();
1485 _.each( tags, function( tag ) {
1486 name = $( 'label[for="filter-id-' + tag + '"]' ).text();
1487 filteringBy.append( '<span class="tag">' + name + '</span>' );
1490 // Get the themes by sending Ajax POST request to api.wordpress.org/themes
1491 // or searching the local cache
1492 this.collection.query( request );
1495 // Get the checked filters
1496 // @return {array} of tags or false
1497 filtersChecked: function() {
1498 var items = $( '.filter-group' ).find( ':checkbox' ),
1501 _.each( items.filter( ':checked' ), function( item ) {
1502 tags.push( $( item ).prop( 'value' ) );
1505 // When no filters are checked, restore initial state and return
1506 if ( tags.length === 0 ) {
1507 $( '.filter-drawer .apply-filters' ).find( 'span' ).text( '' );
1508 $( '.filter-drawer .clear-filters' ).hide();
1509 $( 'body' ).removeClass( 'filters-applied' );
1513 $( '.filter-drawer .apply-filters' ).find( 'span' ).text( tags.length );
1514 $( '.filter-drawer .clear-filters' ).css( 'display', 'inline-block' );
1519 activeClass: 'current',
1521 // Overwrite search container class to append search
1523 searchContainer: $( '.wp-filter .search-form' ),
1525 uploader: function() {
1526 $( 'a.upload' ).on( 'click', function( event ) {
1527 event.preventDefault();
1528 $( 'body' ).addClass( 'show-upload-theme' );
1529 themes.router.navigate( themes.router.baseUrl( '?upload' ), { replace: true } );
1531 $( 'a.browse-themes' ).on( 'click', function( event ) {
1532 event.preventDefault();
1533 $( 'body' ).removeClass( 'show-upload-theme' );
1534 themes.router.navigate( themes.router.baseUrl( '' ), { replace: true } );
1538 // Toggle the full filters navigation
1539 moreFilters: function( event ) {
1540 event.preventDefault();
1542 if ( $( 'body' ).hasClass( 'filters-applied' ) ) {
1543 return this.backToFilters();
1546 // If the filters section is opened and filters are checked
1547 // run the relevant query collapsing to filtered-by state
1548 if ( $( 'body' ).hasClass( 'show-filters' ) && this.filtersChecked() ) {
1549 return this.addFilter();
1554 themes.router.navigate( themes.router.baseUrl( '' ) );
1555 $( 'body' ).toggleClass( 'show-filters' );
1558 // Clears all the checked filters
1559 // @uses filtersChecked()
1560 clearFilters: function( event ) {
1561 var items = $( '.filter-group' ).find( ':checkbox' ),
1564 event.preventDefault();
1566 _.each( items.filter( ':checked' ), function( item ) {
1567 $( item ).prop( 'checked', false );
1568 return self.filtersChecked();
1572 backToFilters: function( event ) {
1574 event.preventDefault();
1577 $( 'body' ).removeClass( 'filters-applied' );
1580 clearSearch: function() {
1581 $( '#wp-filter-search-input').val( '' );
1585 themes.InstallerRouter = Backbone.Router.extend({
1587 'theme-install.php?theme=:slug': 'preview',
1588 'theme-install.php?browse=:sort': 'sort',
1589 'theme-install.php?upload': 'upload',
1590 'theme-install.php?search=:query': 'search',
1591 'theme-install.php': 'sort'
1594 baseUrl: function( url ) {
1595 return 'theme-install.php' + url;
1598 themePath: '?theme=',
1599 browsePath: '?browse=',
1600 searchPath: '?search=',
1602 search: function( query ) {
1603 $( '.wp-filter-search' ).val( query );
1606 navigate: function() {
1607 if ( Backbone.history._hasPushState ) {
1608 Backbone.Router.prototype.navigate.apply( this, arguments );
1614 themes.RunInstaller = {
1618 // Passes the default 'section' as an option
1619 this.view = new themes.view.Installer({
1620 section: 'featured',
1621 SearchView: themes.view.InstallerSearch
1629 render: function() {
1635 Backbone.history.start({
1636 root: themes.data.settings.adminUrl,
1642 routes: function() {
1646 // Bind to our global `wp.themes` object
1647 // so that the router is available to sub-views
1648 themes.router = new themes.InstallerRouter();
1650 // Handles `theme` route event
1651 // Queries the API for the passed theme slug
1652 themes.router.on( 'route:preview', function( slug ) {
1653 request.theme = slug;
1654 self.view.collection.query( request );
1657 // Handles sorting / browsing routes
1658 // Also handles the root URL triggering a sort request
1659 // for `featured`, the default view
1660 themes.router.on( 'route:sort', function( sort ) {
1664 self.view.sort( sort );
1665 self.view.trigger( 'theme:close' );
1668 // Support the `upload` route by going straight to upload section
1669 themes.router.on( 'route:upload', function() {
1670 $( 'a.upload' ).trigger( 'click' );
1673 // The `search` route event. The router populates the input field.
1674 themes.router.on( 'route:search', function() {
1675 $( '.wp-filter-search' ).focus().trigger( 'keyup' );
1681 extraRoutes: function() {
1687 $( document ).ready(function() {
1688 if ( themes.isInstall ) {
1689 themes.RunInstaller.init();
1694 $( '.broken-themes .delete-theme' ).on( 'click', function() {
1695 return confirm( _wpThemeSettings.settings.confirmDelete );
1701 // Align theme browser thickbox
1703 jQuery(document).ready( function($) {
1704 tb_position = function() {
1705 var tbWindow = $('#TB_window'),
1706 width = $(window).width(),
1707 H = $(window).height(),
1708 W = ( 1040 < width ) ? 1040 : width,
1709 adminbar_height = 0;
1711 if ( $('#wpadminbar').length ) {
1712 adminbar_height = parseInt( $('#wpadminbar').css('height'), 10 );
1715 if ( tbWindow.size() ) {
1716 tbWindow.width( W - 50 ).height( H - 45 - adminbar_height );
1717 $('#TB_iframeContent').width( W - 50 ).height( H - 75 - adminbar_height );
1718 tbWindow.css({'margin-left': '-' + parseInt( ( ( W - 50 ) / 2 ), 10 ) + 'px'});
1719 if ( typeof document.body.style.maxWidth !== 'undefined' ) {
1720 tbWindow.css({'top': 20 + adminbar_height + 'px', 'margin-top': '0'});
1725 $(window).resize(function(){ tb_position(); });