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

Fix for 'Scrolling doesn't work if done via keyboard' #215 #240

Merged
merged 1 commit into from
Dec 31, 2024
Merged

Fix for 'Scrolling doesn't work if done via keyboard' #215 #240

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
37 changes: 34 additions & 3 deletions packages/vanilla/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,9 @@ export default class SelectionArea extends EventTarget<SelectionEvents> {
private _scrollSpeed: Coordinates = {x: 0, y: 0};
private _scrollDelta: Coordinates = {x: 0, y: 0};

// Required for keydown scrolling
private _lastMousePosition = {x: 0, y: 0};

constructor(opt: PartialSelectionOptions) {
super();

Expand Down Expand Up @@ -330,7 +333,11 @@ export default class SelectionArea extends EventTarget<SelectionEvents> {
if (this._scrollAvailable) {

// Detect mouse scrolling
on(this._targetElement, 'wheel', this._manualScroll, {passive: false});
on(this._targetElement, 'wheel', this._wheelScroll, {passive: false});

// Detect keyboard scrolling
on(this._options.document, 'keydown', this._keyboardScroll, {passive: false});


/**
* The selection-area will also cover another element
Expand Down Expand Up @@ -403,6 +410,9 @@ export default class SelectionArea extends EventTarget<SelectionEvents> {
_areaLocation.x2 = x;
_areaLocation.y2 = y;

this._lastMousePosition.x = x;
this._lastMousePosition.y = y;

if (this._scrollAvailable && !this._scrollingActive && (_scrollSpeed.y || _scrollSpeed.x)) {

// Continuous scrolling
Expand Down Expand Up @@ -484,7 +494,7 @@ export default class SelectionArea extends EventTarget<SelectionEvents> {
off(this._targetElement, 'scroll', this._onStartAreaScroll);
}

_manualScroll(evt: ScrollEvent): void {
_wheelScroll(evt: ScrollEvent): void {
const {manualSpeed} = this._options.behaviour.scrolling;

// Consistent scrolling speed on all browsers
Expand All @@ -498,6 +508,24 @@ export default class SelectionArea extends EventTarget<SelectionEvents> {
evt.preventDefault();
}

_keyboardScroll(evt: KeyboardEvent): void {
const {manualSpeed} = this._options.behaviour.scrolling;

const deltaX = evt.key === 'ArrowLeft' ? -1 : evt.key === 'ArrowRight' ? 1 : 0;
const deltaY = evt.key === 'ArrowUp' ? -1 : evt.key === 'ArrowDown' ? 1 : 0;

this._scrollSpeed.x += Math.sign(deltaX) * manualSpeed;
this._scrollSpeed.y += Math.sign(deltaY) * manualSpeed;

evt.preventDefault();

this._onTapMove({
clientX: this._lastMousePosition.x,
clientY: this._lastMousePosition.y,
preventDefault: () => void 0,
} as ScrollEvent);
}

_recalculateSelectionAreaRect(): void {
const {_scrollSpeed, _areaLocation, _targetElement, _options} = this;
const {scrollTop, scrollHeight, clientHeight, scrollLeft, scrollWidth, clientWidth} = _targetElement as Element;
Expand Down Expand Up @@ -572,7 +600,10 @@ export default class SelectionArea extends EventTarget<SelectionEvents> {
this._scrollSpeed.y = 0;

// Unbind mouse scrolling listener
off(this._targetElement, 'wheel', this._manualScroll, {passive: true});
off(this._targetElement, 'wheel', this._wheelScroll, {passive: true});

// Unbind keyboard scrolling listener
off(this._options.document, 'keydown', this._keyboardScroll, {passive: true,});

// Remove selection-area from dom
this._clippingElement.remove();
Expand Down
Loading