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.

Sign up for GitHub

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

Jump to bottom

fix(module:date-picker): open on enter and focus on inner input #3804

Merged
merged 1 commit into from
Aug 6, 2019
Merged

fix(module:date-picker): open on enter and focus on inner input #3804

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions components/date-picker/lib/calendar/calendar-input.component.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
placeholder="{{ placeholder || locale.dateSelect }}"
value="{{ toReadableInput(value) }}"
(keyup)="onInputKeyup($event)"
#inputElement
/>
</div>
<a class="{{ prefixCls }}-clear-btn" role="button" title="{{ locale.clear }}">
Expand Down
15 changes: 11 additions & 4 deletions components/date-picker/lib/calendar/calendar-input.component.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,12 @@
import {
ChangeDetectionStrategy,
Component,
ElementRef,
EventEmitter,
Input,
OnInit,
Output,
ViewChild,
ViewEncapsulation
} from '@angular/core';

Expand All @@ -34,24 +36,29 @@ export class CalendarInputComponent implements OnInit {
@Input() disabledDate: (d: Date) => boolean;

@Input() value: CandyDate;
@Input() autoFocus: boolean;
@Output() readonly valueChange = new EventEmitter<CandyDate>();
@ViewChild('inputElement', { static: true }) inputRef: ElementRef;

prefixCls: string = 'ant-calendar';
invalidInputClass: string = '';

constructor(private dateHelper: DateHelperService) {}

ngOnInit(): void {}
ngOnInit(): void {
if (this.autoFocus) {
this.inputRef.nativeElement.focus();
}
}

onInputKeyup(event: Event): void {
onInputKeyup(event: KeyboardEvent): void {
const date = this.checkValidInputDate(event);

if (!date || (this.disabledDate && this.disabledDate(date.nativeDate))) {
return;
}

if (!date.isSame(this.value, 'second')) {
// Not same with original value
if (event.key === 'Enter') {
this.value = date;
this.valueChange.emit(this.value);
}
Expand Down
1 change: 1 addition & 0 deletions components/date-picker/lib/popups/date-range-popup.component.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
[locale]="locale"
[disabledDate]="disabledDate"
[format]="format"
[autoFocus]="partType !== 'right'"
[placeholder]="getPlaceholder(partType)"
></calendar-input>
</ng-template>
Expand Down
73 changes: 72 additions & 1 deletion components/date-picker/nz-date-picker.component.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,62 @@ describe('NzDatePickerComponent', () => {
expect(getPickerContainer()).toBeNull();
}));

it('should focus on the trigger after a click outside', fakeAsync(() => {
fixture.detectChanges();
openPickerByClickTrigger();

dispatchMouseEvent(queryFromOverlay('.cdk-overlay-backdrop'), 'click');
fixture.detectChanges();
tick(500);
fixture.detectChanges();
expect(document.activeElement).toEqual(getPickerTrigger());
}));

it('should open on enter', fakeAsync(() => {
fixture.detectChanges();
getPickerTriggerWrapper().dispatchEvent(new KeyboardEvent('keyup', { key: 'enter' }));
fixture.detectChanges();
tick(500);
fixture.detectChanges();
expect(getPickerContainer()).not.toBeNull();
}));

it('should open by click and focus on inner calendar input', fakeAsync(() => {
fixture.detectChanges();
openPickerByClickTrigger();
expect(document.activeElement).toEqual(queryFromOverlay('input.ant-calendar-input'));
}));

it('should open by click, focus on inner calendar input, and submit on enter', fakeAsync(() => {
fixtureInstance.nzValue = new Date();
fixture.detectChanges();
// Do it 2 times to normalize the value of the element.
const action = () => {
openPickerByClickTrigger();
expect(document.activeElement).toEqual(queryFromOverlay('input.ant-calendar-input'));
queryFromOverlay('input.ant-calendar-input').dispatchEvent(new KeyboardEvent('keyup', { key: 'Enter' }));
fixture.detectChanges();
tick(500);
fixture.detectChanges();
expect(getPickerContainer()).toBeNull();
};
action();
action();
}));

it('should not submit with invalid input', fakeAsync(() => {
fixture.detectChanges();
openPickerByClickTrigger();
const input = queryFromOverlay('input.ant-calendar-input') as HTMLInputElement;
input.value = 'invalid input';
fixture.detectChanges();
input.dispatchEvent(new KeyboardEvent('keyup', { key: 'Enter' }));
fixture.detectChanges();
tick(500);
fixture.detectChanges();
expect(getPickerContainer()).not.toBeNull();
}));

it('should support changing language at runtime', fakeAsync(() => {
fixture.detectChanges();
expect(getPickerTrigger().placeholder).toBe('请选择日期');
Expand Down Expand Up @@ -197,6 +253,21 @@ describe('NzDatePickerComponent', () => {
fixture.detectChanges();
const disabledCell = queryFromOverlay('tbody.ant-calendar-tbody td.ant-calendar-disabled-cell');
expect(disabledCell.textContent!.trim()).toBe('15');
const input = queryFromOverlay('input.ant-calendar-input') as HTMLInputElement;
const submit = (date: string) => {
input.value = date;
fixture.detectChanges();
input.dispatchEvent(new KeyboardEvent('keyup', { key: 'Enter' }));
fixture.detectChanges();
tick(500);
fixture.detectChanges();
};
// Should fail to submit a disabled date
submit('2018-11-15');
expect(getPickerContainer()).not.toBeNull();
// But it should be fine to submit an enabled date
submit('2018-11-11');
expect(getPickerContainer()).toBeNull();
}));

it('should support nzLocale', () => {
Expand Down Expand Up @@ -719,7 +790,7 @@ describe('NzDatePickerComponent', () => {

// Correct inputing
input.value = '2018-11-22';
input.dispatchEvent(new KeyboardEvent('keyup'));
input.dispatchEvent(new KeyboardEvent('keyup', { key: 'Enter' }));
// dispatchKeyboardEvent(input, 'keyup', ENTER); // Not working?
fixture.detectChanges();
flush();
Expand Down
9 changes: 9 additions & 0 deletions components/date-picker/nz-month-picker.component.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,15 @@ describe('NzMonthPickerComponent', () => {
expect(getPickerContainer()).toBeNull();
}));

it('should open on enter', fakeAsync(() => {
fixture.detectChanges();
getPickerTriggerWrapper().dispatchEvent(new KeyboardEvent('keyup', { key: 'enter' }));
fixture.detectChanges();
tick(500);
fixture.detectChanges();
expect(getPickerContainer()).not.toBeNull();
}));

it('should support nzAllowClear and work properly', fakeAsync(() => {
const clearBtnSelector = By.css('nz-picker i.ant-calendar-picker-clear');
const initial = (fixtureInstance.nzValue = new Date());
Expand Down
30 changes: 28 additions & 2 deletions components/date-picker/nz-range-picker.component.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,32 @@ describe('NzRangePickerComponent', () => {
expect(getPickerContainer()).toBeNull();
}));

it('should focus on the trigger after a click outside', fakeAsync(() => {
fixture.detectChanges();
openPickerByClickTrigger();

dispatchMouseEvent(queryFromOverlay('.cdk-overlay-backdrop'), 'click');
fixture.detectChanges();
tick(500);
fixture.detectChanges();
expect(getPickerTrigger().matches(':focus-within')).toBeTruthy();
}));

it('should open on enter', fakeAsync(() => {
fixture.detectChanges();
getPickerTriggerWrapper().dispatchEvent(new KeyboardEvent('keyup', { key: 'enter' }));
fixture.detectChanges();
tick(500);
fixture.detectChanges();
expect(getPickerContainer()).not.toBeNull();
}));

it('should open by click and focus on left inner calendar input', fakeAsync(() => {
fixture.detectChanges();
openPickerByClickTrigger();
expect(document.activeElement).toEqual(queryFromOverlay('.ant-calendar-range-left input.ant-calendar-input'));
}));

it('should support nzAllowClear and work properly', fakeAsync(() => {
const clearBtnSelector = By.css('nz-picker i.ant-calendar-picker-clear');
const initial = (fixtureInstance.modelValue = [new Date(), new Date()]);
Expand Down Expand Up @@ -643,10 +669,10 @@ describe('NzRangePickerComponent', () => {
const rightInput = queryFromOverlay('.ant-calendar-range-right input.ant-calendar-input') as HTMLInputElement;

leftInput.value = '2018-11-11';
leftInput.dispatchEvent(new KeyboardEvent('keyup'));
leftInput.dispatchEvent(new KeyboardEvent('keyup', {key: 'Enter'}));
fixture.detectChanges();
rightInput.value = '2018-12-12';
rightInput.dispatchEvent(new KeyboardEvent('keyup'));
rightInput.dispatchEvent(new KeyboardEvent('keyup', {key: 'Enter'}));
fixture.detectChanges();
tick(500);
expect(nzOnChange).toHaveBeenCalled();
Expand Down
9 changes: 9 additions & 0 deletions components/date-picker/nz-year-picker.component.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,15 @@ describe('NzYearPickerComponent', () => {
expect(getPickerContainer()).toBeNull();
}));

it('should open on enter', fakeAsync(() => {
fixture.detectChanges();
getPickerTriggerWrapper().dispatchEvent(new KeyboardEvent('keyup', { key: 'enter' }));
fixture.detectChanges();
tick(500);
fixture.detectChanges();
expect(getPickerContainer()).not.toBeNull();
}));

it('should support nzAllowClear and work properly', fakeAsync(() => {
const clearBtnSelector = By.css('nz-picker i.ant-calendar-picker-clear');
const initial = (fixtureInstance.nzValue = new Date());
Expand Down
1 change: 1 addition & 0 deletions components/date-picker/picker.component.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
[ngStyle]="style"
tabindex="0"
(click)="onClickInputBox()"
(keyup.enter)="onClickInputBox()"
>
<!-- Content of single picker -->
<ng-container *ngIf="!isRange">
Expand Down
21 changes: 13 additions & 8 deletions components/date-picker/picker.component.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,14 +105,18 @@ export class NzPickerComponent implements OnInit, AfterViewInit {

ngAfterViewInit(): void {
if (this.autoFocus) {
if (this.isRange) {
const firstInput = (this.pickerInput.nativeElement as HTMLElement).querySelector(
'input:first-child'
) as HTMLInputElement;
firstInput.focus(); // Focus on the first input
} else {
this.pickerInput.nativeElement.focus();
}
this.focus();
}
}

focus(): void {
if (this.isRange) {
const firstInput = (this.pickerInput.nativeElement as HTMLElement).querySelector(
'input:first-child'
) as HTMLInputElement;
firstInput.focus(); // Focus on the first input
} else {
this.pickerInput.nativeElement.focus();
}
}

Expand All @@ -133,6 +137,7 @@ export class NzPickerComponent implements OnInit, AfterViewInit {
if (this.realOpenState) {
this.overlayOpen = false;
this.openChange.emit(this.overlayOpen);
this.focus();
Copy link
Member

@wenqi73 wenqi73 Jul 16, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should need a test for focus.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added 'should focus on the trigger after a click outside' tests

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image
is this function implemented? The pop-up date box automatically captures the focus inside and can be entered by the keyboard

}
}

Expand Down