@runic-artifex/vue 0.12.0 → 0.12.1
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/README.md +9 -9
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -148,7 +148,7 @@ neither.
|
|
|
148
148
|
## `useOperation(start, options?)`
|
|
149
149
|
|
|
150
150
|
Observes a generated `start<Command>()` operation through the framework-neutral
|
|
151
|
-
[operation controller](https://github.com/Runic-Artifex/runic-sdk/tree/v0.12.
|
|
151
|
+
[operation controller](https://github.com/Runic-Artifex/runic-sdk/tree/v0.12.1/packages/web/views#operation-feedback-and-latest-selection)
|
|
152
152
|
and returns each state field as a shallow ref, with `run`, `cancel` and `reset`:
|
|
153
153
|
|
|
154
154
|
```vue
|
|
@@ -177,7 +177,7 @@ Disposing the effect scope settles run promises without cancelling accepted work
|
|
|
177
177
|
|
|
178
178
|
Admits only the newest of several reads, for example loading the item the user
|
|
179
179
|
selected last, through the framework-neutral
|
|
180
|
-
[latest-operation controller](https://github.com/Runic-Artifex/runic-sdk/tree/v0.12.
|
|
180
|
+
[latest-operation controller](https://github.com/Runic-Artifex/runic-sdk/tree/v0.12.1/packages/web/views#operation-feedback-and-latest-selection),
|
|
181
181
|
and returns each state field as a shallow ref, with `run` and `clear`. Each
|
|
182
182
|
`run(intent)` replaces the queued intent and cancels the active read; the next read
|
|
183
183
|
starts only after the previous one reaches its terminal status and the intent's
|
|
@@ -214,7 +214,7 @@ from `@runic-artifex/views` (re-exported here since 0.11, with the
|
|
|
214
214
|
`BridgeConnectionState` and `BridgeConnectionOptions` types) and returns `{ state }`, a shallow ref holding a
|
|
215
215
|
`BridgeConnectionState`: `connecting`, `connected`, `reconnecting` or `lost` (a
|
|
216
216
|
closed set, see
|
|
217
|
-
[Connection state](https://github.com/Runic-Artifex/runic-sdk/tree/v0.12.
|
|
217
|
+
[Connection state](https://github.com/Runic-Artifex/runic-sdk/tree/v0.12.1/packages/web/views#connection-state)):
|
|
218
218
|
|
|
219
219
|
```vue
|
|
220
220
|
<script setup lang="ts">
|
|
@@ -237,7 +237,7 @@ development builds warn. An invalid `lostAfter` throws a `RangeError`.
|
|
|
237
237
|
Follows the declared menu bar of a Runic Desktop window that leaves it to the
|
|
238
238
|
page (`DesktopMenuBarPresentation.Page`) until the current effect scope is
|
|
239
239
|
disposed. It wraps `createMenuBarController` from `@runic-artifex/views` (see
|
|
240
|
-
[In-page menu bar](https://github.com/Runic-Artifex/runic-sdk/tree/v0.12.
|
|
240
|
+
[In-page menu bar](https://github.com/Runic-Artifex/runic-sdk/tree/v0.12.1/packages/web/views#in-page-menu-bar)) and returns `{ state, invoke, handleKeyDown }`: `state` is a shallow ref
|
|
241
241
|
of a `MenuBarState`, and the bar is rendered by the menubar component of the
|
|
242
242
|
application's own UI library. Runic ships no menubar component.
|
|
243
243
|
|
|
@@ -268,7 +268,7 @@ rendering creates no controller: `state` stays `connecting`.
|
|
|
268
268
|
### With Reka UI
|
|
269
269
|
|
|
270
270
|
Reka UI's `MenubarRoot` with `v-model` of the open menu; the
|
|
271
|
-
[Notes example](https://github.com/Runic-Artifex/runic-sdk/tree/v0.12.
|
|
271
|
+
[Notes example](https://github.com/Runic-Artifex/runic-sdk/tree/v0.12.1/examples/notes-view-first#in-page-menu-bar) adds submenus, check and radio
|
|
272
272
|
items and is tested with real keys:
|
|
273
273
|
|
|
274
274
|
```vue
|
|
@@ -327,7 +327,7 @@ const offline = error.value instanceof BridgeError && error.value.kind === "disc
|
|
|
327
327
|
```
|
|
328
328
|
|
|
329
329
|
`instanceof` holds for errors from every copy of the package on the page.
|
|
330
|
-
[Errors and diagnostics](https://github.com/Runic-Artifex/runic-sdk/tree/v0.12.
|
|
330
|
+
[Errors and diagnostics](https://github.com/Runic-Artifex/runic-sdk/tree/v0.12.1/packages/web/views#errors-and-diagnostics)
|
|
331
331
|
lists the kinds. Any other value, such as an exception that your own connect
|
|
332
332
|
function or command callback throws, arrives unchanged.
|
|
333
333
|
|
|
@@ -374,15 +374,15 @@ application's own dialog.
|
|
|
374
374
|
departure before that is answered by the ViewModel's .NET fallback handler, or
|
|
375
375
|
fails closed without one.
|
|
376
376
|
|
|
377
|
-
The [ReactiveUI leave confirmation](https://github.com/Runic-Artifex/runic-sdk/blob/v0.12.
|
|
377
|
+
The [ReactiveUI leave confirmation](https://github.com/Runic-Artifex/runic-sdk/blob/v0.12.1/packages/dotnet/Runic.Application.Views.ReactiveUI/README.md#leave-confirmation-in-a-web-view)
|
|
378
378
|
has the .NET side and which View answers which departure. In a frontend test,
|
|
379
379
|
the generated mock's `interactions.<name>.request(input)` resolves with the
|
|
380
|
-
registered handler's answer; see the [Testing guide](https://github.com/Runic-Artifex/runic-sdk/tree/v0.12.
|
|
380
|
+
registered handler's answer; see the [Testing guide](https://github.com/Runic-Artifex/runic-sdk/tree/v0.12.1/packages/web/views#testing).
|
|
381
381
|
|
|
382
382
|
## `useCollectionViewport(options)`
|
|
383
383
|
|
|
384
384
|
Follows a fixed-row-height scroll container and returns `{ viewport, attach }`.
|
|
385
|
-
`viewport` is a shallow ref with the [`collectionViewport`](https://github.com/Runic-Artifex/runic-sdk/tree/v0.12.
|
|
385
|
+
`viewport` is a shallow ref with the [`collectionViewport`](https://github.com/Runic-Artifex/runic-sdk/tree/v0.12.1/packages/web/views#collectionviewportoptions)
|
|
386
386
|
range; `attach` is a function ref for the container. Bind it to a native element
|
|
387
387
|
such as a `<div>`: a component instance (`:ref="attach"` on a component) or a
|
|
388
388
|
non-HTML element detaches the viewport, and development builds warn. Pass a getter for the
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@runic-artifex/vue",
|
|
3
|
-
"version": "0.12.
|
|
3
|
+
"version": "0.12.1",
|
|
4
4
|
"description": "Vue composables for generated Runic Views clients",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
7
|
-
"packageManager": "bun@1.4.
|
|
7
|
+
"packageManager": "bun@1.4.4",
|
|
8
8
|
"sideEffects": false,
|
|
9
9
|
"files": [
|
|
10
10
|
"dist",
|
|
@@ -30,10 +30,10 @@
|
|
|
30
30
|
},
|
|
31
31
|
"peerDependencies": {
|
|
32
32
|
"vue": ">=3.5.30 <4",
|
|
33
|
-
"@runic-artifex/views": "0.12.
|
|
33
|
+
"@runic-artifex/views": "0.12.1"
|
|
34
34
|
},
|
|
35
35
|
"devDependencies": {
|
|
36
|
-
"@runic-artifex/views": "0.12.
|
|
36
|
+
"@runic-artifex/views": "0.12.1",
|
|
37
37
|
"happy-dom": "21.0.4",
|
|
38
38
|
"typescript": "6.0.3",
|
|
39
39
|
"vitest": "5.0.3",
|
|
@@ -48,7 +48,7 @@
|
|
|
48
48
|
"url": "git+https://github.com/Runic-Artifex/runic-sdk.git",
|
|
49
49
|
"directory": "packages/web/vue"
|
|
50
50
|
},
|
|
51
|
-
"homepage": "https://github.com/Runic-Artifex/runic-sdk/tree/v0.12.
|
|
51
|
+
"homepage": "https://github.com/Runic-Artifex/runic-sdk/tree/v0.12.1/packages/web/vue#readme",
|
|
52
52
|
"bugs": {
|
|
53
53
|
"url": "https://github.com/Runic-Artifex/runic-sdk/issues"
|
|
54
54
|
},
|
|
@@ -58,5 +58,5 @@
|
|
|
58
58
|
"views",
|
|
59
59
|
"vue"
|
|
60
60
|
],
|
|
61
|
-
"gitHead": "
|
|
61
|
+
"gitHead": "124a532e5861cff03e77d2ef0c5d4f081ee99a47"
|
|
62
62
|
}
|