de3a5667-4fb5-463e-a4f1-e76438188503

Committed 22 Dec 2023 09:32AM UTC coverage: 90.538% (+0.01%) from 90.526%

Build # de3a5667-4fb5-463e-a4f1-e76438188503

Build Type

push

circleci

Committed by

web-flow

Commit Message

fix(date-picker): when the date picker directive's and component's thyHasBackdrop value is false, clicking outside should close #INFR-11053 (#2984)

Run Details

5401 of 6623 branches covered (0.0%)

Branch coverage included in aggregate %.

12 of 16 new or added lines in 3 files covered. (75.0%)

5 existing lines in 3 files now uncovered.

13478 of 14229 relevant lines covered (94.72%)

979.58 hits per line

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

90.48

/src/date-picker/base-picker.component.ts

import { InputBoolean, ThyClickDispatcher, ThyPlacement } from 'ngx-tethys/core';
import { coerceBooleanProperty, elementMatchClosest, FunctionProp, TinyDate } from 'ngx-tethys/util';

import {
    ChangeDetectorRef,
    Component,
    ElementRef,
    EventEmitter,
    Inject,
    Input,
    NgZone,
    OnChanges,
    OnInit,
    Output,
    PLATFORM_ID,
    TemplateRef,
    ViewChild,
    inject
} from '@angular/core';

import { AbstractPickerComponent } from './abstract-picker.component';
import { CompatibleValue, RangeAdvancedValue } from './inner-types';
import { CompatibleDate, ThyPanelMode } from './standard-types';
import { ThyPickerComponent } from './picker.component';
import { hasTimeInStringDate, isValidStringDate, parseStringDate, transformDateValue } from './picker.util';
import { isPlatformBrowser } from '@angular/common';
import { takeUntilDestroyed } from '@angular/core/rxjs-interop';

/**
 * @private
 */
@Component({
    template: ``,
    standalone: true,
    host: {
        '[attr.tabindex]': `tabIndex`,
        '(focus)': 'onFocus($event)',
        '(blur)': 'onBlur($event)'
    }
})
export class BasePickerComponent extends AbstractPickerComponent implements OnInit, OnChanges {
    showWeek = false;

    panelMode: ThyPanelMode | ThyPanelMode[];

    initialized: boolean;

    private innerPreviousDate: string;

    @ViewChild('thyPicker', { static: true }) thyPicker: ThyPickerComponent;

    @Input() thyDateRender: FunctionProp<TemplateRef<Date> | string>;

    @Input() set thyMode(value: ThyPanelMode) {
        this._panelMode = value ?? 'date';
        if (this.initialized) {
            this.setDefaultTimePickerState(this._panelMode);
        }
    }

    get thyMode() {
        return this._panelMode;
    }

    /**
     * 是否有幕布
     * @default true
     */
    @Input() @InputBoolean() thyHasBackdrop = true;

    /**
     * @type EventEmitter<ThyPanelMode | ThyPanelMode[]>
     */
    @Output() readonly thyOnPanelChange = new EventEmitter<ThyPanelMode | ThyPanelMode[]>();

    /**
     * @type EventEmitter<Date[]>
     */
    @Output() readonly thyOnCalendarChange = new EventEmitter<Date[]>();

    private _showTime: object | boolean;

    /**
     * 增加时间选择功能
     * @default false
     */
    @Input() get thyShowTime(): object | boolean {
        return this._showTime;
    }
    set thyShowTime(value: object | boolean) {
        this._showTime = typeof value === 'object' ? value : coerceBooleanProperty(value);
    }

    /**
     * 是否展示时间(时、分)
     * @default false
     */
    @Input() @InputBoolean() thyMustShowTime = false;

    /**
     * 弹出位置
     * @type top | topLeft | topRight | bottom | bottomLeft | bottomRight | left | leftTop | leftBottom | right | rightTop | rightBottom
     */
    @Input() thyPlacement: ThyPlacement = 'bottomLeft';

    /**
     * @type EventEmitter<CompatibleDate | null>
     */
    @Output() readonly thyOnOk = new EventEmitter<CompatibleDate | null>();

    takeUntilDestroyed = takeUntilDestroyed();

