2fc20459-bb13-4738-8188-7cc578623e4e

Committed 28 Aug 2024 07:05AM UTC coverage: 90.476% (+0.004%) from 90.472%

Build # 2fc20459-bb13-4738-8188-7cc578623e4e

Build Type

Pull #3185

circleci

Committed by

minlovehua

Commit Message

Merge branch 'master' of github.com:atinc/ngx-tethys into wumeimin/anchor

Pull Request Pull Request #3185: fix(anchor): warnings should not be displayed when the thy anchor link is not nested under horizontal layout #TINFR-480

Run Details

5507 of 6730 branches covered (81.83%)

Branch coverage included in aggregate %.

2 of 2 new or added lines in 1 file covered. (100.0%)

1 existing line in 1 file now uncovered.

13256 of 14008 relevant lines covered (94.63%)

996.0 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

88.96

/src/anchor/anchor.component.ts

import { Platform } from '@angular/cdk/platform';
import {
    AfterViewInit,
    ChangeDetectionStrategy,
    ChangeDetectorRef,
    Component,
    ElementRef,
    EventEmitter,
    Inject,
    Input,
    NgZone,
    OnChanges,
    OnDestroy,
    Output,
    Renderer2,
    SimpleChanges,
    ViewChild,
    ViewEncapsulation,
    numberAttribute
} from '@angular/core';
import { Subject, fromEvent } from 'rxjs';
import { takeUntil, throttleTime } from 'rxjs/operators';

import { DOCUMENT, NgClass, NgIf, NgStyle, NgTemplateOutlet } from '@angular/common';
import { ThyAffix } from 'ngx-tethys/affix';
import { ThyScrollService } from 'ngx-tethys/core';
import { coerceBooleanProperty, getOffset } from 'ngx-tethys/util';
import { ThyAnchorLink } from './anchor-link.component';

interface Section {
    linkComponent: ThyAnchorLink;
    top: number;
}

const sharpMatcherRegx = /#([^#]+)$/;

/**
 * 锚点组件
 * @name thy-anchor
 */
@Component({
    selector: 'thy-anchor',
    exportAs: 'thyAnchor',
    preserveWhitespaces: false,
    template: `
        <thy-affix *ngIf="thyAffix; else content" [thyOffsetTop]="thyOffsetTop" [thyContainer]="container">
            <ng-template [ngTemplateOutlet]="content"></ng-template>
        </thy-affix>
        <ng-template #content>
            <div
                class="thy-anchor-wrapper"
                [ngClass]="{ 'thy-anchor-wrapper-horizontal': thyDirection === 'horizontal' }"
                [ngStyle]="wrapperStyle">
                <div class="thy-anchor">
                    <div class="thy-anchor-ink">
                        <div class="thy-anchor-ink-full" #ink></div>
                    </div>
                    <ng-content></ng-content>
                </div>
            </div>
        </ng-template>
    `,
    encapsulation: ViewEncapsulation.None,
    changeDetection: ChangeDetectionStrategy.OnPush,
    standalone: true,
    imports: [NgIf, ThyAffix, NgTemplateOutlet, NgStyle, NgClass]
})
export class ThyAnchor implements OnDestroy, AfterViewInit, OnChanges {
    @ViewChild('ink') private ink!: ElementRef;

    /**
     * 固定模式
     */
    @Input({ transform: coerceBooleanProperty }) thyAffix = true;

    /**
     * 锚点区域边界，单位：px
     */
    @Input({ transform: numberAttribute })
    thyBounds = 5;

    /**
     * 缓冲的偏移量阈值
     */
    @Input({ transform: numberAttribute })
    thyOffsetTop?: number = undefined;

    /**
     * 指定滚动的容器
     * @type string | HTMLElement
     */
    @Input() thyContainer?: string | HTMLElement;

    /**
     * 设置导航方向
     * @type 'vertical' | 'horizontal'
     */
    @Input() thyDirection: 'vertical' | 'horizontal' = 'vertical';

    /**
     * 点击项触发
     */
    @Output() readonly thyClick = new EventEmitter<ThyAnchorLink>();

    /**
     * 滚动到某锚点时触发
     */
    @Output() readonly thyScroll = new EventEmitter<ThyAnchorLink>();

