@runic-artifex/angular 0.15.0 → 0.15.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 +15 -13
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -18,7 +18,9 @@ match your Runic SDK packages. Angular 22 is supported.
|
|
|
18
18
|
`injectView(source)` connects a generated page reference, or
|
|
19
19
|
`{ connect: connect<Name> }` for a root ViewModel, for the lifetime of the
|
|
20
20
|
injection context and returns `state`, `client`, `error` and `pending`
|
|
21
|
-
signals and `retry()
|
|
21
|
+
signals and `retry()`. Each is its own signal: `client` stays the same object
|
|
22
|
+
for the connection, so an `effect` that reads only `client()` does not run
|
|
23
|
+
again when the View's state changes.
|
|
22
24
|
|
|
23
25
|
```ts
|
|
24
26
|
import { Component, input } from "@angular/core";
|
|
@@ -138,7 +140,7 @@ export class CounterPage {
|
|
|
138
140
|
|
|
139
141
|
Bind a text input to a member with `injectTextField(view, read, write, options?)`,
|
|
140
142
|
which wraps the framework-neutral
|
|
141
|
-
[text field controller](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.
|
|
143
|
+
[text field controller](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.1/packages/web/views#text-inputs)
|
|
142
144
|
for the lifetime of the injection context:
|
|
143
145
|
|
|
144
146
|
```ts
|
|
@@ -181,7 +183,7 @@ text at once and hides the race.
|
|
|
181
183
|
|
|
182
184
|
For generated Views prefer `injectField(view, field, options?)`: pass a descriptor of the
|
|
183
185
|
generated `{View}Fields`, such as `EditorFields.title`. It wraps the framework-neutral
|
|
184
|
-
[field controller](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.
|
|
186
|
+
[field controller](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.1/packages/web/views#fields)
|
|
185
187
|
for every kind (text, numbers, booleans, enums) and returns signals and actions:
|
|
186
188
|
|
|
187
189
|
- `value`, `text` (what a text input shows: `1.` stays while typing `1.5`), `editing`,
|
|
@@ -393,14 +395,14 @@ For example, a navigation command whose departure guard awaits a dialog's
|
|
|
393
395
|
answer never completes while the answer waits behind it. Order such commands
|
|
394
396
|
by dispatch instead: start the next one once the previous one has been sent,
|
|
395
397
|
as the Notes example's
|
|
396
|
-
[`WindowOperations.runDispatched`](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.
|
|
398
|
+
[`WindowOperations.runDispatched`](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.1/examples/notes-view-first/Angular/src/app/window-operations.ts)
|
|
397
399
|
does for its navigation commands.
|
|
398
400
|
|
|
399
401
|
## Operations
|
|
400
402
|
|
|
401
403
|
`injectOperation(start, options?)` observes a generated `start<Command>()` operation
|
|
402
404
|
through the framework-neutral
|
|
403
|
-
[operation controller](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.
|
|
405
|
+
[operation controller](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.1/packages/web/views#operation-feedback-and-latest-selection)
|
|
404
406
|
for the lifetime of the injection context:
|
|
405
407
|
|
|
406
408
|
```ts
|
|
@@ -426,7 +428,7 @@ context.
|
|
|
426
428
|
|
|
427
429
|
`injectLatestOperation(options?)` admits only the newest of several reads, for example
|
|
428
430
|
loading the item the user selected last, through the framework-neutral
|
|
429
|
-
[latest-operation controller](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.
|
|
431
|
+
[latest-operation controller](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.1/packages/web/views#operation-feedback-and-latest-selection).
|
|
430
432
|
Each `run(intent)` replaces the queued intent and cancels the active read; the next
|
|
431
433
|
read starts only after the previous one reaches its terminal status and the intent's
|
|
432
434
|
optional `waitForCompletion` barrier:
|
|
@@ -458,7 +460,7 @@ from `@runic-artifex/views` (re-exported here since 0.11, with the
|
|
|
458
460
|
`BridgeConnectionState` and `BridgeConnectionOptions` types) and returns `{ state }`, a signal of a
|
|
459
461
|
`BridgeConnectionState`: `connecting`, `connected`, `reconnecting`, `lost` or `closed` (the
|
|
460
462
|
application closed the window, since 0.15; a closed set, see
|
|
461
|
-
[Connection state](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.
|
|
463
|
+
[Connection state](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.1/packages/web/views#connection-state)):
|
|
462
464
|
|
|
463
465
|
```ts
|
|
464
466
|
import { injectBridgeConnection } from "@runic-artifex/angular";
|
|
@@ -476,7 +478,7 @@ not observe and stays `connecting`. An invalid `lostAfter` throws a `RangeError`
|
|
|
476
478
|
`injectMenuBar(options?)` follows the declared menu bar of a Runic Desktop
|
|
477
479
|
window that leaves it to the page (`DesktopMenuBarPresentation.Page`) for the
|
|
478
480
|
lifetime of the injection context. It wraps `createMenuBarController` from
|
|
479
|
-
`@runic-artifex/views` (see [In-page menu bar](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.
|
|
481
|
+
`@runic-artifex/views` (see [In-page menu bar](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.1/packages/web/views#in-page-menu-bar))
|
|
480
482
|
and returns `{ state, invoke, handleKeyDown }`, where `state` is a signal of a
|
|
481
483
|
`MenuBarState`. The bar is rendered by the application's own menubar, for
|
|
482
484
|
example the CDK Menu's `cdkMenuBar`. Runic ships no menubar component.
|
|
@@ -501,7 +503,7 @@ it creates none and stays `connecting`.
|
|
|
501
503
|
### With the CDK Menu
|
|
502
504
|
|
|
503
505
|
The CDK's `cdkMenuBar` with `CdkMenuTrigger.open()` for `open` requests; the
|
|
504
|
-
[Notes example](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.
|
|
506
|
+
[Notes example](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.1/examples/notes-view-first#in-page-menu-bar) adds submenus, check and radio
|
|
505
507
|
items (`cdkMenuItemCheckbox`, `cdkMenuItemRadio` in a `cdkMenuGroup`) and is
|
|
506
508
|
tested with real keys:
|
|
507
509
|
|
|
@@ -567,7 +569,7 @@ readonly message = computed(() => describeBridgeError(this.view.error()));
|
|
|
567
569
|
```
|
|
568
570
|
|
|
569
571
|
`instanceof` holds for errors from every copy of the package on the page.
|
|
570
|
-
[Errors and diagnostics](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.
|
|
572
|
+
[Errors and diagnostics](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.1/packages/web/views#errors-and-diagnostics)
|
|
571
573
|
lists the kinds. Any other value, such as an exception that your own connect
|
|
572
574
|
function or command callback throws, arrives unchanged.
|
|
573
575
|
|
|
@@ -618,16 +620,16 @@ application's own dialog.
|
|
|
618
620
|
departure before that is answered by the ViewModel's .NET fallback handler, or
|
|
619
621
|
fails closed without one.
|
|
620
622
|
|
|
621
|
-
The [ReactiveUI leave confirmation](https://github.com/Runic-Artifex/runic-sdk/blob/v0.15.
|
|
623
|
+
The [ReactiveUI leave confirmation](https://github.com/Runic-Artifex/runic-sdk/blob/v0.15.1/packages/dotnet/Runic.Application.Views.ReactiveUI/README.md#leave-confirmation-in-a-web-view)
|
|
622
624
|
has the .NET side and which View answers which departure. In a frontend test,
|
|
623
625
|
the generated mock's `interactions.<name>.request(input)` resolves with the
|
|
624
|
-
registered handler's answer; see the [Testing guide](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.
|
|
626
|
+
registered handler's answer; see the [Testing guide](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.1/packages/web/views#testing).
|
|
625
627
|
|
|
626
628
|
## Collection viewports
|
|
627
629
|
|
|
628
630
|
`injectCollectionViewport(element, options)` follows a fixed-row-height scroll
|
|
629
631
|
container and returns a signal with its
|
|
630
|
-
[`collectionViewport`](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.
|
|
632
|
+
[`collectionViewport`](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.1/packages/web/views#collectionviewportoptions)
|
|
631
633
|
range. Pass the container as a signal, such as a `viewChild`, and the options as
|
|
632
634
|
a function or signal, then send the range to the ViewModel from an effect:
|
|
633
635
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@runic-artifex/angular",
|
|
3
|
-
"version": "0.15.
|
|
3
|
+
"version": "0.15.1",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"exports": {
|
|
6
6
|
".": {
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
"peerDependencies": {
|
|
19
19
|
"@angular/core": ">=22.0.0 <23",
|
|
20
20
|
"@angular/forms": ">=22.0.0 <23",
|
|
21
|
-
"@runic-artifex/views": "0.15.
|
|
21
|
+
"@runic-artifex/views": "0.15.1"
|
|
22
22
|
},
|
|
23
23
|
"peerDependenciesMeta": {
|
|
24
24
|
"@angular/forms": {
|
|
@@ -32,7 +32,7 @@
|
|
|
32
32
|
"url": "git+https://github.com/Runic-Artifex/runic-sdk.git",
|
|
33
33
|
"directory": "packages/web/angular"
|
|
34
34
|
},
|
|
35
|
-
"homepage": "https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.
|
|
35
|
+
"homepage": "https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.1/packages/web/angular#readme",
|
|
36
36
|
"bugs": {
|
|
37
37
|
"url": "https://github.com/Runic-Artifex/runic-sdk/issues"
|
|
38
38
|
},
|
|
@@ -56,7 +56,7 @@
|
|
|
56
56
|
"pack:check": "bun pm pack --dry-run"
|
|
57
57
|
},
|
|
58
58
|
"devDependencies": {
|
|
59
|
-
"@runic-artifex/views": "0.15.
|
|
59
|
+
"@runic-artifex/views": "0.15.1",
|
|
60
60
|
"@angular/common": "22.2.3",
|
|
61
61
|
"@angular/compiler": "22.2.3",
|
|
62
62
|
"@angular/compiler-cli": "22.2.3",
|
|
@@ -69,5 +69,5 @@
|
|
|
69
69
|
"typescript": "6.0.3",
|
|
70
70
|
"vitest": "5.0.3"
|
|
71
71
|
},
|
|
72
|
-
"gitHead": "
|
|
72
|
+
"gitHead": "fce42f47296a4784532fbba0fec9602cd3778fbb"
|
|
73
73
|
}
|