@myrmidon/gve-core 1.0.0 → 3.0.2
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 +32 -2
- package/fesm2022/myrmidon-gve-core.mjs +1277 -927
- package/fesm2022/myrmidon-gve-core.mjs.map +1 -1
- package/lib/components/animation-timeline/animation-timeline.component.d.ts +7 -10
- package/lib/components/animation-timeline-set/animation-timeline-set.component.d.ts +9 -12
- package/lib/components/animation-tween/animation-tween.component.d.ts +6 -8
- package/lib/components/base-text-char/base-text-char.component.d.ts +3 -6
- package/lib/components/base-text-editor/base-text-editor.component.d.ts +6 -8
- package/lib/components/base-text-view/base-text-view.component.d.ts +15 -12
- package/lib/components/batch-operation-editor/batch-operation-editor.component.d.ts +5 -7
- package/lib/components/chain-operation-editor/chain-operation-editor.component.d.ts +14 -15
- package/lib/components/chain-result-view/chain-result-view.component.d.ts +8 -11
- package/lib/components/chain-view/chain-view.component.d.ts +42 -0
- package/lib/components/feature-editor/feature-editor.component.d.ts +8 -12
- package/lib/components/feature-set-editor/feature-set-editor.component.d.ts +11 -13
- package/lib/components/feature-set-view/feature-set-view.component.d.ts +5 -7
- package/lib/components/ln-heights-editor/ln-heights-editor.component.d.ts +5 -8
- package/lib/components/operation-source-editor/operation-source-editor.component.d.ts +8 -11
- package/lib/components/snapshot-editor/snapshot-editor.component.d.ts +46 -35
- package/lib/components/snapshot-text-editor/snapshot-text-editor.component.d.ts +37 -0
- package/lib/components/steps-map/steps-map.component.d.ts +9 -9
- package/lib/services/gve-api.service.d.ts +48 -4
- package/lib/services/gve-graphviz.service.d.ts +20 -0
- package/lib/services/settings.service.d.ts +40 -5
- package/package.json +5 -5
- package/public-api.d.ts +3 -1
- package/lib/components/simple-tree/simple-tree.component.d.ts +0 -35
package/README.md
CHANGED
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
# Gve Core
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
- 🚀 `npm i @myrmidon/gve-core`.
|
|
4
4
|
|
|
5
|
-
This
|
|
5
|
+
This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 17.0.0. All the components in this library are standalone, and since version 3 their properties and events are signal-based.
|
|
6
|
+
|
|
7
|
+
This is the core UI library for [GVE](https://vedph.github.io/gve-doc).
|
|
6
8
|
|
|
7
9
|
```plantuml
|
|
8
10
|
@startuml
|
|
@@ -19,6 +21,7 @@ This is the core UI library for GVE.
|
|
|
19
21
|
[feature set view]
|
|
20
22
|
[ln heights editor]
|
|
21
23
|
[batch ops editor]
|
|
24
|
+
[snapshot text editor]
|
|
22
25
|
[op source editor]
|
|
23
26
|
[snapshot editor]
|
|
24
27
|
[steps map]
|
|
@@ -38,6 +41,7 @@ This is the core UI library for GVE.
|
|
|
38
41
|
[chain result view] --> [base text view]
|
|
39
42
|
[chain result view] --> [feature set view]
|
|
40
43
|
[chain result view] --> [steps map]
|
|
44
|
+
[snapshot editor] --> [snapshot text editor]
|
|
41
45
|
[snapshot editor] --> [batch ops editor]
|
|
42
46
|
[snapshot editor] --> [animation timeline set]
|
|
43
47
|
[snapshot editor] --> [base text editor]
|
|
@@ -49,3 +53,29 @@ This is the core UI library for GVE.
|
|
|
49
53
|
[snapshot editor] --> [api service]
|
|
50
54
|
@enduml
|
|
51
55
|
```
|
|
56
|
+
|
|
57
|
+
## Snapshot Editor
|
|
58
|
+
|
|
59
|
+
The snapshot editor is the top-level component in the library and orchestrates the behavior of all the components included in it. Its API is very simple, as it just deals with a full snapshot:
|
|
60
|
+
|
|
61
|
+
- ▶️ `snapshot` (`Snapshot`): the snapshot to edit.
|
|
62
|
+
- ▶️ `batchOps` (`string`): the batch operations text to set for the editor.
|
|
63
|
+
- ▶️ `noSave` (`boolean`): true to disable saving.
|
|
64
|
+
- 🔥 `snapshotChange` (`Snapshot`): emitted when the user saves the edited snapshot.
|
|
65
|
+
- 🔥 `snapshotCancel` (`void`): emitted when the user cancels the snapshot editing.
|
|
66
|
+
|
|
67
|
+
The only data directly handled by the component are:
|
|
68
|
+
|
|
69
|
+
- size and style;
|
|
70
|
+
- base text and related data;
|
|
71
|
+
- background image.
|
|
72
|
+
|
|
73
|
+
Operations and timelines are handled by other children components. The snapshot model is built dynamically when required (via `getSnapshot`), and it is displayed by a snapshot view.
|
|
74
|
+
|
|
75
|
+
## Dependencies
|
|
76
|
+
|
|
77
|
+
- [@myrmidon/ngx-tools, @myrmidon/ngx-mat-tools](https://github.com/vedph/ngx-tools)
|
|
78
|
+
- [@myrmidon/gve-snapshot-view](https://github.com/vedph/gve-snapshot-view): the snapshot view. This is a pure TS library, no JS framework required. The component is a standard web component.
|
|
79
|
+
- [cisstech/nge](https://github.com/cisstech/nge) for a light Monaco editor wrapper.
|
|
80
|
+
- [@svgdotjs/svg.js](https://github.com/svgdotjs/svg.js/) for SVG manipulation.
|
|
81
|
+
- [gsap](https://gsap.com/) for animations.
|