Ticket #30193: 30193.2.diff

src/wp-includes/js/media-views.js

@@ -631 +631 @@
         /**
          * A state for choosing an attachment from the media library.
          *
-         * @constructor
+         * @class
          * @augments wp.media.controller.State
          * @augments Backbone.Model
+         *
+         * @param {object}         [options]                         The options hash passed to the state.
+         * @param {string}         [options.id=library]              Unique identifier.
+         * @param {string}         [options.title=Media library]     Unused.
+         * @param {boolean}        [options.multiple=false]          Whether multi-select is enabled.
+         * @param {string}         [options.content=upload]          Initial mode for the content region.
+         * @param {string}         [options.menu=default]            Initial mode for the menu region.
+         * @param {string}         [options.router=browse]           Initial mode for the router region.
+         * @param {string}         [options.toolbar=select]          Initial mode for the toolbar region.
+         * @param {boolean}        [options.searchable=true]         Whether the library is searchable.
+         * @param {boolean|string} [options.filterable=false]        Whether the library is filterable, and if so what filters should be shown.
+         *                                                           Accepts 'all', 'uploaded', or 'unattached'.
+         * @param {boolean}        [options.sortable=true]           Whether the Attachments view should be sortable when orderby property is menuOrder on the collection.
+         * @param {boolean}        [options.autoSelect=true]         Whether an uploaded attachment should be automatically added to the selection.
+         * @param {boolean}        [options.contentUserSetting=true] Whether the content region's mode should be set and persisted per user.
+         * @param {boolean}        [options.syncSelection=true]      Whether the Attachments selection should be persisted from the last state.
          */
         media.controller.Library = media.controller.State.extend({
                 defaults: {
                         id:                 'library',
                         title:              l10n.mediaLibraryTitle,
-                        // Selection defaults. @see media.model.Selection
                         multiple:           false,
-                        // Initial region modes.
                         content:            'upload',
                         menu:               'default',
                         router:             'browse',
                         toolbar:            'select',
-                        // Attachments browser defaults. @see media.view.AttachmentsBrowser
                         searchable:         true,
                         filterable:         false,
                         sortable:           true,
-
                         autoSelect:         true,
                         describe:           false,
-                        // Uses a user setting to override the content mode.
                         contentUserSetting: true,
-                        // Sync the selection from the last state when 'multiple' matches.
                         syncSelection:      true
                 },