feat: allow lazy-loading tippy.js
#160
Merged
Conversation
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
|
|
In this commit, we implement lazy loading for `tippy.js` to avoid loading it until it's actually
necessary. Tooltips are commonly used across the app, but they’re not needed until the directive
is rendered. However, the `tippy.js` package is always included in the common bundle.
For example, if we have a `<button [tp]="..." />` element hidden by a conditional
`@if (condition) { ... }`, `tippy.js` would load immediately, even if the button isn't in the DOM.
We’ve added a `loader` property to the config, allowing users to specify a loader function for
the Tippy module. This can be `() => tippy` or `() => import('tippy.js')`, depending on whether
users want to lazy-load it.
This change is breaking because it introduces a required property to the config.
However, the migration should be straightforward, as users only need to explicitly add
the new property to `provideTippyConfig`.
| private _tippy$: Observable<typeof tippy> | null = null; | ||
|
|
||
| create(target: HTMLElement, props?: Partial<TippyProps>) { | ||
| this._tippy$ = defer(() => { |
There was a problem hiding this comment.
We probably want to do this if !this.tippy$
There was a problem hiding this comment.
Oh yeah I meant to use ||= ....
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In this commit, we implement lazy loading for
tippy.jsto avoid loading it until it's actually necessary. Tooltips are commonly used across the app, but they’re not needed until the directive is rendered. However, thetippy.jspackage is always included in the common bundle. For example, if we have a<button [tp]="..." />element hidden by a conditional@if (condition) { ... },tippy.jswould load immediately, even if the button isn't in the DOM.We’ve added a
loaderproperty to the config, allowing users to specify a loader function for the Tippy module. This can be() => tippyor() => import('tippy.js'), depending on whether users want to lazy-load it.This change is breaking because it introduces a required property to the config. However, the migration should be straightforward, as users only need to explicitly add the new property to
provideTippyConfig.