20f0326e-4618-4976-beb0-32f79213d855

Committed 22 Dec 2023 06:24AM UTC coverage: 90.496% (+0.02%) from 90.477%

Build # 20f0326e-4618-4976-beb0-32f79213d855

Build Type

Pull #2984

circleci

Committed by

minlovehua

Commit Message

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

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

Run Details

5392 of 6623 branches covered (0.0%)

Branch coverage included in aggregate %.

16 of 20 new or added lines in 8 files covered. (80.0%)

5 existing lines in 3 files now uncovered.

13481 of 14232 relevant lines covered (94.72%)

979.08 hits per line

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

95.32

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

import { getFlexiblePositions, InputBoolean, ThyPlacement } from 'ngx-tethys/core';
import { TinyDate } from 'ngx-tethys/util';

import { CdkConnectedOverlay, CdkOverlayOrigin, ConnectedOverlayPositionChange } from '@angular/cdk/overlay';
import {
    AfterViewInit,
    ChangeDetectionStrategy,
    ChangeDetectorRef,
    Component,
    ElementRef,
    EventEmitter,
    Input,
    OnChanges,
    Output,
    SimpleChanges,
    ViewChild
} from '@angular/core';

import { AsyncPipe, NgClass, NgIf, NgTemplateOutlet } from '@angular/common';
import { ThyIconComponent } from 'ngx-tethys/icon';
import { ThyInputDirective } from 'ngx-tethys/input';
import { DateHelperService } from './date-helper.service';
import { CompatibleValue, RangePartType } from './inner-types';
import { getFlexibleAdvancedReadableValue } from './picker.util';
import { ThyDateGranularity } from './standard-types';
import { ThyEnterDirective } from 'ngx-tethys/shared';
import { scaleMotion, scaleXMotion, scaleYMotion } from 'ngx-tethys/core';

/**
 * @private
 */
@Component({
    selector: 'thy-picker',
    exportAs: 'thyPicker',
    templateUrl: './picker.component.html',
    changeDetection: ChangeDetectionStrategy.OnPush,
    standalone: true,
    imports: [
        CdkOverlayOrigin,
        ThyInputDirective,
        ThyEnterDirective,
        AsyncPipe,
        NgTemplateOutlet,
        NgIf,
        ThyIconComponent,
        NgClass,
        CdkConnectedOverlay
    ],
    animations: [scaleXMotion, scaleYMotion, scaleMotion]
})
export class ThyPickerComponent implements OnChanges, AfterViewInit {
    @Input() isRange = false;
    @Input() open: boolean | undefined = undefined;
    @Input() disabled: boolean;
    @Input() placeholder: string | string[];
    @Input() readonly: boolean;
    @Input() allowClear: boolean;
    @Input() autoFocus: boolean;
    @Input() className: string;
    @Input() size: 'sm' | 'xs' | 'lg' | 'md' | 'default';
    @Input() suffixIcon: string;
    @Input() placement: ThyPlacement = 'bottomLeft';
    @Input() flexible: boolean = false;
    @Input() mode: string;
    @Input() @InputBoolean() hasBackdrop: boolean;
    @Output() blur = new EventEmitter<Event>();
    @Output() readonly valueChange = new EventEmitter<TinyDate | TinyDate[] | null>();
    @Output() readonly openChange = new EventEmitter<boolean>(); // Emitted when overlay's open state change
    @Output() readonly inputChange = new EventEmitter<string>();

    @ViewChild('origin', { static: true }) origin: CdkOverlayOrigin;
    @ViewChild(CdkConnectedOverlay, { static: true }) cdkConnectedOverlay: CdkConnectedOverlay;
    @ViewChild('pickerInput', { static: true }) pickerInput: ElementRef;
    @ViewChild('overlayContainer', { static: false }) overlayContainer: ElementRef<HTMLElement>;

    @Input()
    get format() {
        return this.innerFormat;
    }

    set format(value: string) {
        this.innerFormat = value;
        this.updateReadableDate(this.innerValue);
    }

    @Input()
    get flexibleDateGranularity() {
        return this.innerflexibleDateGranularity;
    }

    set flexibleDateGranularity(granularity: ThyDateGranularity) {
        this.innerflexibleDateGranularity = granularity;
        this.updateReadableDate(this.innerValue);
    }

    @Input()
    get value() {
        return this.innerValue;
    }

