1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
/*
* SonarQube
* Copyright (C) 2009-2022 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
import * as React from 'react';
import PageActions from '../../components/ui/PageActions';
import { getComponentMeasureUniqueKey } from '../../helpers/component';
import { isInput, isShortcut } from '../../helpers/keyboardEventHelpers';
import { KeyboardKeys } from '../../helpers/keycodes';
import { ComponentMeasure } from '../../types/types';
import { getWrappedDisplayName } from './utils';
export interface WithKeyboardNavigationProps {
components?: ComponentMeasure[];
cycle?: boolean;
isFile?: boolean;
onEndOfList?: () => void;
onGoToParent?: () => void;
onHighlight?: (item: ComponentMeasure) => void;
onSelect?: (item: ComponentMeasure) => void;
selected?: ComponentMeasure;
}
export default function withKeyboardNavigation<P>(
WrappedComponent: React.ComponentClass<P & Partial<WithKeyboardNavigationProps>>
) {
return class Wrapper extends React.Component<P & WithKeyboardNavigationProps> {
static displayName = getWrappedDisplayName(WrappedComponent, 'withKeyboardNavigation');
componentDidMount() {
document.addEventListener('keydown', this.handleKeyDown);
}
componentWillUnmount() {
document.removeEventListener('keydown', this.handleKeyDown);
}
handleKeyDown = (event: KeyboardEvent) => {
if (isInput(event) || isShortcut(event)) {
return true;
}
if (event.key === KeyboardKeys.UpArrow) {
return this.skipIfFile(event, this.handleHighlightPrevious);
} else if (event.key === KeyboardKeys.DownArrow) {
return this.skipIfFile(event, this.handleHighlightNext);
} else if (event.key === KeyboardKeys.RightArrow || event.key === KeyboardKeys.Enter) {
return this.skipIfFile(event, this.handleSelectCurrent);
} else if (event.key === KeyboardKeys.LeftArrow) {
this.handleSelectParent();
return false; // always hijack left / Why did you put this @wouter?
}
return true;
};
getCurrentIndex = () => {
const { selected, components = [] } = this.props;
return selected
? components.findIndex(
(component) =>
getComponentMeasureUniqueKey(component) === getComponentMeasureUniqueKey(selected)
)
: -1;
};
skipIfFile = (event: KeyboardEvent, handler: () => void) => {
if (this.props.isFile) {
return true;
}
event.preventDefault();
handler();
return false;
};
handleHighlightNext = () => {
if (this.props.onHighlight === undefined) {
return;
}
const { components = [], cycle } = this.props;
const index = this.getCurrentIndex();
const first = cycle ? 0 : index;
this.props.onHighlight(
index < components.length - 1 ? components[index + 1] : components[first]
);
if (index + 1 === components.length - 1 && this.props.onEndOfList) {
this.props.onEndOfList();
}
};
handleHighlightPrevious = () => {
if (this.props.onHighlight === undefined) {
return;
}
const { components = [], cycle } = this.props;
const index = this.getCurrentIndex();
const last = cycle ? components.length - 1 : index;
this.props.onHighlight(index > 0 ? components[index - 1] : components[last]);
};
handleSelectCurrent = () => {
if (this.props.onSelect === undefined) {
return;
}
const { selected } = this.props;
if (selected !== undefined) {
this.props.onSelect(selected as ComponentMeasure);
}
};
handleSelectNext = () => {
if (this.props.onSelect === undefined) {
return;
}
const { components = [] } = this.props;
const index = this.getCurrentIndex();
if (index !== -1 && index < components.length - 1) {
this.props.onSelect(components[index + 1]);
}
};
handleSelectParent = () => {
if (this.props.onGoToParent !== undefined) {
this.props.onGoToParent();
}
};
handleSelectPrevious = () => {
if (this.props.onSelect === undefined) {
return;
}
const { components = [] } = this.props;
const index = this.getCurrentIndex();
if (components.length && index > 0) {
this.props.onSelect(components[index - 1]);
}
};
render() {
return (
<>
<PageActions showShortcuts={!this.props.isFile} />
<WrappedComponent {...this.props} />
</>
);
}
};
}
|
