Quality: Inconsistent callback context for tooltip hide handler#2917
Open
tuanaiseo wants to merge 1 commit intoc3js:masterfrom
Open
Conversation
…ide han `tooltip.show` invokes `tooltip_onshow` with `this` bound to the internal chart object (`$$`), but `tooltip.hide` invokes `tooltip_onhide` with `this` bound to the public chart instance. This inconsistency can break user callbacks that rely on a stable context and internal fields. Affected files: api.tooltip.ts Signed-off-by: tuanaiseo <221258316+tuanaiseo@users.noreply.github.com>
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
1 participant
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.
Problem
tooltip.showinvokestooltip_onshowwiththisbound to the internal chart object ($$), buttooltip.hideinvokestooltip_onhidewiththisbound to the public chart instance. This inconsistency can break user callbacks that rely on a stable context and internal fields.Severity:
highFile:
src/api.tooltip.tsSolution
Call
tooltip_onhidewith the same context style used bytooltip_onshow(for example:this.internal.config.tooltip_onhide.call(this.internal)), and add a regression test asserting callbackthisconsistency.Changes
src/api.tooltip.ts(modified)Testing