docs: explain why tooltips, popovers, toasts, and carousels are opt-in#42360
Open
pierluigilenoci wants to merge 1 commit intotwbs:mainfrom
Open
docs: explain why tooltips, popovers, toasts, and carousels are opt-in#42360pierluigilenoci wants to merge 1 commit intotwbs:mainfrom
pierluigilenoci wants to merge 1 commit intotwbs:mainfrom
Conversation
pierluigilenoci
force-pushed
the
docs/tooltip-popover-opt-in-explanation
branch
from
5318eec to
20c3fce
Compare
Expand the "opt-in for performance reasons" notes in the Tooltip, Popover, Toast, and Carousel docs to explain what those performance reasons actually are: each instance creates Popper positioning or event listeners that would add unnecessary overhead if auto-initialized on every page load. Fixes twbs#29378 Signed-off-by: Pierluigi Lenoci <pierluigilenoci@gmail.com>
pierluigilenoci
force-pushed
the
docs/tooltip-popover-opt-in-explanation
branch
from
20c3fce to
cc9da05
Compare
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.
Summary
Expands the "opt-in for performance reasons" notes in the Tooltip, Popover, Toast, and Carousel documentation pages to actually explain what those performance reasons are:
This has been a long-standing documentation gap — the original "opt-in for performance reasons" phrasing dates back at least 6 years but never explained the reasoning. Users frequently miss the initialization requirement (see #24985, #15458), and a clear explanation helps them understand why the extra step exists.
Fixes #29378
Note
This PR addresses the v5 documentation. Per @mdo's comment, v6 already auto-initializes tooltips and popovers, but carousels and toasts still mention manual initialization.
AI-assisted development
This PR was developed with the assistance of AI tools (Claude Code). All changes were reviewed, validated, and approved by the author.