Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(datepicker): export NgbDatepickerKeyboardService
- Loading branch information
1 parent
1057dbd
commit e5b3222
Showing
16 changed files
with
488 additions
and
246 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 changes: 3 additions & 0 deletions
3
demo/src/app/components/datepicker/demos/keyboard/datepicker-keyboard.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
<p>This datepicker uses alt instead of shift keyboard shortcuts.</p> | ||
|
||
<ngb-datepicker [(ngModel)]="model"></ngb-datepicker> |
15 changes: 15 additions & 0 deletions
15
demo/src/app/components/datepicker/demos/keyboard/datepicker-keyboard.module.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
import {NgModule} from '@angular/core'; | ||
import {FormsModule} from '@angular/forms'; | ||
import {BrowserModule} from '@angular/platform-browser'; | ||
import {NgbModule} from '@ng-bootstrap/ng-bootstrap'; | ||
|
||
import {NgbdDatepickerKeyboard} from './datepicker-keyboard'; | ||
|
||
@NgModule({ | ||
imports: [BrowserModule, FormsModule, NgbModule], | ||
declarations: [NgbdDatepickerKeyboard], | ||
exports: [NgbdDatepickerKeyboard], | ||
bootstrap: [NgbdDatepickerKeyboard] | ||
}) | ||
export class NgbdDatepickerKeyboardModule { | ||
} |
49 changes: 49 additions & 0 deletions
49
demo/src/app/components/datepicker/demos/keyboard/datepicker-keyboard.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
import {Component, Injectable} from '@angular/core'; | ||
import { | ||
NgbCalendar, | ||
NgbDatepicker, | ||
NgbDatepickerKeyboardService, | ||
NgbDateStruct | ||
} from '@ng-bootstrap/ng-bootstrap'; | ||
|
||
const Key = { | ||
PageUp: 'PageUp', | ||
PageDown: 'PageDown', | ||
End: 'End', | ||
Home: 'Home' | ||
}; | ||
|
||
@Injectable() | ||
export class CustomKeyboardService extends NgbDatepickerKeyboardService { | ||
processKey(event: KeyboardEvent, dp: NgbDatepicker, calendar: NgbCalendar) { | ||
const state = dp.state; | ||
switch (event.code) { | ||
case Key.PageUp: | ||
dp.focusDate(calendar.getNext(state.focusDate, event.altKey ? 'y' : 'm', -1)); | ||
break; | ||
case Key.PageDown: | ||
dp.focusDate(calendar.getNext(state.focusDate, event.altKey ? 'y' : 'm', 1)); | ||
break; | ||
case Key.End: | ||
dp.focusDate(event.altKey ? state.maxDate : state.lastDate); | ||
break; | ||
case Key.Home: | ||
dp.focusDate(event.altKey ? state.minDate : state.firstDate); | ||
break; | ||
default: | ||
super.processKey(event, dp, calendar); | ||
return; | ||
} | ||
event.preventDefault(); | ||
event.stopPropagation(); | ||
} | ||
} | ||
|
||
@Component({ | ||
selector: 'ngbd-datepicker-keyboard', | ||
templateUrl: './datepicker-keyboard.html', | ||
providers: [{provide: NgbDatepickerKeyboardService, useClass: CustomKeyboardService}] | ||
}) | ||
export class NgbdDatepickerKeyboard { | ||
model: NgbDateStruct; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,130 @@ | ||
import {NgbDatepicker, NgbDatepickerState} from './datepicker'; | ||
import {NgbDatepickerKeyboardService} from './datepicker-keyboard-service'; | ||
import {NgbCalendar, NgbCalendarGregorian} from './ngb-calendar'; | ||
import {TestBed} from '@angular/core/testing'; | ||
import {NgbDate} from './ngb-date'; | ||
import {Key} from '../util/key'; | ||
import {Type} from '@angular/core'; | ||
|
||
const event = (keyCode: number, shift = false) => | ||
<any>({which: keyCode, shiftKey: shift, preventDefault: () => {}, stopPropagation: () => {}}); | ||
|
||
describe('ngb-datepicker-keyboard-service', () => { | ||
|
||
let service: NgbDatepickerKeyboardService; | ||
let calendar: NgbCalendar; | ||
let mock: Partial<NgbDatepicker>; | ||
let processKey = function(e: KeyboardEvent) { service.processKey(e, mock as NgbDatepicker, calendar); }; | ||
let state: NgbDatepickerState = Object.assign({focusDate: {day: 1, month: 1, year: 2018}}); | ||
|
||
beforeEach(() => { | ||
TestBed.configureTestingModule( | ||
{providers: [{provide: NgbCalendar, useClass: NgbCalendarGregorian}, NgbDatepickerKeyboardService]}); | ||
|
||
calendar = TestBed.get(NgbCalendar as Type<NgbCalendar>); | ||
service = TestBed.get(NgbDatepickerKeyboardService); | ||
mock = {state, focusDate: () => {}, focusSelect: () => {}}; | ||
|
||
spyOn(mock, 'focusDate'); | ||
spyOn(mock, 'focusSelect'); | ||
spyOn(calendar, 'getNext'); | ||
}); | ||
|
||
it('should be instantiated', () => { expect(service).toBeTruthy(); }); | ||
|
||
it('should move focus by 1 day or 1 week with "Arrow" keys', () => { | ||
processKey(event(Key.ArrowUp)); | ||
expect(calendar.getNext).toHaveBeenCalledWith(state.focusDate, 'd', -7); | ||
|
||
processKey(event(Key.ArrowDown)); | ||
expect(calendar.getNext).toHaveBeenCalledWith(state.focusDate, 'd', 7); | ||
|
||
processKey(event(Key.ArrowLeft)); | ||
expect(calendar.getNext).toHaveBeenCalledWith(state.focusDate, 'd', -1); | ||
|
||
processKey(event(Key.ArrowRight)); | ||
expect(calendar.getNext).toHaveBeenCalledWith(state.focusDate, 'd', 1); | ||
|
||
expect(calendar.getNext).toHaveBeenCalledTimes(4); | ||
}); | ||
|
||
it('should move focus by 1 month or year "PgUp" and "PageDown"', () => { | ||
processKey(event(Key.PageUp)); | ||
expect(calendar.getNext).toHaveBeenCalledWith(state.focusDate, 'm', -1); | ||
|
||
processKey(event(Key.PageDown)); | ||
expect(calendar.getNext).toHaveBeenCalledWith(state.focusDate, 'm', 1); | ||
|
||
processKey(event(Key.PageUp, true)); | ||
expect(calendar.getNext).toHaveBeenCalledWith(state.focusDate, 'y', -1); | ||
|
||
processKey(event(Key.PageDown, true)); | ||
expect(calendar.getNext).toHaveBeenCalledWith(state.focusDate, 'y', 1); | ||
|
||
expect(calendar.getNext).toHaveBeenCalledTimes(4); | ||
}); | ||
|
||
it('should select focused date with "Space" and "Enter"', () => { | ||
processKey(event(Key.Enter)); | ||
processKey(event(Key.Space)); | ||
expect(mock.focusSelect).toHaveBeenCalledTimes(2); | ||
}); | ||
|
||
it('should move focus to the first and last days in the view with "Home" and "End"', () => { | ||
processKey(event(Key.Home)); | ||
expect(mock.focusDate).toHaveBeenCalledWith(undefined); | ||
|
||
processKey(event(Key.End)); | ||
expect(mock.focusDate).toHaveBeenCalledWith(undefined); | ||
|
||
Object.assign(state, {firstDate: new NgbDate(2017, 1, 1)}); | ||
Object.assign(state, {lastDate: new NgbDate(2017, 12, 1)}); | ||
|
||
processKey(event(Key.Home)); | ||
expect(mock.focusDate).toHaveBeenCalledWith(new NgbDate(2017, 1, 1)); | ||
|
||
processKey(event(Key.End)); | ||
expect(mock.focusDate).toHaveBeenCalledWith(new NgbDate(2017, 12, 1)); | ||
|
||
expect(mock.focusDate).toHaveBeenCalledTimes(4); | ||
}); | ||
|
||
it('should move focus to the "min" and "max" dates with "Home" and "End"', () => { | ||
processKey(event(Key.Home, true)); | ||
expect(mock.focusDate).toHaveBeenCalledWith(undefined); | ||
|
||
processKey(event(Key.End, true)); | ||
expect(mock.focusDate).toHaveBeenCalledWith(undefined); | ||
|
||
Object.assign(state, {minDate: new NgbDate(2017, 1, 1)}); | ||
Object.assign(state, {maxDate: new NgbDate(2017, 12, 1)}); | ||
|
||
processKey(event(Key.Home, true)); | ||
expect(mock.focusDate).toHaveBeenCalledWith(new NgbDate(2017, 1, 1)); | ||
|
||
processKey(event(Key.End, true)); | ||
expect(mock.focusDate).toHaveBeenCalledWith(new NgbDate(2017, 12, 1)); | ||
|
||
expect(mock.focusDate).toHaveBeenCalledTimes(4); | ||
}); | ||
|
||
it('should prevent default and stop propagation of the known key', () => { | ||
let e = event(Key.ArrowUp); | ||
spyOn(e, 'preventDefault'); | ||
spyOn(e, 'stopPropagation'); | ||
|
||
processKey(e); | ||
expect(e.preventDefault).toHaveBeenCalled(); | ||
expect(e.stopPropagation).toHaveBeenCalled(); | ||
|
||
// unknown key | ||
e = event(23); | ||
spyOn(e, 'preventDefault'); | ||
spyOn(e, 'stopPropagation'); | ||
|
||
processKey(e); | ||
expect(e.preventDefault).not.toHaveBeenCalled(); | ||
expect(e.stopPropagation).not.toHaveBeenCalled(); | ||
}); | ||
|
||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
import {Injectable} from '@angular/core'; | ||
import {NgbCalendar} from './ngb-calendar'; | ||
import {NgbDatepicker} from './datepicker'; | ||
import {Key} from '../util/key'; | ||
|
||
/** | ||
* A service that represents the keyboard navigation. | ||
* | ||
* The default navigation is documented in the overview. | ||
*/ | ||
@Injectable({providedIn: 'root'}) | ||
export class NgbDatepickerKeyboardService { | ||
/** | ||
* Processes a keyboard event. | ||
*/ | ||
processKey(event: KeyboardEvent, datepicker: NgbDatepicker, calendar: NgbCalendar) { | ||
const state = datepicker.state; | ||
// tslint:disable-next-line:deprecation | ||
switch (event.which) { | ||
case Key.PageUp: | ||
datepicker.focusDate(calendar.getNext(state.focusDate, event.shiftKey ? 'y' : 'm', -1)); | ||
break; | ||
case Key.PageDown: | ||
datepicker.focusDate(calendar.getNext(state.focusDate, event.shiftKey ? 'y' : 'm', 1)); | ||
break; | ||
case Key.End: | ||
datepicker.focusDate(event.shiftKey ? state.maxDate : state.lastDate); | ||
break; | ||
case Key.Home: | ||
datepicker.focusDate(event.shiftKey ? state.minDate : state.firstDate); | ||
break; | ||
case Key.ArrowLeft: | ||
datepicker.focusDate(calendar.getNext(state.focusDate, 'd', -1)); | ||
break; | ||
case Key.ArrowUp: | ||
datepicker.focusDate(calendar.getNext(state.focusDate, 'd', -calendar.getDaysPerWeek())); | ||
break; | ||
case Key.ArrowRight: | ||
datepicker.focusDate(calendar.getNext(state.focusDate, 'd', 1)); | ||
break; | ||
case Key.ArrowDown: | ||
datepicker.focusDate(calendar.getNext(state.focusDate, 'd', calendar.getDaysPerWeek())); | ||
break; | ||
case Key.Enter: | ||
case Key.Space: | ||
datepicker.focusSelect(); | ||
break; | ||
default: | ||
return; | ||
} | ||
event.preventDefault(); | ||
event.stopPropagation(); | ||
} | ||
} |
Oops, something went wrong.