    thyClickDispatcher = inject(ThyClickDispatcher);

    platformId = inject(PLATFORM_ID);

    ngZone = inject(NgZone);

    constructor(cdr: ChangeDetectorRef, protected element: ElementRef) {
        super(cdr);
    }

    ngOnInit(): void {
        super.ngOnInit();
        this.setDefaultTimePickerState(this._panelMode);
        this.initialized = true;

        if (isPlatformBrowser(this.platformId)) {
            this.thyClickDispatcher
                .clicked(0)
                .pipe(this.takeUntilDestroyed)
                .subscribe((event: Event) => {
                    if (
                        !this.element.nativeElement.contains(event.target) &&
                        !this.thyPicker?.overlayContainer?.nativeElement.contains(event.target as Node) &&
                        this.realOpenState
                    ) {
                        this.ngZone.run(() => {
                            this.closeOverlay();
                            this.cdr.markForCheck();
                        });
                    }
                });
        }
    }

    onValueChange(value: CompatibleValue | RangeAdvancedValue): void {
        this.thyPicker.entering = false;
        this.restoreTimePickerState(value as CompatibleValue);
        super.onValueChange(value);
        if (!this.flexible) {
            this.closeOverlay();
        }
        this.innerPreviousDate = this.thyPicker.getReadableValue(this.thyValue);
    }

    onInputValueChange(formatDate: string | null | Array<null>) {
        if (!formatDate || !formatDate.length) {
            const compatibleValue = formatDate ? (formatDate as CompatibleValue) : null;
            this.restoreTimePickerState(compatibleValue);
            super.onValueChange(compatibleValue);
            return;
        }
        let value = formatDate as string;
        const valueValid = isValidStringDate(value);
        const valueLimitValid = valueValid ? this.isValidDateLimit(parseStringDate(value)) : false;
        if (valueValid && valueLimitValid) {
            this.innerPreviousDate = value;
        } else {
            value = this.innerPreviousDate;
        }
        const tinyDate = value ? (this.thyShowTime ? parseStringDate(value) : parseStringDate(value).startOfDay()) : null;
        this.restoreTimePickerState(tinyDate);
        super.onValueChange(tinyDate);
    }

    // Displays the time directly when the time must be displayed by default
    setDefaultTimePickerState(value: ThyPanelMode) {
        this.withTime = this.thyMustShowTime;
        if (this.isRange) {
            this.panelMode = this.flexible ? ['date', 'date'] : [value, value];
        } else {
            this.panelMode = value;
        }
        this.showWeek = value === 'week';
        if (!this.thyFormat) {
            const inputFormats: { [key in ThyPanelMode]?: string } = {
                year: 'yyyy',
                quarter: 'yyyy-qqq',
                month: 'yyyy-MM',
                week: 'yyyy-ww周',
                date: this.thyShowTime ? 'yyyy-MM-dd HH:mm' : 'yyyy-MM-dd'
            };
            this.thyFormat = this.flexible ? inputFormats['date'] : inputFormats[value];
        }
    }

    // Restore after clearing time to select whether the original picker time is displayed or not
    restoreTimePickerState(value: CompatibleValue | null) {
        if (!value) {
            this.withTime = this.thyMustShowTime || this.originWithTime;
        }
    }

    // Emit thyOnCalendarChange when select date by thy-range-picker
    onCalendarChange(value: TinyDate[]): void {
        if (this.isRange) {
            const rangeValue = value.map(x => x.nativeDate);
            this.thyOnCalendarChange.emit(rangeValue);
        }
    }

    onShowTimePickerChange(show: boolean): void {
        this.withTime = show;
    }

    onResultOk(): void {
        if (this.isRange) {
            const value = this.thyValue as TinyDate[];
            if (value.length) {
                this.thyOnOk.emit([value[0].nativeDate, value[1].nativeDate]);
            } else {
                this.thyOnOk.emit([]);
            }
        } else {
            if (this.thyValue) {
                this.thyOnOk.emit((this.thyValue as TinyDate).nativeDate);
            } else {
                this.thyOnOk.emit(null);
            }
        }
        this.closeOverlay();
    }

