@vnejs/docs 0.2.3 → 0.2.5

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vnejs/docs",
3
- "version": "0.2.3",
3
+ "version": "0.2.5",
4
4
  "description": "VNEJS documentation for engine consumers and coding agents",
5
5
  "files": [
6
6
  "*.md",
@@ -35,13 +35,20 @@
35
35
 
36
36
  Нет.
37
37
 
38
+ ## Shared
39
+
40
+ | Поле | Тип | Смысл |
41
+ |------|-----|--------|
42
+ | `shouldAutostartScenario` | `boolean` | На `SYSTEM.STARTED` модуль `scenario.autostart` эмитит `LABEL_GET` (init) и `NEXT`, только если не `false`. В `init` ставится `true` через `??=`; другие плагины могут выставить `false`. `STATE.CLEAR` по-прежнему грузит init label в `scenario.label` без этого гейта. |
43
+
38
44
  ## Модули
39
45
 
40
46
  | Модуль | Зона ответственности |
41
47
  |--------|----------------------|
42
- | `scenario` | Главный цикл `NEXT`, exec строк, sync state, старт на `SYSTEM.STARTED`. |
48
+ | `scenario` | Главный цикл `NEXT`, exec строк, sync state. |
49
+ | `scenario.autostart` | Дефолт `shared.shouldAutostartScenario`; на `SYSTEM.STARTED` — init label + `emitNext` при включённом флаге. |
43
50
  | `scenario.exec` | Dispatch `$module` / `%block`, registry handlers, `EXEC_DELAY`. |
44
- | `scenario.label` | `LABEL_GET`, preload меток, init label на старте/clear. |
51
+ | `scenario.label` | `LABEL_GET`, preload меток; init label на `STATE.CLEAR`. |
45
52
  | `scenario.line` | `LINE_LOAD` / `LINE_GET`, registry preload handlers. |
46
53
  | `scenario.lines` | Fetch `label.*.json` с `HOST`. |
47
54
 
@@ -60,4 +67,4 @@
60
67
 
61
68
  ### Остальные
62
69
 
63
- — нет
70
+ - [electron.md](../platform/electron.md) — `ELECTRON`: при reload выставляет `shared.shouldAutostartScenario = false`
@@ -24,13 +24,14 @@
24
24
 
25
25
  | Модуль | Зона ответственности |
26
26
  |--------|----------------------|
27
- | `electron` | Обрабатывает CHANGED, STARTED, CLOSE_BEFORE. |
27
+ | `electron` | Синхронизирует remote storage; при изменении и cooldown ≥ 10 с (метка в `sessionStorage`) ставит `shouldReload` + `shared.shouldAutostartScenario = false`; на `STARTED` эмитит `RELOAD`; обрабатывает CHANGED / CLOSE_BEFORE. |
28
28
 
29
29
  ## Близкие плагины
30
30
 
31
31
  ### plugins/core/
32
32
 
33
33
  - [platforms.md](../core/platforms.md) — `PLATFORMS`: CONST.ELECTRON, PARAMS.CURRENT_PLATFORM
34
+ - [scenario.md](../core/scenario.md) — `SCENARIO`: `shared.shouldAutostartScenario` (отключает автостарт перед reload)
34
35
  - [storage.md](../core/storage.md) — `STORAGE`: EVENTS.CHANGED, EVENTS.SET_ALL, EVENTS.GET_ALL
35
36
  - [system.md](../core/system.md) — `SYSTEM`: EVENTS.STARTED, EVENTS.CLOSE_BEFORE, EVENTS.RELOAD, CONST.HOST
36
37
  - [vendors.md](../core/vendors.md) — `VENDORS`: EVENTS.DEBOUNCE
@@ -0,0 +1,69 @@
1
+ # plugins/views.screens/disclaimer/
2
+
3
+ Пакет: `@vnejs/plugins.views.screens.disclaimer` · namespace: `DISCLAIMER`
4
+
5
+ Полноэкранный дисклеймер по сценарной команде: заголовок, текст и кнопка принятия. Затемнение без фоновой картинки. Принятие не сохраняется — экран показывается при каждом вызове.
6
+
7
+ ## События
8
+
9
+ | Ключ | Строка | Смысл |
10
+ |------|--------|-------|
11
+ | `SHOW` | `vne:disclaimer:show` | Показать UI. Payload: `{ id }`. |
12
+ | `HIDE` | `vne:disclaimer:hide` | Скрыть UI. |
13
+ | `UPDATE` | `vne:disclaimer:update` | Обновить состояние или отображение. |
14
+ | `ACCEPT` | `vne:disclaimer:accept` | Пользователь принял дисклеймер → HIDE → next. |
15
+
16
+ ## Константы
17
+
18
+ Нет.
19
+
20
+ ## Параметры
21
+
22
+ | Ключ | Тип | Смысл |
23
+ |------|-----|-------|
24
+ | `TRANSITION` | `number` | Длительность анимации экрана. |
25
+ | `ZINDEX` | `number` | z-index экрана. |
26
+ | `LOC_LABEL` | `string` | Метка локализации (`disclaimer`). |
27
+ | `VIEW_PROPS` | `object` | Layout: screen (`withDark`/`withBlur`), title, text, controls. |
28
+
29
+ ## Настройки
30
+
31
+ Нет.
32
+
33
+ ## Модули
34
+
35
+ | Модуль | Зона ответственности |
36
+ |--------|----------------------|
37
+ | `disclaimer.controller` | SHOW/HIDE, controls ACCEPT/INTERACT → ACCEPT. |
38
+ | `disclaimer` | `$ disclaimer show <id>` → SHOW; ACCEPT → HIDE → emitNext. |
39
+ | `disclaimer.view` | React UI: title / text / accept из locs. |
40
+
41
+ ## Локализация
42
+
43
+ Файл `media/locs/{lang}/disclaimer.json`. Ключи:
44
+
45
+ | Ключ | Смысл |
46
+ |------|-------|
47
+ | `accept` | Текст кнопки |
48
+ | `{id}.title` | Заголовок для id |
49
+ | `{id}.text` | Текст для id (можно многострочный через `\n`) |
50
+
51
+ ## Сценарий
52
+
53
+ ```vne
54
+ $ disclaimer show setting
55
+ $ disclaimer show qte
56
+ ```
57
+
58
+ ## Близкие плагины
59
+
60
+ ### plugins/core/
61
+
62
+ - [logs.md](../core/logs.md) — `LOGS`: emitLog
63
+ - [scenario.md](../core/scenario.md) — `SCENARIO`: emitNext, EVENTS.LINE_EXEC_REG
64
+
65
+ ### Остальные
66
+
67
+ - [controls.md](../controls/controls.md) — `CONTROLS`: CONST.BUTTONS.ACCEPT, CONST.BUTTONS.INTERACT
68
+ - [intro.md](./intro.md) — `INTRO`: похожий сценарный экран
69
+ - [confirm.md](./confirm.md) — `CONFIRM`: затемнение и кнопки
@@ -56,6 +56,7 @@
56
56
  |---------|--------|------|
57
57
  | `$ interface` | `show`, `hide`, `view` | [interface.md](./stubs/interface.md) |
58
58
  | `$ intro` | интро | [intro.md](./stubs/intro.md) |
59
+ | `$ disclaimer` | `show` + id | [disclaimer.md](./stubs/disclaimer.md) |
59
60
  | `$ mainmenu` | главное меню | [mainmenu.md](./stubs/mainmenu.md) |
60
61
  | `$ credits` | `show`, `hide` | [credits.md](./stubs/credits.md) |
61
62
  | `$ settings.defaults` | дефолты настроек | [settings.defaults.md](./stubs/settings.defaults.md) |
@@ -0,0 +1,17 @@
1
+ # $ disclaimer
2
+
3
+ | | |
4
+ |--|--|
5
+ | Тип | `module` (`$`) |
6
+ | Сигнатура | `$ disclaimer <action> <id>` |
7
+ | Actions / args | `show` + `<id>` — ключ текстов в `disclaimer` locs |
8
+ | Plugin doc | [views.screens/disclaimer.md](../plugins/views.screens/disclaimer.md) |
9
+
10
+ ## Примеры
11
+
12
+ ```vne
13
+ $ disclaimer show setting
14
+ $ disclaimer show qte
15
+ ```
16
+
17
+ Source of truth: `SCENARIO_COMMANDS` в соответствующем `contracts/**/commands.ts`.
@@ -14,6 +14,7 @@ $ interface view adv
14
14
 
15
15
  ```vne
16
16
  $ intro
17
+ $ disclaimer show setting
17
18
  $ mainmenu
18
19
  $ credits show
19
20
  $ credits hide
@@ -23,6 +24,7 @@ $ settings.defaults
23
24
  | Команда | Смысл |
24
25
  |---------|--------|
25
26
  | `$ intro` | Интро-экран |
27
+ | `$ disclaimer show <id>` | Дисклеймер (title/text/accept по id из locs) |
26
28
  | `$ mainmenu` | Главное меню |
27
29
  | `$ credits show` / `hide` | Титры |
28
30
  | `$ settings.defaults` | Сброс/дефолты настроек (по плагину) |