c277b8e9-6950-414e-8795-16792af048b4

Committed 18 Dec 2023 05:41AM UTC coverage: 90.48% (+0.004%) from 90.476%

Build # c277b8e9-6950-414e-8795-16792af048b4

Build Type

push

circleci

Committed by

web-flow

Commit Message

feat(date-picker): support animations for date-picker, week-picker, month-picker, quarter-picker, year-picker, range-picker #INFR-10809 (#2975)

Run Details

5386 of 6616 branches covered (0.0%)

Branch coverage included in aggregate %.

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

22 existing lines in 2 files now uncovered.

13452 of 14204 relevant lines covered (94.71%)

979.78 hits per line

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

95.29

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

import { getFlexiblePositions, 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;
    @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;

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

atinc / ngx-tethys / c277b8e9-6950-414e-8795-16792af048b4

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