-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.ts
235 lines (207 loc) · 7.65 KB
/
index.ts
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
export interface Center {
x: number;
y: number;
left: number;
top: number;
right: number;
bottom: number;
width: number;
height: number;
}
export interface Rect {
left: number;
top: number;
right: number;
bottom: number;
width: number;
height: number;
element: HTMLElement;
center: Center;
}
export type Partition = Rect[][];
interface DistanceFunction {
(rect: Rect): number;
}
export interface DistanceFunctions {
nearPlumbLineIsBetter: DistanceFunction;
nearHorizonIsBetter: DistanceFunction;
nearTargetLeftIsBetter: DistanceFunction;
nearTargetTopIsBetter: DistanceFunction;
topIsBetter: DistanceFunction;
bottomIsBetter: DistanceFunction;
leftIsBetter: DistanceFunction;
rightIsBetter: DistanceFunction;
}
export interface Priority {
group: Rect[];
distance: DistanceFunction[];
}
export type EnterTo = 'calculated' | 'last-focused' | 'default-element';
export type NavigationKeyCodes = 'ArrowLeft' | 'ArrowUp' | 'ArrowRight' | 'ArrowDown';
export type Restrict = 'none' | 'self-only' | 'self-first';
export type Direction = 'left' | 'right' | 'up' | 'down';
export type LeaveForDirection = 'left' | 'right' | 'up' | 'down';
/**
* Навигация на элемент найденному c помощью document.querySelector(result), где result — это валидный селектор.
*/
type LeaveForActionQueryString = {
type: 'query-selector';
result: string;
};
/**
* Навигация в секцию.
*/
type LeaveForActionSectionId = {
type: 'section-name';
result: string;
};
/**
* Навигация не происходит.
*/
type LeaveForActionNoNavigation = {
type: 'no-spatnav-navigation';
result: null;
};
/**
* Навигация на элемент.
*/
type LeaveForActionElement = {
type: 'element';
result: HTMLElement;
};
/**
* Обычное поведение spatnav.
*/
type LeaveForActionDefault = {
type: 'fallback-to-spatnav';
result: null;
};
/**
* Коллбэк, срабатывающий при выходе из секции
*/
export interface LeaveForGetter {
(rootElement: HTMLElement, sectionId: string):
| LeaveForActionQueryString
| LeaveForActionSectionId
| LeaveForActionNoNavigation
| LeaveForActionElement
| LeaveForActionDefault;
}
type LeaveFor = Partial<Record<Direction, LeaveForGetter>>;
export type SimpleSectionOptions = {
type: 'row' | 'column';
};
export type Config = {
/**
* Spatial Navigation будет искать только элементы, лежащие на одной линии (вертикально или горизонтально) с текущим активным элементом
*
* По умолчанию считается только элементы лежащие пиксель в пиксель на одной линии.
*
* Если `straightOnly` нажатия вниз элемент `next` будет пропущен и будет выбран `real next`
*
* @example
* ```
* ┏━━━━━━━━━┓
* ┃ focused ┃
* ┗━━━━━━━━━┛
* ↓
* ┏━━━━━━━┓ ↓
* ┃ next? ┃ ↓
* ┗━━━━━━━┛ ↓
* ↓
* ┏━━━━━━━━━━━┓
* ┃ real next ┃
* ┗━━━━━━━━━━━┛
* ```
*/
straightOnly: boolean;
/**
* Это свойство используется для определения того, что считать за элемент, находящийся на одной линии.
* Допустимые значения от 0 до 1.0.
* Значение 0.5 означает, что элемент считается стоящим на одной линии с текущим, только в том случае, если он перекрывает прямую область в направлении перехода не менее чем на половину.
*/
straightOverlapThreshold: number;
/**
* Определяет можно ли выбрать элемент секции с помощью клавиш
*/
disabled: boolean;
/**
* Функция, которая возвращает элемент по умолчанию для секции
*/
getDefaultElement<S extends string>(sectionRoot: HTMLElement, sectionId: S): HTMLElement | null;
/**
* Определяет какой элемент выбрать при входе в секцию
*
* - `calculated` - Spatial Navigation сам выберет элемент для фокуса
*
* - `last-focused` - Последний элемент, который был в фокусе в данной секции, если такого нет - так же как `calculated`
*
* - `default-element` - Элемент, возвращаемый функцией getDefaultElement. Если результат getDefaultElement === null — то calculated
*/
enterTo: EnterTo;
/**
* Переопределяет поведение Spatial Navigation при выходе из текущей секции.
*
* @example
* ```typescript
* section1.leaveFor = {
* up() {
* return {
* type: 'section-name',
* result: 'section0',
* }
* },
* left() {
* // произвольные действия
* window.history.pop()
*
* return {
* type: 'no-spatnav-navigation',
* result: null,
* }
* },
* }
* ```
*/
leaveFor: LeaveFor | null;
/**
* Определяет ограничения при перемещении внутри текущей секции.
*
* - `none` - никаких ограничений, Spatial Navigation сам выберет элемент для фокуса
*
* - `self-only` - ограничивает навигацию только в данной секции. Элементы из других групп можно будет выбрать только с помощью функции `elementFromDifferentGroup.focus()`
*
* - `self-first` - элементы внутри данной группы имеют более высокий приоритет, чем элементы из других групп
*/
restrict: Restrict;
/**
* Определяет ограничения при перемещении внутри текущей секции.
*
* - `row` - если элементы секции расположены горизонтально
*
* - `column` - если элементы секции расположены вертикально
*/
simpleSectionOptions: SimpleSectionOptions | null;
/**
* true если элемент имеет className sn-section-root и sn-section-item одновременно
*/
selfSection: boolean;
};
export interface Section {
/**
* Конфиг текущей секции
*/
config: Config;
/**
* Последний элемент, который был активным в этой секции
*/
lastFocusedElement: HTMLElement | null;
/**
* HTML элемент секции
*/
rootElement: HTMLElement;
/**
* Элементы секции
*/
sectionElements: HTMLCollectionOf<HTMLElement> | Set<HTMLElement>;
}