Provide instantiated tooltip object on initialized component #2139
Conversation
✅ Thanks for the improvements! Browse a preview of your changes using the link below.
To edit notification comments on pull requests, go to your Netlify site configuration. |
| @@ -25,7 +25,7 @@ function Tooltip(element) { | |||
| * @returns {Tooltip} An instance. | |||
There was a problem hiding this comment.
This doc isn't quite right, is it? The returned type is whatever tippy returns, not an instance of Tooltip?
There was a problem hiding this comment.
This felt a little redundant, because the init returns tippy, so why can't the returned value of init be stored in a variable? However, in Tooltip.init() we don't store the value of what is returned from init (here) and instead return a list of instances. The alternative to this would be to expose the returned value of init from within instantiateAll, but it seems reasonable to assume that a call to init would in general not be returning anything other than the instance itself. Therefore, the approach in this PR seems reasonable!
Some consumers of these tooltips may need access to the underlying tippy object to, eg, check the tooltip state, etc.
This PR provides the initialized tippy object as a
tooltipkey on the initialized component instance (this key is null before initialization).