    onOpenChange(open: boolean): void {
        this.thyOpenChange.emit(open);
        if (!open) {
            this.onTouchedFn();
        }
    }

    onFocus(event: Event) {
        this.picker.focus();
    }

    onBlur(event?: FocusEvent) {
        // Tab 聚焦后自动聚焦到 input 输入框，此分支下直接返回，无需触发 onTouchedFn
        if (elementMatchClosest(event?.relatedTarget as HTMLElement, ['date-popup', 'thy-picker'])) {
            return;
        }
        this.onTouchedFn();
    }

    onInputDate(value: string) {
        if (value && isValidStringDate(value)) {
            if (this.thyShowTime) {
                this.withTime = hasTimeInStringDate(value);
            }
            this.thyValue = parseStringDate(value);
        }
    }

    private isValidDateLimit(date: TinyDate): boolean {
        let disable = false;
        if (this.thyDisabledDate !== undefined) {
            disable = this.thyDisabledDate(date.nativeDate);
        }
        const minDate = this.thyMinDate ? new TinyDate(transformDateValue(this.thyMinDate).value as Date) : null;
        const maxDate = this.thyMaxDate ? new TinyDate(transformDateValue(this.thyMaxDate).value as Date) : null;
        return (
            (!minDate || date.startOfDay().nativeDate >= minDate.startOfDay().nativeDate) &&
            (!maxDate || date.startOfDay().nativeDate <= maxDate.startOfDay().nativeDate) &&
            !disable
        );
    }
}

