Changeset 61447

Timestamp:

01/06/2026 11:56:12 PM (3 months ago)

Author:

SergeyBiryukov

Message:

Docs: Clarify multi-select behavior in CollectionAdd and GalleryAdd controllers.

Follow-up to [30120], [31373].

Props yogeshbhutkar, mikachan, luigipulcini, SergeyBiryukov.
Fixes #62696.

Location:

trunk/src/js/media/controllers

Files:

• collection-add.js (modified) (1 diff)
• gallery-add.js (modified) (1 diff)

trunk/src/js/media/controllers/collection-add.js

@@ -18 +18 @@
  * @param {string}                     [attributes.id=library]              Unique identifier.
  * @param {string}                     attributes.title                     Title for the state. Displays in the frame's title region.
- * @param {boolean}                    [attributes.multiple=add]            Whether multi-select is enabled. @todo 'add' doesn't seem do anything special, and gets used as a boolean.
+ * @param {boolean|string}             [attributes.multiple=add]            Whether multi-select is enabled. Accepts 'add' or true.
+ *                                                                          When set to true, requires Shift or Cmd/Ctrl to select multiple items.
+ *                                                                          When set to 'add', allows selecting multiple items by clicking thumbnails.
  * @param {wp.media.model.Attachments} [attributes.library]                 The attachments collection to browse.
  *                                                                          If one is not supplied, a collection of attachments of the specified type will be created.

trunk/src/js/media/controllers/gallery-add.js

@@ -21 +21 @@
  * @param {string}                     [attributes.id=gallery-library]      Unique identifier.
  * @param {string}                     [attributes.title=Add to Gallery]    Title for the state. Displays in the frame's title region.
- * @param {boolean}                    [attributes.multiple=add]            Whether multi-select is enabled. @todo 'add' doesn't seem do anything special, and gets used as a boolean.
+ * @param {boolean|string}             [attributes.multiple=add]            Whether multi-select is enabled. Accepts 'add' or true.
+ *                                                                          When set to true, requires Shift or Cmd/Ctrl to select multiple items.
+ *                                                                          When set to 'add', allows selecting multiple items by clicking thumbnails.
  * @param {wp.media.model.Attachments} [attributes.library]                 The attachments collection to browse.
  *                                                                          If one is not supplied, a collection of all images will be created.