    set value(value: TinyDate | TinyDate[] | null) {
        this.innerValue = value;
        if (!this.entering) {
            this.updateReadableDate(this.innerValue);
        }
    }

    private innerflexibleDateGranularity: ThyDateGranularity;

    private innerFormat: string;

    private innerValue: TinyDate | TinyDate[] | null;

    entering = false;

    prefixCls = 'thy-calendar';

    isShowDatePopup = false;

    overlayOpen = false; // Available when "open"=undefined

    overlayPositions = getFlexiblePositions(this.placement, 4);

    get realOpenState(): boolean {
        // The value that really decide the open state of overlay
        return this.isOpenHandledByUser() ? !!this.open : this.overlayOpen;
    }

    get readonlyState(): boolean {
        return this.isRange || this.readonly || this.mode !== 'date';
    }

    constructor(private changeDetector: ChangeDetectorRef, private dateHelper: DateHelperService) {}

    ngOnChanges(changes: SimpleChanges): void {
        // open by user
        if (changes.open && changes.open.currentValue !== undefined) {
            if (changes.open.currentValue) {
                this.showDatePopup();
            } else {
                this.closeDatePopup();
            }
        }
    }

    ngAfterViewInit(): void {
        this.overlayPositions = getFlexiblePositions(this.placement, 4);
        if (this.autoFocus) {
            this.focus();
        }
    }

    focus(): void {
        this.pickerInput.nativeElement.focus();
    }

    onBlur(event: FocusEvent) {
        this.blur.emit(event);
        if (this.entering) {
            this.valueChange.emit(this.pickerInput.nativeElement.value);
        }
        this.entering = false;
    }

    onInput(event: InputEvent) {
        this.entering = true;
        const inputValue = (event.target as HTMLElement)['value'];
        this.inputChange.emit(inputValue);
    }

    onEnter() {
        if (this.readonlyState) {
            return;
        }
        this.valueChange.emit(this.pickerInput.nativeElement.value || this.getReadableValue(new TinyDate(new Date())));
        this.entering = false;
    }

    showOverlay(): void {
        if (!this.realOpenState) {
            this.overlayOpen = true;
            this.showDatePopup();

            this.openChange.emit(this.overlayOpen);
            setTimeout(() => {
                if (this.cdkConnectedOverlay && this.cdkConnectedOverlay.overlayRef) {
                    this.cdkConnectedOverlay.overlayRef.updatePosition();
                }
            });
        }
    }

    hideOverlay(): void {
        if (this.realOpenState) {
            this.overlayOpen = false;
            this.closeDatePopup();

            this.openChange.emit(this.overlayOpen);
            this.focus();
        }
    }

    showDatePopup() {
        this.isShowDatePopup = true;
        this.changeDetector.markForCheck();
    }

    closeDatePopup() {
        // Delay 200ms before destroying the date-popup, otherwise you will not see the closing animation.
        setTimeout(() => {
            this.isShowDatePopup = false;
            this.changeDetector.markForCheck();
        }, 200);
    }

    onClickInputBox(): void {
        if (!this.disabled && !this.readonly && !this.isOpenHandledByUser()) {
            this.showOverlay();
        }
    }

    onClickBackdrop(): void {
        this.hideOverlay();
    }

    onOverlayDetach(): void {
        this.hideOverlay();
    }

    onPositionChange(position: ConnectedOverlayPositionChange): void {
        this.changeDetector.detectChanges();
    }

    onClickClear(event: MouseEvent): void {
        event.preventDefault();
        event.stopPropagation();

        this.innerValue = this.isRange ? [] : null;
        this.valueChange.emit(this.innerValue);
    }

    getPartTypeIndex(partType: RangePartType): number {
        return { left: 0, right: 1 }[partType];
    }

    isEmptyValue(value: CompatibleValue | null): boolean {
        if (value === null) {
            return true;
        } else if (this.isRange) {
            return !value || !Array.isArray(value) || value.every(val => !val);
        } else {
            return !value;
        }
    }

    // Whether open state is permanently controlled by user himself
    isOpenHandledByUser(): boolean {
        return this.open !== undefined;
    }