1	import { InputBoolean, ThyClickDispatcher, ThyPlacement } from 'ngx-tethys/core';
2	import { coerceBooleanProperty, elementMatchClosest, FunctionProp, TinyDate } from 'ngx-tethys/util';
3
4	import {
5	ChangeDetectorRef,
6	Component,
7	ElementRef,
8	EventEmitter,
9	Inject,
10	Input,
11	NgZone,
12	OnChanges,
13	OnInit,	1✔
14	Output,
15	PLATFORM_ID,	154✔
16	TemplateRef,	154✔
17	ViewChild,	6✔
18	inject
19	} from '@angular/core';
20
21	import { AbstractPickerComponent } from './abstract-picker.component';	849✔
22	import { CompatibleValue, RangeAdvancedValue } from './inner-types';
23	import { CompatibleDate, ThyPanelMode } from './standard-types';
24	import { ThyPickerComponent } from './picker.component';	562✔
25	import { hasTimeInStringDate, isValidStringDate, parseStringDate, transformDateValue } from './picker.util';
26	import { isPlatformBrowser } from '@angular/common';
27	import { takeUntilDestroyed } from '@angular/core/rxjs-interop';	65!
28
29	/**
30	* @private	154✔
31	*/	154✔
32	@Component({	154✔
33	template: ``,	154✔
34	standalone: true,	154✔
35	host: {	154✔
36	'[attr.tabindex]': `tabIndex`,	154✔
37	'(focus)': 'onFocus($event)',	154✔
38	'(blur)': 'onBlur($event)'	154✔
39	}	154✔
40	})	154✔
41	export class BasePickerComponent extends AbstractPickerComponent implements OnInit, OnChanges {	154✔
42	showWeek = false;	154✔
43
44	panelMode: ThyPanelMode \| ThyPanelMode[];
45		154✔
46	initialized: boolean;	154✔
47		154✔
48	private innerPreviousDate: string;	154!
49		154✔
50	@ViewChild('thyPicker', { static: true }) thyPicker: ThyPickerComponent;
51
52	@Input() thyDateRender: FunctionProp<TemplateRef<Date> \| string>;
53		227✔
54	@Input() set thyMode(value: ThyPanelMode) {
55	this._panelMode = value ?? 'date';
56	if (this.initialized) {	1✔
57	this.setDefaultTimePickerState(this._panelMode);	1✔
58	}	1✔
59	}
60
61	get thyMode() {
62	return this._panelMode;
63	}
64
65	/**	49✔
66	* 是否有幕布	49✔
67	* @default true	49✔
68	*/	49✔
69	@Input() @InputBoolean() thyHasBackdrop = true;	41✔
70
71	/**	49✔
72	* @type EventEmitter<ThyPanelMode \| ThyPanelMode[]>
73	*/
74	@Output() readonly thyOnPanelChange = new EventEmitter<ThyPanelMode \| ThyPanelMode[]>();	14✔
75		6✔
76	/**	6✔
77	* @type EventEmitter<Date[]>	6✔
78	*/	6✔
79	@Output() readonly thyOnCalendarChange = new EventEmitter<Date[]>();
80		8✔
81	private _showTime: object \| boolean;	8✔
82		8!
83	/**	8✔
84	* 增加时间选择功能	5✔
85	* @default false
86	*/
87	@Input() get thyShowTime(): object \| boolean {	3✔
88	return this._showTime;
89	}	8✔
90	set thyShowTime(value: object \| boolean) {	8✔
91	this._showTime = typeof value === 'object' ? value : coerceBooleanProperty(value);	8✔
92	}
93
94	/**
95	* 是否展示时间(时、分)	160✔
96	* @default false	160✔
97	*/	61✔
98	@Input() @InputBoolean() thyMustShowTime = false;
99
100	/**	99✔
101	* 弹出位置
102	* @type top \| topLeft \| topRight \| bottom \| bottomLeft \| bottomRight \| left \| leftTop \| leftBottom \| right \| rightTop \| rightBottom	160✔
103	*/	160✔
104	@Input() thyPlacement: ThyPlacement = 'bottomLeft';	122✔
105
106	/**
107	* @type EventEmitter<CompatibleDate \| null>
108	*/
109	@Output() readonly thyOnOk = new EventEmitter<CompatibleDate \| null>();	122✔
110
111	takeUntilDestroyed = takeUntilDestroyed();	122✔
112
113	thyClickDispatcher = inject(ThyClickDispatcher);
114
115	platformId = inject(PLATFORM_ID);
116		63✔
117	ngZone = inject(NgZone);	10✔
118
119	constructor(cdr: ChangeDetectorRef, protected element: ElementRef) {
120	super(cdr);
121	}
122		10!
123	ngOnInit(): void {	15✔
124	super.ngOnInit();	10✔
125	this.setDefaultTimePickerState(this._panelMode);
126	this.initialized = true;
127
128	if (isPlatformBrowser(this.platformId)) {	62✔
129	this.thyClickDispatcher
130	.clicked(0)
131	.pipe(this.takeUntilDestroyed)	5!
NEW 132	.subscribe((event: Event) => {	×
NEW 133	if (	×
NEW 134	!this.element.nativeElement.contains(event.target) &&	×
135	!this.thyPicker?.overlayContainer?.nativeElement.contains(event.target as Node) &&
136	this.realOpenState
NEW 137	) {	×
138	this.ngZone.run(() => {
139	this.closeOverlay();
140	this.cdr.markForCheck();
141	});	5!
142	}	5✔
143	});
144	}
UNCOV 145	}	×
146
147	onValueChange(value: CompatibleValue \| RangeAdvancedValue): void {
148	this.thyPicker.entering = false;	5✔
149	this.restoreTimePickerState(value as CompatibleValue);
150	super.onValueChange(value);
151	if (!this.flexible) {	180✔
152	this.closeOverlay();	180✔
153	}	57✔
154	this.innerPreviousDate = this.thyPicker.getReadableValue(this.thyValue);
155	}
156
157	onInputValueChange(formatDate: string \| null \| Array<null>) {	1✔
158	if (!formatDate \|\| !formatDate.length) {
159	const compatibleValue = formatDate ? (formatDate as CompatibleValue) : null;
160	this.restoreTimePickerState(compatibleValue);
161	super.onValueChange(compatibleValue);	5✔
162	return;	1✔
163	}
164	let value = formatDate as string;	4✔
165	const valueValid = isValidStringDate(value);
166	const valueLimitValid = valueValid ? this.isValidDateLimit(parseStringDate(value)) : false;
167	if (valueValid && valueLimitValid) {	13!
168	this.innerPreviousDate = value;	13✔
169	} else {	4✔
170	value = this.innerPreviousDate;
171	}	13✔
172	const tinyDate = value ? (this.thyShowTime ? parseStringDate(value) : parseStringDate(value).startOfDay()) : null;
173	this.restoreTimePickerState(tinyDate);
174	super.onValueChange(tinyDate);
175	}	8✔
176		8!
UNCOV 177	// Displays the time directly when the time must be displayed by default	×
178	setDefaultTimePickerState(value: ThyPanelMode) {
179	this.withTime = this.thyMustShowTime;	8✔
180	if (this.isRange) {	8✔
181	this.panelMode = this.flexible ? ['date', 'date'] : [value, value];	8✔
182	} else {
183	this.panelMode = value;
184	}
185	this.showWeek = value === 'week';	1✔
186	if (!this.thyFormat) {
187	const inputFormats: { [key in ThyPanelMode]?: string } = {
188	year: 'yyyy',
189	quarter: 'yyyy-qqq',	1✔
190	month: 'yyyy-MM',
191	week: 'yyyy-ww周',
192	date: this.thyShowTime ? 'yyyy-MM-dd HH:mm' : 'yyyy-MM-dd'
193	};
194	this.thyFormat = this.flexible ? inputFormats['date'] : inputFormats[value];
195	}
196	}
197
198	// Restore after clearing time to select whether the original picker time is displayed or not
199	restoreTimePickerState(value: CompatibleValue \| null) {
200	if (!value) {
201	this.withTime = this.thyMustShowTime \|\| this.originWithTime;
202	}	1✔
203	}
204
205	// Emit thyOnCalendarChange when select date by thy-range-picker
206	onCalendarChange(value: TinyDate[]): void {	1✔
207	if (this.isRange) {
208	const rangeValue = value.map(x => x.nativeDate);
209	this.thyOnCalendarChange.emit(rangeValue);
210	}	1✔
211	}
212
213	onShowTimePickerChange(show: boolean): void {
214	this.withTime = show;
215	}
216
217	onResultOk(): void {
218	if (this.isRange) {
219	const value = this.thyValue as TinyDate[];
220	if (value.length) {
221	this.thyOnOk.emit([value[0].nativeDate, value[1].nativeDate]);
222	} else {
223	this.thyOnOk.emit([]);
224	}
225	} else {
226	if (this.thyValue) {
227	this.thyOnOk.emit((this.thyValue as TinyDate).nativeDate);
228	} else {
229	this.thyOnOk.emit(null);
230	}
231	}
232	this.closeOverlay();
233	}
234
235	onOpenChange(open: boolean): void {
236	this.thyOpenChange.emit(open);
237	if (!open) {
238	this.onTouchedFn();
239	}
240	}
241
242	onFocus(event: Event) {
243	this.picker.focus();
244	}
245
246	onBlur(event?: FocusEvent) {
247	// Tab 聚焦后自动聚焦到 input 输入框，此分支下直接返回，无需触发 onTouchedFn
248	if (elementMatchClosest(event?.relatedTarget as HTMLElement, ['date-popup', 'thy-picker'])) {
249	return;
250	}
251	this.onTouchedFn();
252	}
253
254	onInputDate(value: string) {
255	if (value && isValidStringDate(value)) {
256	if (this.thyShowTime) {
257	this.withTime = hasTimeInStringDate(value);
258	}
259	this.thyValue = parseStringDate(value);
260	}
261	}
262
263	private isValidDateLimit(date: TinyDate): boolean {
264	let disable = false;
265	if (this.thyDisabledDate !== undefined) {
266	disable = this.thyDisabledDate(date.nativeDate);
267	}
268	const minDate = this.thyMinDate ? new TinyDate(transformDateValue(this.thyMinDate).value as Date) : null;
269	const maxDate = this.thyMaxDate ? new TinyDate(transformDateValue(this.thyMaxDate).value as Date) : null;
270	return (
271	(!minDate \|\| date.startOfDay().nativeDate >= minDate.startOfDay().nativeDate) &&
272	(!maxDate \|\| date.startOfDay().nativeDate <= maxDate.startOfDay().nativeDate) &&
273	!disable
274	);
275	}
276	}

atinc / ngx-tethys / de3a5667-4fb5-463e-a4f1-e76438188503

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