@vnejs/docs 0.2.9 → 0.2.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/package.json +1 -1
  2. package/plugins/controls/cursor.md +17 -7
  3. package/plugins/controls/gamepad.md +1 -0
  4. package/plugins/views/cursor.md +2 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vnejs/docs",
3
- "version": "0.2.9",
3
+ "version": "0.2.11",
4
4
  "description": "VNEJS documentation for engine consumers and coding agents",
5
5
  "files": [
6
6
  "*.md",
package/plugins/controls/cursor.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  Пакет: `@vnejs/plugins.controls.cursor` · namespace: `CURSOR`
4
4
 
5
- Кастомный курсор: позиция, сдвиг, view и программный клик.
5
+ Кастомный курсор: позиция, сдвиг, скролл под курсором, view и программный клик.
6
6
 
7
7
  ## События
8
8
 
@@ -15,7 +15,9 @@
15
15
  | `VIEW_SET` | `vne:cursor:view_set` | Записать или обновить значение. |
16
16
  | `MOVE` | `vne:cursor:move` | Событие `MOVE` namespace плагина. |
17
17
  | `MOVED` | `vne:cursor:moved` | Событие `MOVED` namespace плагина. |
18
- | `SHIFT` | `vne:cursor:shift` | Событие `SHIFT` namespace плагина. |
18
+ | `SET_X_Y` | `vne:cursor:set_x_y` | Установить позицию курсора (`{ x?, y? }`) с clamp и `MOVED`. |
19
+ | `SHIFT` | `vne:cursor:shift` | Сдвиг позиции курсора (`{ x?, y? }`). |
20
+ | `SCROLL` | `vne:cursor:scroll` | Скролл ближайшего scrollable под курсором (`{ x?, y? }`). |
19
21
 
20
22
  ## Константы
21
23
 
@@ -30,20 +32,28 @@
30
32
  | `DEFAULT_SHIFT_REVERSE_X` | `boolean` | Значение по умолчанию: false. |
31
33
  | `DEFAULT_SHIFT_REVERSE_Y` | `boolean` | Значение по умолчанию: false. |
32
34
  | `BASE_SHIFT_SPEED` | `number` | Значение по умолчанию: 16. |
35
+ | `DEFAULT_SCROLL_SPEED` | `number` | Значение по умолчанию: 1. |
36
+ | `BASE_SCROLL_SPEED` | `number` | Значение по умолчанию: 16. |
33
37
 
34
38
  ## Настройки
35
39
 
36
40
  | Ключ | Тип | Смысл |
37
41
  |------|-----|-------|
38
- | `SHIFT_SPEED` (`vne:cursor:shift_speed`) | `number` | Скорость воспроизведения или анимации. |
39
- | `SHIFT_REVERSE_Y` (`vne:cursor:shift_reverse_y`) | `string` | Настройка `vne:cursor:shift_reverse_y` в `shared.settings`. |
40
- | `SHIFT_REVERSE_X` (`vne:cursor:shift_reverse_x`) | `string` | Настройка `vne:cursor:shift_reverse_x` в `shared.settings`. |
42
+ | `SHIFT_SPEED` (`vne:cursor:shift_speed`) | `number` | Множитель скорости сдвига курсора. |
43
+ | `SHIFT_REVERSE_Y` (`vne:cursor:shift_reverse_y`) | `boolean` | Инверсия оси Y при `SHIFT`. |
44
+ | `SHIFT_REVERSE_X` (`vne:cursor:shift_reverse_x`) | `boolean` | Инверсия оси X при `SHIFT`. |
45
+ | `SCROLL_SPEED` (`vne:cursor:scroll_speed`) | `number` | Множитель скорости скролла при `SCROLL`. |
41
46
 
42
47
  ## Модули
43
48
 
44
49
  | Модуль | Зона ответственности |
45
50
  |--------|----------------------|
46
- | `cursor` | Обрабатывает MOVE, CLICK, SHIFT, VIEW_SET, …. |
51
+ | `cursor` (`Cursor`) | SET_X_Y, resize; владеет `globalState.cursor` (x/y). |
52
+ | `cursor.view_set` (`CursorView`) | VIEW_SET + STATE/STARTED для проставления `view`. Имя `view_set`, чтобы не пересечься с `plugins/views/cursor` (`cursor.view`). |
53
+ | `cursor.move` (`CursorMove`) | MOVE (мышь) → SHOW + SET_X_Y; скрывает системный курсор. |
54
+ | `cursor.shift` (`CursorShift`) | SHIFT + INIT `SHIFT_SPEED` / `SHIFT_REVERSE_*`. |
55
+ | `cursor.click` (`CursorClick`) | CLICK по координатам курсора. |
56
+ | `cursor.scroll` (`CursorScroll`) | SCROLL + INIT `SCROLL_SPEED`. |
47
57
 
48
58
  ## Близкие плагины
49
59
 
@@ -56,4 +66,4 @@
56
66
 
57
67
  ### Остальные
58
68
 
59
- — нет
69
+ - [gamepad.md](./gamepad.md) — стики через `compatibility.controls.gamepad-with-controls.cursor`: left → `SHIFT`, right → `SCROLL`
package/plugins/controls/gamepad.md CHANGED
@@ -85,3 +85,4 @@ Electron при `STEAM_DECK=1` добавляет `?steamDeck=1`.
85
85
  ### Остальные
86
86
 
87
87
  - [controls.md](./controls.md) — `CONTROLS`: EVENTS.EMIT, CONST.BUTTONS
88
+ - [cursor.md](./cursor.md) — через `compatibility.controls.gamepad-with-controls.cursor`: left stick (оси 0–1) → `CURSOR.SHIFT`, right stick (оси 2–3) → `CURSOR.SCROLL`; RT → `CURSOR.CLICK`
package/plugins/views/cursor.md CHANGED
@@ -4,6 +4,8 @@
4
4
 
5
5
  Отображает кастомный курсор с загрузкой иконок default/pointer.
6
6
 
7
+ Интерактивные элементы игрового UI задают тип курсора атрибутом `vne-cursor-type` на DOM-узле (`"pointer"` или пусто), а не через CSS `cursor`. Компонент курсора читает атрибут через `elementsFromPoint` и переключает иконку default/pointer. Исключение: у Range input остаётся `cursor: inherit`, чтобы браузерный курсор `<input type="range">` уходил в `none`.
8
+
7
9
  ## События
8
10
 
9
11
  Нет.