    getReadableValue(tinyDate: TinyDate | TinyDate[]): string | null {
        let value: TinyDate;
        if (this.isRange) {
            if (this.flexible && this.innerflexibleDateGranularity !== 'day') {
                return getFlexibleAdvancedReadableValue(tinyDate as TinyDate[], this.innerflexibleDateGranularity);
            } else {
                const start = tinyDate[0] ? this.formatDate(tinyDate[0]) : '';
                const end = tinyDate[1] ? this.formatDate(tinyDate[1]) : '';
                return start && end ? `${start} ~ ${end}` : null;
            }
        } else {
            value = tinyDate as TinyDate;
            return value ? this.formatDate(value) : null;
        }
    }

    formatDate(value: TinyDate) {
        // dateHelper.format() 使用的是 angular 的 format，不支持季度，修改的话，改动比较大。
        // 此处通过对 innerFormat 做下判断，如果是季度的 format，使用 date-fns 的 format()
        if (this.innerFormat && (this.innerFormat.includes('q') || this.innerFormat.includes('Q'))) {
            return value.format(this.innerFormat);
        } else {
            return this.dateHelper.format(value.nativeDate, this.innerFormat);
        }
    }

    getPlaceholder(): string {
        return this.isRange && this.placeholder && Array.isArray(this.placeholder)
            ? (this.placeholder as string[]).join(' ~ ')
            : (this.placeholder as string);
    }

    private updateReadableDate(setValue: TinyDate | TinyDate[] | null) {
        const readableValue = this.getReadableValue(setValue);
        if (readableValue === this.pickerInput.nativeElement['value']) {
            return;
        }

        this.pickerInput.nativeElement.value = readableValue;
    }
}