    visible = false;

    wrapperStyle = { 'max-height': '100vh' };

    container?: HTMLElement | Window;

    private links: ThyAnchorLink[] = [];

    private animating = false;

    private destroy$ = new Subject<void>();

    private handleScrollTimeoutID: any = -1;

    constructor(
        @Inject(DOCUMENT) private document: any,
        private cdr: ChangeDetectorRef,
        private platform: Platform,
        private zone: NgZone,
        private renderer: Renderer2,
        private scrollService: ThyScrollService,
        private elementRef: ElementRef
    ) {}

    registerLink(link: ThyAnchorLink): void {
        this.links.push(link);
    }

    unregisterLink(link: ThyAnchorLink): void {
        this.links.splice(this.links.indexOf(link), 1);
    }

    private getContainer(): HTMLElement | Window {
        return this.container || window;
    }

    ngAfterViewInit(): void {
        this.warningPrompt();
        this.registerScrollEvent();
    }

    ngOnDestroy(): void {
        clearTimeout(this.handleScrollTimeoutID);
        this.destroy$.next();
        this.destroy$.complete();
    }

    private warningPrompt() {
        if (this.thyDirection === 'horizontal') {
            const hasChildren = this.links.some(link =>
                Array.from(link?.elementRef?.nativeElement?.childNodes)?.some((item: HTMLElement) => item?.nodeName === 'THY-ANCHOR-LINK')
            );
            if (hasChildren) {
                console.warn("Anchor link nesting is not supported when 'Anchor' direction is horizontal.");
            }
        }
    }

    private registerScrollEvent(): void {
        if (!this.platform.isBrowser) {
            return;
        }
        this.destroy$.next();
        this.zone.runOutsideAngular(() => {
            fromEvent(this.getContainer(), 'scroll', { passive: true })
                .pipe(throttleTime(50), takeUntil(this.destroy$))
                .subscribe(() => this.handleScroll());
        });
        // Browser would maintain the scrolling position when refreshing.
        // So we have to delay calculation in avoid of getting a incorrect result.
        this.handleScrollTimeoutID = setTimeout(() => this.handleScroll());
    }

    handleScroll(): void {
        if (typeof document === 'undefined' || this.animating) {
            return;
        }
        const container: HTMLElement = this.container instanceof HTMLElement ? this.container : this.document;

        const sections: Section[] = [];
        const scope = (this.thyOffsetTop || 0) + this.thyBounds;
        this.links.forEach(linkComponent => {
            const sharpLinkMatch = sharpMatcherRegx.exec(linkComponent.thyHref.toString());
            if (!sharpLinkMatch) {
                return;
            }
            const target = container.querySelector(`#${sharpLinkMatch[1]}`) as HTMLElement;
            if (target) {
                const top = getOffset(target, this.getContainer()).top;
                if (top < scope) {
                    sections.push({
                        top,
                        linkComponent
                    });
                }
            }
        });

        this.visible = !!sections.length;
        if (!this.visible) {
            this.clearActive();
            this.cdr.detectChanges();
        } else {
            const maxSection = sections.reduce((prev, curr) => (curr.top > prev.top ? curr : prev));
            this.handleActive(maxSection.linkComponent);
        }
        this.setVisible();
    }

    private clearActive(): void {
        this.links.forEach(i => {
            i.unsetActive();
        });
    }

    private handleActive(linkComponent: ThyAnchorLink): void {
        this.clearActive();
        linkComponent.setActive();
        const linkNode = linkComponent.getLinkTitleElement();
        const horizontalAnchor = this.thyDirection === 'horizontal';

        this.ink.nativeElement.style.top = horizontalAnchor ? '' : `${linkNode.offsetTop}px`;
        this.ink.nativeElement.style.height = horizontalAnchor ? '' : `${linkNode.clientHeight}px`;
        this.ink.nativeElement.style.left = horizontalAnchor ? `${linkNode.offsetLeft}px` : '';
        this.ink.nativeElement.style.width = horizontalAnchor ? `${linkNode.clientWidth}px` : '';
        this.visible = true;
        this.setVisible();
        this.thyScroll.emit(linkComponent);
    }

