Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Clarify multi-select behavior in collection and gallery add controllers #8012

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from

Conversation

yogeshbhutkar
Copy link

Description

Updated the JSDoc documentation for the multiple attribute in GalleryAdd and CollectionAdd media controllers to accurately reflect its behavior with different values.

Context

The multiple attribute accepts both boolean and string values, with different behaviors:

  • multiple=true: Requires SHIFT/CMD/CTRL key to select multiple items
  • multiple='add': Allows selecting multiple items by clicking thumbnails directly

Technical Changes

  • Updated JSDoc type annotation to {boolean|string} in both controllers
  • Added detailed description of behavior differences between true and 'add' values
  • Removed outdated TODO comment that incorrectly suggested 'add' had no special behavior

Files Changed

  • src/js/media/controllers/gallery-add.js
  • src/js/media/controllers/collection-add.js

Trac ticket: https://core.trac.wordpress.org/ticket/62696


This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

@yogeshbhutkar yogeshbhutkar marked this pull request as ready for review December 17, 2024 03:57
Copy link

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props yogeshbhutkar.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Copy link

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant