Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: use DestroyRef to setup destroy hooks #162

Merged
merged 1 commit into from
Nov 17, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 21 additions & 20 deletions projects/ngneat/helipopper/src/lib/tippy.directive.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import {
AfterViewInit,
computed,
DestroyRef,
Directive,
effect,
ElementRef,
Expand All @@ -13,14 +14,14 @@ import {
model,
NgZone,
OnChanges,
OnDestroy,
OnInit,
Output,
PLATFORM_ID,
untracked,
ViewContainerRef,
} from '@angular/core';
import { isPlatformServer } from '@angular/common';
import { takeUntilDestroyed } from '@angular/core/rxjs-interop';
import type { Instance } from 'tippy.js';
import { fromEvent, merge, Observable, Subject } from 'rxjs';
import { filter, map, switchMap, takeUntil } from 'rxjs/operators';
Expand Down Expand Up @@ -61,7 +62,7 @@ import { coerceBooleanAttribute } from './coercion';
exportAs: 'tippy',
standalone: true,
})
export class TippyDirective implements OnChanges, AfterViewInit, OnDestroy, OnInit {
export class TippyDirective implements OnChanges, AfterViewInit, OnInit {
// Note that default values are not provided for these bindings because `tippy.js`
// has its own default values and checks whether the provided props are `undefined`.
// We should keep `undefined` as the default value.
Expand Down Expand Up @@ -173,7 +174,6 @@ export class TippyDirective implements OnChanges, AfterViewInit, OnDestroy, OnIn

protected instance: TippyInstance;
protected viewRef: ViewRef;
protected destroyed = new Subject<void>();
protected props: Partial<TippyConfig>;
protected variationDefined = false;
protected viewOptions$: ViewOptions;
Expand All @@ -199,6 +199,7 @@ export class TippyDirective implements OnChanges, AfterViewInit, OnDestroy, OnIn
return this.host().getBoundingClientRect().width;
}

private destroyRef = inject(DestroyRef);
private isServer = isPlatformServer(inject(PLATFORM_ID));
private tippyFactory = inject(TippyFactory);

Expand All @@ -210,7 +211,15 @@ export class TippyDirective implements OnChanges, AfterViewInit, OnDestroy, OnIn
protected ngZone: NgZone,
protected hostRef: ElementRef
) {
if (this.isServer) return;

this.setupListeners();

this.destroyRef.onDestroy(() => {
this.instance?.destroy();
this.destroyView();
this.visibilityObserverCleanup?.();
});
}

ngOnChanges(changes: NgChanges<TippyDirective>) {
Expand Down Expand Up @@ -264,19 +273,19 @@ export class TippyDirective implements OnChanges, AfterViewInit, OnDestroy, OnIn
hostInView$
.pipe(
switchMap(() => this.isOverflowing$()),
takeUntil(this.destroyed)
takeUntilDestroyed(this.destroyRef)
)
.subscribe((isElementOverflow) => {
this.checkOverflow(isElementOverflow);
});
} else {
hostInView$.pipe(takeUntil(this.destroyed)).subscribe(() => {
hostInView$.pipe(takeUntilDestroyed(this.destroyRef)).subscribe(() => {
this.createInstance();
});
}
} else if (this.onlyTextOverflow()) {
this.isOverflowing$()
.pipe(takeUntil(this.destroyed))
.pipe(takeUntilDestroyed(this.destroyRef))
.subscribe((isElementOverflow) => {
this.checkOverflow(isElementOverflow);
});
Expand All @@ -285,13 +294,6 @@ export class TippyDirective implements OnChanges, AfterViewInit, OnDestroy, OnIn
}
}

ngOnDestroy() {
this.destroyed.next();
this.instance?.destroy();
this.destroyView();
this.visibilityObserverCleanup?.();
}

destroyView() {
this.viewOptions$ = null;
this.viewRef?.destroy();
Expand All @@ -309,7 +311,7 @@ export class TippyDirective implements OnChanges, AfterViewInit, OnDestroy, OnIn
if (this.props.appendTo && this.props.appendTo !== document.body) {
this.visibilityObserverCleanup?.();
return this.visibleInternal
.pipe(takeUntil(this.destroyed))
.pipe(takeUntilDestroyed(this.destroyRef))
.subscribe((isVisible) => {
if (isVisible) {
this.visibilityObserverCleanup = observeVisibility(
Expand Down Expand Up @@ -433,7 +435,7 @@ export class TippyDirective implements OnChanges, AfterViewInit, OnDestroy, OnIn
this.onHidden(instance);
},
})
.pipe(takeUntil(this.destroyed))
.pipe(takeUntilDestroyed(this.destroyRef))
.subscribe((instance) => {
this.instance = instance;

Expand Down Expand Up @@ -502,7 +504,7 @@ export class TippyDirective implements OnChanges, AfterViewInit, OnDestroy, OnIn

protected handleContextMenu() {
fromEvent(this.host(), 'contextmenu')
.pipe(takeUntil(this.destroyed))
.pipe(takeUntilDestroyed(this.destroyRef))
.subscribe((event: MouseEvent) => {
event.preventDefault();

Expand All @@ -526,7 +528,8 @@ export class TippyDirective implements OnChanges, AfterViewInit, OnDestroy, OnIn
fromEvent(document.body, 'keydown')
.pipe(
filter(({ code }: KeyboardEvent) => code === 'Escape'),
takeUntil(merge(this.destroyed, this.visibleInternal.pipe(filter((v) => !v))))
takeUntil(this.visibleInternal.pipe(filter((v) => !v))),
takeUntilDestroyed(this.destroyRef)
)
.subscribe(() => this.hide());
}
Expand All @@ -545,7 +548,7 @@ export class TippyDirective implements OnChanges, AfterViewInit, OnDestroy, OnIn

protected listenToHostResize() {
dimensionsChanges(this.host())
.pipe(takeUntil(merge(this.destroyed, this.visibleInternal)))
.pipe(takeUntil(this.visibleInternal), takeUntilDestroyed(this.destroyRef))
.subscribe(() => {
this.setInstanceWidth(this.instance, this.hostWidth);
});
Expand Down Expand Up @@ -597,8 +600,6 @@ export class TippyDirective implements OnChanges, AfterViewInit, OnDestroy, OnIn
}

private setupListeners(): void {
if (this.isServer) return;

effect(() => {
const appendTo = this.appendTo();
this.updateProps({ appendTo });
Expand Down
Loading