    private setVisible(): void {
        const visible = this.visible;
        const visibleClassname = 'visible';
        if (this.ink) {
            if (visible) {
                this.renderer.addClass(this.ink.nativeElement, visibleClassname);
            } else {
                this.renderer.removeClass(this.ink.nativeElement, visibleClassname);
            }
        }
    }

    handleScrollTo(linkComponent: ThyAnchorLink): void {
        const container: HTMLElement = this.container instanceof HTMLElement ? this.container : this.document;
        const linkElement: HTMLElement = container.querySelector(linkComponent.thyHref);
        if (!linkElement) {
            return;
        }

        this.animating = true;
        const containerScrollTop = this.scrollService.getScroll(this.getContainer());
        const elementOffsetTop = getOffset(linkElement, this.getContainer()).top;
        const targetScrollTop = containerScrollTop + elementOffsetTop - (this.thyOffsetTop || 0);
        this.scrollService.scrollTo(this.getContainer(), targetScrollTop, undefined, () => {
            this.animating = false;
        });
        this.handleActive(linkComponent);
        this.thyClick.emit(linkComponent);
    }

    ngOnChanges(changes: SimpleChanges): void {
        const { thyOffsetTop, thyContainer } = changes;
        if (thyOffsetTop) {
            this.wrapperStyle = {
                'max-height': `calc(100vh - ${this.thyOffsetTop}px)`
            };
        }
        if (thyContainer && this.thyContainer) {
            const container = this.thyContainer;
            this.container = typeof container === 'string' ? this.document.querySelector(container) : container;
            this.registerScrollEvent();
        }
    }
}