1	import { getFlexiblePositions, InputBoolean, ThyPlacement } from 'ngx-tethys/core';
2	import { TinyDate } from 'ngx-tethys/util';
3
4	import { CdkConnectedOverlay, CdkOverlayOrigin, ConnectedOverlayPositionChange } from '@angular/cdk/overlay';
5	import {
6	AfterViewInit,
7	ChangeDetectionStrategy,
8	ChangeDetectorRef,
9	Component,
10	ElementRef,
11	EventEmitter,
12	Input,
13	OnChanges,
14	Output,
15	SimpleChanges,
16	ViewChild
17	} from '@angular/core';	1✔
18
19	import { AsyncPipe, NgClass, NgIf, NgTemplateOutlet } from '@angular/common';	×
20	import { ThyIconComponent } from 'ngx-tethys/icon';
21	import { ThyInputDirective } from 'ngx-tethys/input';
22	import { DateHelperService } from './date-helper.service';	160✔
23	import { CompatibleValue, RangePartType } from './inner-types';	160✔
24	import { getFlexibleAdvancedReadableValue } from './picker.util';
25	import { ThyDateGranularity } from './standard-types';
26	import { ThyEnterDirective } from 'ngx-tethys/shared';	×
27	import { scaleMotion, scaleXMotion, scaleYMotion } from 'ngx-tethys/core';
28
29	/**	164✔
30	* @private	164✔
31	*/
32	@Component({
33	selector: 'thy-picker',	763✔
34	exportAs: 'thyPicker',
35	templateUrl: './picker.component.html',
36	changeDetection: ChangeDetectionStrategy.OnPush,	319✔
37	standalone: true,	319✔
38	imports: [	311✔
39	CdkOverlayOrigin,
40	ThyInputDirective,
41	ThyEnterDirective,
42	AsyncPipe,
43	NgTemplateOutlet,	1,011✔
44	NgIf,
45	ThyIconComponent,
46	NgClass,	772✔
47	CdkConnectedOverlay
48	],
49	animations: [scaleXMotion, scaleYMotion, scaleMotion]	158✔
50	})	158✔
51	export class ThyPickerComponent implements OnChanges, AfterViewInit {	158✔
52	@Input() isRange = false;	158✔
53	@Input() open: boolean \| undefined = undefined;	158✔
54	@Input() disabled: boolean;	158✔
55	@Input() placeholder: string \| string[];	158✔
56	@Input() readonly: boolean;	158✔
57	@Input() allowClear: boolean;	158✔
58	@Input() autoFocus: boolean;	158✔
59	@Input() className: string;	158✔
60	@Input() size: 'sm' \| 'xs' \| 'lg' \| 'md' \| 'default';	158✔
61	@Input() suffixIcon: string;	158✔
62	@Input() placement: ThyPlacement = 'bottomLeft';	158✔
63	@Input() flexible: boolean = false;	158✔
64	@Input() mode: string;
65	@Input() @InputBoolean() hasBackdrop: boolean;
66	@Output() blur = new EventEmitter<Event>();
67	@Output() readonly valueChange = new EventEmitter<TinyDate \| TinyDate[] \| null>();	334✔
68	@Output() readonly openChange = new EventEmitter<boolean>(); // Emitted when overlay's open state change	8✔
69	@Output() readonly inputChange = new EventEmitter<string>();	5✔
70
71	@ViewChild('origin', { static: true }) origin: CdkOverlayOrigin;
72	@ViewChild(CdkConnectedOverlay, { static: true }) cdkConnectedOverlay: CdkConnectedOverlay;	3✔
73	@ViewChild('pickerInput', { static: true }) pickerInput: ElementRef;
74	@ViewChild('overlayContainer', { static: false }) overlayContainer: ElementRef<HTMLElement>;
75
76	@Input()
77	get format() {	158✔
78	return this.innerFormat;	158✔
79	}	1✔
80
81	set format(value: string) {
82	this.innerFormat = value;
83	this.updateReadableDate(this.innerValue);	59✔
84	}
85
86	@Input()	5✔
87	get flexibleDateGranularity() {	5!
88	return this.innerflexibleDateGranularity;	5✔
89	}
90		5✔
91	set flexibleDateGranularity(granularity: ThyDateGranularity) {
92	this.innerflexibleDateGranularity = granularity;
93	this.updateReadableDate(this.innerValue);	17✔
94	}	17✔
95		17✔
96	@Input()
97	get value() {
98	return this.innerValue;	8!
UNCOV 99	}	×
100
101	set value(value: TinyDate \| TinyDate[] \| null) {	8!
102	this.innerValue = value;	8✔
103	if (!this.entering) {
104	this.updateReadableDate(this.innerValue);
105	}	124✔
106	}	123✔
107		123✔
108	private innerflexibleDateGranularity: ThyDateGranularity;	123✔
109		123✔
110	private innerFormat: string;	123!
111		123✔
112	private innerValue: TinyDate \| TinyDate[] \| null;
113
114	entering = false;
115
116	prefixCls = 'thy-calendar';
117		111✔
118	isShowDatePopup = false;	57✔
119		57✔
120	overlayOpen = false; // Available when "open"=undefined	57✔
121		57✔
122	overlayPositions = getFlexiblePositions(this.placement, 4);
123
124	get realOpenState(): boolean {
125	// The value that really decide the open state of overlay	128✔
126	return this.isOpenHandledByUser() ? !!this.open : this.overlayOpen;	128✔
127	}
128
129	get readonlyState(): boolean {
130	return this.isRange \|\| this.readonly \|\| this.mode !== 'date';	60✔
131	}	60✔
132		60✔
133	constructor(private changeDetector: ChangeDetectorRef, private dateHelper: DateHelperService) {}
134
135	ngOnChanges(changes: SimpleChanges): void {
136	// open by user	127✔
137	if (changes.open && changes.open.currentValue !== undefined) {	124✔
138	if (changes.open.currentValue) {
139	this.showDatePopup();
140	} else {
141	this.closeDatePopup();	12✔
142	}
143	}
144	}	52✔
145
146	ngAfterViewInit(): void {
147	this.overlayPositions = getFlexiblePositions(this.placement, 4);	240✔
148	if (this.autoFocus) {
149	this.focus();
150	}	6✔
151	}	6✔
152		6✔
153	focus(): void {	6✔
154	this.pickerInput.nativeElement.focus();
155	}
UNCOV 156		×
157	onBlur(event: FocusEvent) {
158	this.blur.emit(event);
159	if (this.entering) {	763✔
160	this.valueChange.emit(this.pickerInput.nativeElement.value);	311✔
161	}
162	this.entering = false;	452✔
163	}	291✔
164
165	onInput(event: InputEvent) {
166	this.entering = true;	161✔
167	const inputValue = (event.target as HTMLElement)['value'];
168	this.inputChange.emit(inputValue);
169	}
170
171	onEnter() {	1,138✔
172	if (this.readonlyState) {
173	return;
174	}
175	this.valueChange.emit(this.pickerInput.nativeElement.value \|\| this.getReadableValue(new TinyDate(new Date())));	684✔
176	this.entering = false;	270✔
177	}	46✔
178
179	showOverlay(): void {
180	if (!this.realOpenState) {	224✔
181	this.overlayOpen = true;	224✔
182	this.showDatePopup();	224✔
183
184	this.openChange.emit(this.overlayOpen);
185	setTimeout(() => {
186	if (this.cdkConnectedOverlay && this.cdkConnectedOverlay.overlayRef) {	414✔
187	this.cdkConnectedOverlay.overlayRef.updatePosition();	414✔
188	}
189	});
190	}
191	}
192
193	hideOverlay(): void {	206✔
194	if (this.realOpenState) {	13✔
195	this.overlayOpen = false;
196	this.closeDatePopup();
197		193✔
198	this.openChange.emit(this.overlayOpen);
199	this.focus();
200	}
201	}	763✔
202
203	showDatePopup() {
204	this.isShowDatePopup = true;
205	this.changeDetector.markForCheck();
206	}	635✔
207		635✔
208	closeDatePopup() {	40✔
209	// Delay 200ms before destroying the date-popup, otherwise you will not see the closing animation.
210	setTimeout(() => {	595✔
211	this.isShowDatePopup = false;
212	this.changeDetector.markForCheck();	1✔
213	}, 200);
214	}
215
216	onClickInputBox(): void {	1✔
217	if (!this.disabled && !this.readonly && !this.isOpenHandledByUser()) {
218	this.showOverlay();
219	}
220	}
221
222	onClickBackdrop(): void {
223	this.hideOverlay();
224	}
225
226	onOverlayDetach(): void {
227	this.hideOverlay();
228	}
229
230	onPositionChange(position: ConnectedOverlayPositionChange): void {
231	this.changeDetector.detectChanges();
232	}
233
234	onClickClear(event: MouseEvent): void {
235	event.preventDefault();
236	event.stopPropagation();
237
238	this.innerValue = this.isRange ? [] : null;
239	this.valueChange.emit(this.innerValue);
240	}
241
242	getPartTypeIndex(partType: RangePartType): number {
243	return { left: 0, right: 1 }[partType];
244	}	1✔
245
246	isEmptyValue(value: CompatibleValue \| null): boolean {
247	if (value === null) {
248	return true;	1✔
249	} else if (this.isRange) {
250	return !value \|\| !Array.isArray(value) \|\| value.every(val => !val);
251	} else {
252	return !value;
253	}
254	}
255
256	// Whether open state is permanently controlled by user himself
257	isOpenHandledByUser(): boolean {
258	return this.open !== undefined;
259	}
260
261	getReadableValue(tinyDate: TinyDate \| TinyDate[]): string \| null {
262	let value: TinyDate;
263	if (this.isRange) {
264	if (this.flexible && this.innerflexibleDateGranularity !== 'day') {
265	return getFlexibleAdvancedReadableValue(tinyDate as TinyDate[], this.innerflexibleDateGranularity);
266	} else {
267	const start = tinyDate[0] ? this.formatDate(tinyDate[0]) : '';
268	const end = tinyDate[1] ? this.formatDate(tinyDate[1]) : '';
269	return start && end ? `${start} ~ ${end}` : null;
270	}
271	} else {
272	value = tinyDate as TinyDate;
273	return value ? this.formatDate(value) : null;
274	}
275	}
276
277	formatDate(value: TinyDate) {
278	// dateHelper.format() 使用的是 angular 的 format，不支持季度，修改的话，改动比较大。
279	// 此处通过对 innerFormat 做下判断，如果是季度的 format，使用 date-fns 的 format()
280	if (this.innerFormat && (this.innerFormat.includes('q') \|\| this.innerFormat.includes('Q'))) {
281	return value.format(this.innerFormat);
282	} else {
283	return this.dateHelper.format(value.nativeDate, this.innerFormat);
284	}
285	}
286
287	getPlaceholder(): string {
288	return this.isRange && this.placeholder && Array.isArray(this.placeholder)
289	? (this.placeholder as string[]).join(' ~ ')
290	: (this.placeholder as string);
291	}
292
293	private updateReadableDate(setValue: TinyDate \| TinyDate[] \| null) {
294	const readableValue = this.getReadableValue(setValue);
295	if (readableValue === this.pickerInput.nativeElement['value']) {
296	return;
297	}
298
299	this.pickerInput.nativeElement.value = readableValue;
300	}
301	}

atinc / ngx-tethys / 20f0326e-4618-4976-beb0-32f79213d855

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