docs: clarify closeOnSelect applies to single selects - #6456
Open
sridharkalaibala wants to merge 1 commit into
Open
sridharkalaibala wants to merge 1 commit into
sridharkalaibala wants to merge 1 commit into
Conversation
Assisted-by: OpenAI Codex
lbesecker195
approved these changes
Sep 13, 2026
lbesecker195
left a comment
There was a problem hiding this comment.
Verified in defaults.js: the CloseOnSelect decorator is applied whenever options.closeOnSelect is set, with no check on multiple, so the old "multi-select only" note was wrong. LGTM.
Author
|
Thanks for checking the decorator path, @lbesecker195. That confirms why the note needed correcting; the PR keeps the change limited to the documented |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request includes a
The documentation currently says
closeOnSelectonly applies to multi-select controls. Setting it tofalsealso keeps a single-select dropdown open after selecting a result. Clarify that the option applies to both types.Fixes #6455.
Validation:
python -m mkdocs build --strictpassed using the documentation dependencies frompyproject.tomlin an isolated Python 3.14 environment. The generated dropdown page contains the corrected sentence. CI-only Git metadata plugins were disabled by the repository's default configuration.defaults.js: the CloseOnSelect decorator is applied outside the single/multiple branch.closeOnSelect: falseand closes it withtrue(four passing cases). This was a local behavior check, not a real-browser or full QUnit run.git diff --checkpassed. Only documentation changed.AI assistance: OpenAI Codex helped investigate, validate, and prepare this change.