1	import { Platform } from '@angular/cdk/platform';
2	import {
3	AfterViewInit,
4	ChangeDetectionStrategy,
5	ChangeDetectorRef,
6	Component,
7	ElementRef,
8	EventEmitter,
9	Inject,
10	Input,	1✔
11	NgZone,
12	OnChanges,
13	OnDestroy,
14	Output,
15	Renderer2,	1✔
16	SimpleChanges,
17	ViewChild,	10✔
18	ViewEncapsulation,	10✔
19	numberAttribute	10✔
20	} from '@angular/core';	10✔
21	import { Subject, fromEvent } from 'rxjs';	10✔
22	import { takeUntil, throttleTime } from 'rxjs/operators';	10✔
23		10✔
24	import { DOCUMENT, NgClass, NgIf, NgStyle, NgTemplateOutlet } from '@angular/common';	10✔
25	import { ThyAffix } from 'ngx-tethys/affix';	10✔
26	import { ThyScrollService } from 'ngx-tethys/core';	10✔
27	import { coerceBooleanProperty, getOffset } from 'ngx-tethys/util';	10✔
28	import { ThyAnchorLink } from './anchor-link.component';	10✔
29		10✔
30	interface Section {	10✔
31	linkComponent: ThyAnchorLink;	10✔
32	top: number;	10✔
33	}	10✔
34		10✔
35	const sharpMatcherRegx = /#([^#]+)$/;	10✔
36
37	/**
38	* 锚点组件	44✔
39	* @name thy-anchor
40	*/
41	@Component({	44✔
42	selector: 'thy-anchor',
43	exportAs: 'thyAnchor',
44	preserveWhitespaces: false,	35✔
45	template: `
46	<thy-affix *ngIf="thyAffix; else content" [thyOffsetTop]="thyOffsetTop" [thyContainer]="container">
47	<ng-template [ngTemplateOutlet]="content"></ng-template>	10✔
48	</thy-affix>	10✔
49	<ng-template #content>
50	<div
51	class="thy-anchor-wrapper"	10✔
52	[ngClass]="{ 'thy-anchor-wrapper-horizontal': thyDirection === 'horizontal' }"	10✔
53	[ngStyle]="wrapperStyle">	10✔
54	<div class="thy-anchor">
55	<div class="thy-anchor-ink">
56	<div class="thy-anchor-ink-full" #ink></div>	10✔
57	</div>	20✔
58	<ng-content></ng-content>	4✔
59	</div>	1✔
60	</div>
61	</ng-template>
62	`,
63	encapsulation: ViewEncapsulation.None,
64	changeDetection: ChangeDetectionStrategy.OnPush,	11!
65	standalone: true,	×
66	imports: [NgIf, ThyAffix, NgTemplateOutlet, NgStyle, NgClass]
67	})	11✔
68	export class ThyAnchor implements OnDestroy, AfterViewInit, OnChanges {	11✔
69	@ViewChild('ink') private ink!: ElementRef;	11✔
70
71	/**	2✔
72	* 固定模式
73	*/
74	@Input({ transform: coerceBooleanProperty }) thyAffix = true;
75		11✔
76	/**
77	* 锚点区域边界，单位：px
78	*/	7✔
79	@Input({ transform: numberAttribute })	1✔
80	thyBounds = 5;
81		6✔
82	/**	6✔
83	* 缓冲的偏移量阈值	6!
84	*/	6✔
85	@Input({ transform: numberAttribute })	22✔
86	thyOffsetTop?: number = undefined;	22!
87		×
88	/**
89	* 指定滚动的容器	22✔
90	* @type string \| HTMLElement	22✔
91	*/	18✔
92	@Input() thyContainer?: string \| HTMLElement;	18✔
93		6✔
94	/**
95	* 设置导航方向
96	* @type 'vertical' \| 'horizontal'
97	*/
98	@Input() thyDirection: 'vertical' \| 'horizontal' = 'vertical';
99
100	/**	6✔
101	* 点击项触发	6!
102	*/	×
103	@Output() readonly thyClick = new EventEmitter<ThyAnchorLink>();	×
104
105	/**
106	* 滚动到某锚点时触发	6!
107	*/	6✔
108	@Output() readonly thyScroll = new EventEmitter<ThyAnchorLink>();
109		6✔
110	visible = false;
111
112	wrapperStyle = { 'max-height': '100vh' };	8✔
113		32✔
114	container?: HTMLElement \| Window;
115
116	private links: ThyAnchorLink[] = [];
117		8✔
118	private animating = false;	8✔
119		8✔
120	private destroy$ = new Subject<void>();	8✔
121		8✔
122	private handleScrollTimeoutID: any = -1;	8✔
123		8✔
124	constructor(	8✔
125	@Inject(DOCUMENT) private document: any,	8✔
126	private cdr: ChangeDetectorRef,	8✔
127	private platform: Platform,	8✔
128	private zone: NgZone,
129	private renderer: Renderer2,
130	private scrollService: ThyScrollService,	14✔
131	private elementRef: ElementRef	14✔
132	) {}	14!
133		14!
134	registerLink(link: ThyAnchorLink): void {	14✔
135	this.links.push(link);
136	}
UNCOV 137		×
138	unregisterLink(link: ThyAnchorLink): void {
139	this.links.splice(this.links.indexOf(link), 1);
140	}
141
142	private getContainer(): HTMLElement \| Window {	3!
143	return this.container \|\| window;	3✔
144	}	3✔
145		1✔
146	ngAfterViewInit(): void {
147	this.warningPrompt();	2✔
148	this.registerScrollEvent();	2✔
149	}	2✔
150		2!
151	ngOnDestroy(): void {	2✔
152	clearTimeout(this.handleScrollTimeoutID);	2✔
153	this.destroy$.next();
154	this.destroy$.complete();	2✔
155	}	2✔
156
157	private warningPrompt() {
158	if (this.thyDirection === 'horizontal') {	10✔
159	const hasChildren = this.links.some(link =>	10!
160	Array.from(link?.elementRef?.nativeElement?.childNodes)?.some((item: HTMLElement) => item?.nodeName === 'THY-ANCHOR-LINK')	10✔
161	);
162	if (hasChildren) {
163	console.warn("Anchor link nesting is not supported when 'Anchor' direction is horizontal.");
164	}	10✔
165	}	1✔
166	}	1!
167		1✔
168	private registerScrollEvent(): void {
169	if (!this.platform.isBrowser) {
170	return;	1✔
171	}
172	this.destroy$.next();
173	this.zone.runOutsideAngular(() => {
174	fromEvent(this.getContainer(), 'scroll', { passive: true })
175	.pipe(throttleTime(50), takeUntil(this.destroy$))
176	.subscribe(() => this.handleScroll());
177	});
178	// Browser would maintain the scrolling position when refreshing.
179	// So we have to delay calculation in avoid of getting a incorrect result.	1✔
180	this.handleScrollTimeoutID = setTimeout(() => this.handleScroll());
181	}
182
183	handleScroll(): void {
184	if (typeof document === 'undefined' \|\| this.animating) {
185	return;
186	}
187	const container: HTMLElement = this.container instanceof HTMLElement ? this.container : this.document;
188
189	const sections: Section[] = [];
190	const scope = (this.thyOffsetTop \|\| 0) + this.thyBounds;	1✔
191	this.links.forEach(linkComponent => {
192	const sharpLinkMatch = sharpMatcherRegx.exec(linkComponent.thyHref.toString());
193	if (!sharpLinkMatch) {
194	return;
195	}
196	const target = container.querySelector(`#${sharpLinkMatch[1]}`) as HTMLElement;
197	if (target) {
198	const top = getOffset(target, this.getContainer()).top;
199	if (top < scope) {
200	sections.push({
201	top,
202	linkComponent
203	});
204	}
205	}
206	});
207
208	this.visible = !!sections.length;
209	if (!this.visible) {
210	this.clearActive();
211	this.cdr.detectChanges();
212	} else {
213	const maxSection = sections.reduce((prev, curr) => (curr.top > prev.top ? curr : prev));
214	this.handleActive(maxSection.linkComponent);
215	}
216	this.setVisible();
217	}
218
219	private clearActive(): void {
220	this.links.forEach(i => {
221	i.unsetActive();
222	});
223	}
224
225	private handleActive(linkComponent: ThyAnchorLink): void {
226	this.clearActive();
227	linkComponent.setActive();
228	const linkNode = linkComponent.getLinkTitleElement();
229	const horizontalAnchor = this.thyDirection === 'horizontal';
230
231	this.ink.nativeElement.style.top = horizontalAnchor ? '' : `${linkNode.offsetTop}px`;
232	this.ink.nativeElement.style.height = horizontalAnchor ? '' : `${linkNode.clientHeight}px`;
233	this.ink.nativeElement.style.left = horizontalAnchor ? `${linkNode.offsetLeft}px` : '';
234	this.ink.nativeElement.style.width = horizontalAnchor ? `${linkNode.clientWidth}px` : '';
235	this.visible = true;
236	this.setVisible();
237	this.thyScroll.emit(linkComponent);
238	}
239
240	private setVisible(): void {
241	const visible = this.visible;
242	const visibleClassname = 'visible';
243	if (this.ink) {
244	if (visible) {
245	this.renderer.addClass(this.ink.nativeElement, visibleClassname);
246	} else {
247	this.renderer.removeClass(this.ink.nativeElement, visibleClassname);
248	}
249	}
250	}
251
252	handleScrollTo(linkComponent: ThyAnchorLink): void {
253	const container: HTMLElement = this.container instanceof HTMLElement ? this.container : this.document;
254	const linkElement: HTMLElement = container.querySelector(linkComponent.thyHref);
255	if (!linkElement) {
256	return;
257	}
258
259	this.animating = true;
260	const containerScrollTop = this.scrollService.getScroll(this.getContainer());
261	const elementOffsetTop = getOffset(linkElement, this.getContainer()).top;
262	const targetScrollTop = containerScrollTop + elementOffsetTop - (this.thyOffsetTop \|\| 0);
263	this.scrollService.scrollTo(this.getContainer(), targetScrollTop, undefined, () => {
264	this.animating = false;
265	});
266	this.handleActive(linkComponent);
267	this.thyClick.emit(linkComponent);
268	}
269
270	ngOnChanges(changes: SimpleChanges): void {
271	const { thyOffsetTop, thyContainer } = changes;
272	if (thyOffsetTop) {
273	this.wrapperStyle = {
274	'max-height': `calc(100vh - ${this.thyOffsetTop}px)`
275	};
276	}
277	if (thyContainer && this.thyContainer) {
278	const container = this.thyContainer;
279	this.container = typeof container === 'string' ? this.document.querySelector(container) : container;
280	this.registerScrollEvent();
281	}
282	}
283	}

atinc / ngx-tethys / 2fc20459-bb13-4738-8188-7cc578623e4e

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous