@eightkk/vue-weave 0.0.0-stage → 1.0.0
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/CHANGELOG.md +517 -0
- package/CONTRIBUTING.md +123 -0
- package/LICENSE +21 -0
- package/README.ja.md +275 -0
- package/README.md +272 -2
- package/THIRD_PARTY_NOTICES.md +25 -0
- package/dist/core-BH5rTsKp.js +13606 -0
- package/dist/core.js +1 -0
- package/dist/index.js +8022 -0
- package/dist/style.css +2 -0
- package/dist/types/components/GanttChart.vue.d.ts +339 -0
- package/dist/types/components/NetworkGraph.vue.d.ts +252 -0
- package/dist/types/components/types.d.ts +27 -0
- package/dist/types/composables/useAsyncGraphLayout.d.ts +163 -0
- package/dist/types/composables/useEditHistory.d.ts +13 -0
- package/dist/types/composables/useEditTransaction.d.ts +46 -0
- package/dist/types/composables/useLinkedSelection.d.ts +118 -0
- package/dist/types/composables/useTimelineView.d.ts +24 -0
- package/dist/types/composables/useWindowedData.d.ts +83 -0
- package/dist/types/core/actuals.d.ts +170 -0
- package/dist/types/core/calendarFormat.d.ts +65 -0
- package/dist/types/core/editTransaction.d.ts +96 -0
- package/dist/types/core/exportSvg.d.ts +236 -0
- package/dist/types/core/fieldEditing.d.ts +114 -0
- package/dist/types/core/graph.d.ts +196 -0
- package/dist/types/core/graphAlgorithms.d.ts +51 -0
- package/dist/types/core/graphAnalysis.d.ts +96 -0
- package/dist/types/core/graphCollapse.d.ts +62 -0
- package/dist/types/core/graphCrossings.d.ts +25 -0
- package/dist/types/core/graphEditing.d.ts +52 -0
- package/dist/types/core/graphExpansion.d.ts +71 -0
- package/dist/types/core/graphFlow.d.ts +184 -0
- package/dist/types/core/graphForce.d.ts +29 -0
- package/dist/types/core/graphGeometry.d.ts +31 -0
- package/dist/types/core/graphIncremental.d.ts +93 -0
- package/dist/types/core/graphLasso.d.ts +15 -0
- package/dist/types/core/graphLayoutRequests.d.ts +218 -0
- package/dist/types/core/graphLayouts.d.ts +81 -0
- package/dist/types/core/graphObstacleRouting.d.ts +68 -0
- package/dist/types/core/graphPortRules.d.ts +111 -0
- package/dist/types/core/graphRouting.d.ts +84 -0
- package/dist/types/core/graphSnapping.d.ts +34 -0
- package/dist/types/core/graphSpatial.d.ts +49 -0
- package/dist/types/core/graphSwimlanes.d.ts +77 -0
- package/dist/types/core/graphTraversal.d.ts +51 -0
- package/dist/types/core/graphView.d.ts +73 -0
- package/dist/types/core/index.d.ts +75 -0
- package/dist/types/core/interchange.d.ts +6 -0
- package/dist/types/core/interchangeCsv.d.ts +75 -0
- package/dist/types/core/interchangeICalendar.d.ts +111 -0
- package/dist/types/core/interchangeMsProject.d.ts +339 -0
- package/dist/types/core/leveling.d.ts +57 -0
- package/dist/types/core/pert.d.ts +62 -0
- package/dist/types/core/placement.d.ts +100 -0
- package/dist/types/core/planComparison.d.ts +275 -0
- package/dist/types/core/resourceLoad.d.ts +65 -0
- package/dist/types/core/resourceTimeline.d.ts +179 -0
- package/dist/types/core/rowHierarchy.d.ts +25 -0
- package/dist/types/core/scheduleDiagnostics.d.ts +37 -0
- package/dist/types/core/scheduleModel.d.ts +187 -0
- package/dist/types/core/scheduleTrace.d.ts +118 -0
- package/dist/types/core/scheduling.d.ts +194 -0
- package/dist/types/core/snapshot.d.ts +388 -0
- package/dist/types/core/statusDate.d.ts +36 -0
- package/dist/types/core/timeRangeTargets.d.ts +67 -0
- package/dist/types/core/timeline.d.ts +194 -0
- package/dist/types/core/timelineView.d.ts +101 -0
- package/dist/types/core/types.d.ts +783 -0
- package/dist/types/core/viewBindings.d.ts +112 -0
- package/dist/types/core/windowedData.d.ts +255 -0
- package/dist/types/core/workCalendar.d.ts +41 -0
- package/dist/types/core/workingTimeScale.d.ts +33 -0
- package/dist/types/index.d.ts +52 -0
- package/docs/api.md +1989 -0
- package/docs/architecture.md +112 -0
- package/docs/code-of-conduct.md +24 -0
- package/docs/integration.md +931 -0
- package/docs/scheduling.md +586 -0
- package/docs/security.md +26 -0
- package/docs/third-party-licenses.md +33 -0
- package/package.json +79 -4
package/README.md
CHANGED
|
@@ -1,3 +1,273 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Vue Weave
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://github.com/EightKK/vue-weave/actions/workflows/ci.yml) [](https://github.com/EightKK/vue-weave/blob/v1.0.0/LICENSE)
|
|
4
|
+
|
|
5
|
+
[日本語](https://github.com/EightKK/vue-weave/blob/v1.0.0/README.ja.md)
|
|
6
|
+
|
|
7
|
+
[Source](https://github.com/EightKK/vue-weave) · [Issues](https://github.com/EightKK/vue-weave/issues) · [Releases](https://github.com/EightKK/vue-weave/releases)
|
|
8
|
+
|
|
9
|
+
Interactive network graphs and Gantt charts for Vue 3. Build relationship explorers, process flows, production views, project schedules and resource timelines from two typed components, and do the graph, scheduling and resource-load calculations in a headless core that also runs in Node.js, workers and on servers.
|
|
10
|
+
|
|
11
|
+
- **Two controlled components.** `NetworkGraph` and `GanttChart` never change your data. A user edit becomes a proposal event, and your code decides whether to apply it.
|
|
12
|
+
- **Planning built in.** Calendars, dependencies, critical path, resource load and leveling, recorded actuals and plan scenario comparison, with an explanation of every date.
|
|
13
|
+
- **Opt-in features.** The defaults stay simple; everything else is a prop. No runtime dependencies besides Vue, server-side rendering, SVG and PNG export, a dark theme and right-to-left layouts.
|
|
14
|
+
|
|
15
|
+
## Install
|
|
16
|
+
|
|
17
|
+
```sh
|
|
18
|
+
npm install @eightkk/vue-weave
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Vue `^3.5.0` is a peer dependency. npm 7 and later install it together with the package when your application does not have it yet. The package ships ES modules, TypeScript declarations and one stylesheet.
|
|
22
|
+
|
|
23
|
+
Import the stylesheet once, for example in your application's entry file:
|
|
24
|
+
|
|
25
|
+
```ts
|
|
26
|
+
import '@eightkk/vue-weave/style.css'
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Vite handles this import as it is. If your `tsconfig.json` enables `noUncheckedSideEffectImports`, or your build has no CSS loader, see [The stylesheet and TypeScript](https://github.com/EightKK/vue-weave/blob/v1.0.0/docs/integration.md#the-stylesheet-and-typescript).
|
|
30
|
+
|
|
31
|
+
**Core only (servers and Workers).** `@eightkk/vue-weave/core` runs without Vue at runtime, in Node.js 22.18+, Workers and on servers. Vue is still a required peer dependency (an optional peer is not configured), so `npm install @eightkk/vue-weave` installs Vue as well. To leave it out of a core-only deployment, install with `--omit=peer`. See [Core only: servers and Workers](https://github.com/EightKK/vue-weave/blob/v1.0.0/docs/integration.md#core-only-servers-and-workers).
|
|
32
|
+
|
|
33
|
+
**Offline install.** Each [GitHub Release](https://github.com/EightKK/vue-weave/releases) also has the package tarball, the same file that is published to npm. Download `eightkk-vue-weave-1.0.0.tgz` and install it from your application's directory, replacing the example path with the actual one:
|
|
34
|
+
|
|
35
|
+
```sh
|
|
36
|
+
npm install ./eightkk-vue-weave-1.0.0.tgz
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
You can also [build a local package](https://github.com/EightKK/vue-weave/blob/v1.0.0/CONTRIBUTING.md#build-a-local-package) from a checkout.
|
|
40
|
+
|
|
41
|
+
## Quick start
|
|
42
|
+
|
|
43
|
+
### A network graph
|
|
44
|
+
|
|
45
|
+
```vue
|
|
46
|
+
<script setup lang="ts">
|
|
47
|
+
import { ref } from 'vue'
|
|
48
|
+
import { NetworkGraph, type NetworkNode, type GraphEdge } from '@eightkk/vue-weave'
|
|
49
|
+
import '@eightkk/vue-weave/style.css'
|
|
50
|
+
|
|
51
|
+
const selected = ref('design')
|
|
52
|
+
const nodes: NetworkNode[] = [
|
|
53
|
+
{ id: 'design', label: 'Design' },
|
|
54
|
+
{ id: 'build', label: 'Build' },
|
|
55
|
+
{ id: 'release', label: 'Release' },
|
|
56
|
+
]
|
|
57
|
+
const edges: GraphEdge[] = [
|
|
58
|
+
{ id: 'db', from: 'design', to: 'build' },
|
|
59
|
+
{ id: 'br', from: 'build', to: 'release', label: 'Approved' },
|
|
60
|
+
]
|
|
61
|
+
</script>
|
|
62
|
+
|
|
63
|
+
<template>
|
|
64
|
+
<NetworkGraph
|
|
65
|
+
v-model:selected-id="selected"
|
|
66
|
+
:nodes="nodes"
|
|
67
|
+
:edges="edges"
|
|
68
|
+
:options="{ direction: 'LR' }"
|
|
69
|
+
/>
|
|
70
|
+
</template>
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
Other features are enabled the same way, through props and `options`. For example, this graph flows right to left, reduces edge crossings, highlights search matches and skips drawing off-screen nodes:
|
|
74
|
+
|
|
75
|
+
```vue
|
|
76
|
+
<NetworkGraph
|
|
77
|
+
ref="graph"
|
|
78
|
+
:nodes="nodes"
|
|
79
|
+
:edges="edges"
|
|
80
|
+
:options="{ direction: 'RL', crossingReduction: 'barycenter' }"
|
|
81
|
+
:match-ids="matches"
|
|
82
|
+
cull-offscreen
|
|
83
|
+
/>
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
### A controlled Gantt chart
|
|
87
|
+
|
|
88
|
+
```vue
|
|
89
|
+
<script setup lang="ts">
|
|
90
|
+
import { ref } from 'vue'
|
|
91
|
+
import { GanttChart, type TimelineBar, type TimelineEdit } from '@eightkk/vue-weave'
|
|
92
|
+
import '@eightkk/vue-weave/style.css'
|
|
93
|
+
|
|
94
|
+
const start = Date.parse('2026-11-09T08:00:00Z')
|
|
95
|
+
const hour = 3_600_000
|
|
96
|
+
const range = { start, end: start + 8 * hour }
|
|
97
|
+
const rows = [{ id: 'team', label: 'Engineering' }]
|
|
98
|
+
const bars = ref<TimelineBar[]>([
|
|
99
|
+
{
|
|
100
|
+
id: 'build', rowId: 'team', label: 'Build',
|
|
101
|
+
start: start + hour, end: start + 3 * hour,
|
|
102
|
+
editable: true, progress: 0.4,
|
|
103
|
+
},
|
|
104
|
+
])
|
|
105
|
+
|
|
106
|
+
function commit(change: TimelineEdit) {
|
|
107
|
+
bars.value = bars.value.map(bar =>
|
|
108
|
+
bar.id === change.id ? { ...bar, ...change.after } : bar,
|
|
109
|
+
)
|
|
110
|
+
}
|
|
111
|
+
</script>
|
|
112
|
+
|
|
113
|
+
<template>
|
|
114
|
+
<GanttChart :rows="rows" :bars="bars" :range="range" @edit="commit" />
|
|
115
|
+
</template>
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
The component previews pointer edits, then emits a proposal. The parent commits it by replacing the affected interval. This supports application-specific validation, API persistence and asynchronous approval. A synchronous `validateEdit` hook can reject a proposal before the event is emitted. Intervals are half-open `[start, end)`, and a zero-duration bar is a milestone.
|
|
119
|
+
|
|
120
|
+
### Linked views
|
|
121
|
+
|
|
122
|
+
A minimal link between a graph and a Gantt chart: activating an item in either view selects it there and highlights its counterpart in the other.
|
|
123
|
+
|
|
124
|
+
```vue
|
|
125
|
+
<script setup lang="ts">
|
|
126
|
+
import { NetworkGraph, GanttChart, useLinkedSelection, type ViewBinding, type ViewTargetEvent } from '@eightkk/vue-weave'
|
|
127
|
+
|
|
128
|
+
// nodes, edges, rows, bars and range as in the examples above; node and bar IDs are task IDs here.
|
|
129
|
+
const bindings: ViewBinding[] = bars.value.flatMap(bar => [
|
|
130
|
+
{ entity: { kind: 'task', id: bar.id }, target: { view: 'graph', kind: 'node', id: bar.id } },
|
|
131
|
+
{ entity: { kind: 'task', id: bar.id }, target: { view: 'timeline', kind: 'bar', id: bar.id } },
|
|
132
|
+
])
|
|
133
|
+
const linked = useLinkedSelection({ bindings })
|
|
134
|
+
const activate = (event: ViewTargetEvent) => linked.select(event.target.view, [event.target])
|
|
135
|
+
</script>
|
|
136
|
+
|
|
137
|
+
<template>
|
|
138
|
+
<NetworkGraph :nodes="nodes" :edges="edges" :selected-ids="linked.graph.value.selectedNodeIds"
|
|
139
|
+
:highlighted-node-ids="linked.graph.value.highlightedNodeIds" @target-activate="activate" />
|
|
140
|
+
<GanttChart :rows="rows" :bars="bars" :range="range" :selected-ids="linked.timeline.value.selectedBarIds"
|
|
141
|
+
:highlighted-bar-ids="linked.timeline.value.highlightedBarIds" @target-activate="activate" />
|
|
142
|
+
</template>
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
See [Linking views](https://github.com/EightKK/vue-weave/blob/v1.0.0/docs/integration.md#linking-views) for hover, load rows and moving to collapsed items, and [Saving through a server](https://github.com/EightKK/vue-weave/blob/v1.0.0/docs/integration.md#saving-through-a-server) for `useEditTransaction`.
|
|
146
|
+
|
|
147
|
+
## Gallery
|
|
148
|
+
|
|
149
|
+
All screenshots are from the [demo app](#run-the-demo) in this repository.
|
|
150
|
+
|
|
151
|
+

|
|
152
|
+
|
|
153
|
+

|
|
154
|
+
|
|
155
|
+
<table>
|
|
156
|
+
<tr>
|
|
157
|
+
<td width="50%" valign="top">
|
|
158
|
+
<img src="https://raw.githubusercontent.com/EightKK/vue-weave/v1.0.0/.github/images/process-lanes.png" alt="Process lanes demo: a machining process in four department lanes (Purchasing, Machining, Inspection and an empty Shipping lane), with orthogonal hand-over edges crossing the lane boundaries and the lanes repeated in the minimap" width="100%"><br>
|
|
159
|
+
<b>Swimlanes.</b> One lane per department or work centre, in your order (<code>layoutSwimlaneGraph</code>, <code>lanes</code>).
|
|
160
|
+
</td>
|
|
161
|
+
<td width="50%" valign="top">
|
|
162
|
+
<img src="https://raw.githubusercontent.com/EightKK/vue-weave/v1.0.0/.github/images/quantity-flow.png" alt="Quantity flow demo: a Sankey diagram of a lot of 100 pieces that splits 60/40 between two lines, merges at inspection, loses 4 pieces on line B and loops 10 pieces through rework as a dashed band, with a table of inflow, outflow and difference per step" width="100%"><br>
|
|
163
|
+
<b>Quantity flows.</b> Edges drawn as bands as wide as their quantity, on one scale (<code>layoutFlowGraph</code>, <code>edgeBands</code>).
|
|
164
|
+
</td>
|
|
165
|
+
</tr>
|
|
166
|
+
<tr>
|
|
167
|
+
<td width="50%" valign="top">
|
|
168
|
+
<img src="https://raw.githubusercontent.com/EightKK/vue-weave/v1.0.0/.github/images/linked-views.png" alt="Linked views demo: Cut order A is selected in the Gantt chart, and the same task is highlighted in the network graph above and in the CNC cell load row below, where a red segment marks an overload" width="100%"><br>
|
|
169
|
+
<b>Linked views.</b> Select in one view and the graph, Gantt chart and load rows highlight the same task (<code>useLinkedSelection</code>).
|
|
170
|
+
</td>
|
|
171
|
+
<td width="50%" valign="top">
|
|
172
|
+
<img src="https://raw.githubusercontent.com/EightKK/vue-weave/v1.0.0/.github/images/plan-comparison.png" alt="Plan scenarios demo: a candidate plan that pushes the cutting work after a maintenance window, compared with the current plan in a table of final completion, deadline misses, changed assignments and CNC cell overload, and a Gantt chart that shows the current plan as a strip below each candidate bar" width="100%"><br>
|
|
173
|
+
<b>Plan scenarios.</b> Compare a candidate plan with the current one before adopting it (<code>comparePlans</code>).
|
|
174
|
+
</td>
|
|
175
|
+
</tr>
|
|
176
|
+
<tr>
|
|
177
|
+
<td width="50%" valign="top">
|
|
178
|
+
<img src="https://raw.githubusercontent.com/EightKK/vue-weave/v1.0.0/.github/images/diagram-styles-dark.png" alt="Diagram styles demo in the dark theme: an order fulfilment flow with ellipse, diamond and hexagon nodes, dashed animated main-path edges, open-arrow and circle edge markers, and a pair of parallel edges spread apart" width="100%"><br>
|
|
179
|
+
<b>Diagram styles and dark theme.</b> Node shapes, edge markers, animated and parallel edges, and the built-in dark theme.
|
|
180
|
+
</td>
|
|
181
|
+
<td width="50%" valign="top">
|
|
182
|
+
<b>More in the demo:</b> project delivery, a 1,000-row timeline, a large graph, timeline editing, an asynchronous layout, graph analysis, resource planning with unplanned tasks, saved editing against a simulated server, a large plan loaded window by window, and a design gallery that restyles both components as a workflow builder, a database schema, an org chart, a roadmap, a sprint plan, room bookings and calendar views.
|
|
183
|
+
</td>
|
|
184
|
+
</tr>
|
|
185
|
+
</table>
|
|
186
|
+
|
|
187
|
+
## Features
|
|
188
|
+
|
|
189
|
+
Everything beyond the basics is opt-in. This is an overview; the full list of props, events, slots and functions is in [docs/api.md](https://github.com/EightKK/vue-weave/blob/v1.0.0/docs/api.md), with guides in [docs/integration.md](https://github.com/EightKK/vue-weave/blob/v1.0.0/docs/integration.md) and [docs/scheduling.md](https://github.com/EightKK/vue-weave/blob/v1.0.0/docs/scheduling.md).
|
|
190
|
+
|
|
191
|
+
### NetworkGraph
|
|
192
|
+
|
|
193
|
+
- **Layouts:** a built-in layered layout (`LR`, `TB`, `RL` or `BT`, with `crossingReduction: 'barycenter'`) that handles branches, merges, cycles and self-loops. Through the `layout` prop: tree, radial, circular, grid, concentric and deterministic force layouts (`layoutTreeGraph`, `layoutRadialGraph`, `layoutCircularGraph`, `layoutGridGraph`, `layoutConcentricGraph`, `layoutForceGraph`), or [ELK.js](https://github.com/EightKK/vue-weave/blob/v1.0.0/docs/integration.md#use-elkjs-for-layout) installed by your application.
|
|
194
|
+
- **Process lanes:** `layoutSwimlaneGraph` gives each department or work centre a lane in your order; the `lanes` prop draws the bands, also in the minimap and exports, and `graphSwimlaneAt` finds the lane a node was dragged to. See [Swimlanes for process flows](https://github.com/EightKK/vue-weave/blob/v1.0.0/docs/integration.md#swimlanes-for-process-flows).
|
|
195
|
+
- **Quantity flows (Sankey diagrams):** `layoutFlowGraph` sizes each edge by its quantity on one scale, reports inflow, outflow and their difference per node as given, never adds different units, and draws rework loops as dashed reference bands; the `edgeBands` prop renders them with names such as "Cut → Inspect: 60 pcs". See [Quantity flows](https://github.com/EightKK/vue-weave/blob/v1.0.0/docs/integration.md#quantity-flows-sankey-diagrams).
|
|
196
|
+
- **Drawing:** `node`, `edge`, `group` and `minimap-node` slots for your own SVG, `tooltip`, `node-toolbar` and `edge-toolbar` slots for HTML; diamond, ellipse and hexagon nodes; orthogonal or straight edges (`edgeStyle`), routes around nodes (`avoidNodes`), waypoints, end markers, animated edges and spread parallel edges.
|
|
197
|
+
- **Editing as proposals:** node moves, connections checked against typed port rules (`connectionRules`) with valid-target hints, inline label editing, box or lasso selection, nested and collapsible groups, node resizing, snap to grid with alignment guides, palette drops, clipboard, and keyboard deletion.
|
|
198
|
+
- **Navigation:** minimap, viewport culling and level of detail for large graphs, pinch zoom, search highlighting (`matchIds`), `focusNode(id)` and `fit({ ids })`.
|
|
199
|
+
|
|
200
|
+
### GanttChart
|
|
201
|
+
|
|
202
|
+
- **Display:** multiple lanes, progress, milestones and FS/SS/FF/SF dependencies with lag labels; row groups with summary rollups and optional summary dependencies; up to three named baseline sets with variance; header bands, date markers and highlighted ranges (`markerRanges`); a status-date line and progress line; non-working time shading; critical outlines, float lines, deadlines and split bars; a resource load histogram (`loadRows`) that accepts `calculateResourceLoad` output.
|
|
203
|
+
- **Editing as proposals:** drag and keyboard moves and resizes, auto-scheduling previews of the bars a move would push (`cascade`), dependency creation and reconnection, multiple selection and batch moves, drag to create, progress sliders, deletion, row hierarchy moves, column resizing, scheduling constraint handles, typed cell editors (`field-edit`), and drops from your own lists (`bar-drop`).
|
|
204
|
+
- **Time scales:** zoom presets, ready calendar presets in an IANA time zone and locale (`calendarZoomPresets`, `intlTimeFormatter`), a scale that compresses non-working time (`createWorkingTimeScale`), Ctrl+wheel and pinch zoom, a now marker and `fitToBars()`.
|
|
205
|
+
- **Scale:** row and time-window virtualization, and `visible-window-change` to load only the visible weeks and rows.
|
|
206
|
+
|
|
207
|
+
### Headless core (`@eightkk/vue-weave/core`)
|
|
208
|
+
|
|
209
|
+
- **Graph algorithms and metrics:** `topologicalOrder`, `findGraphCycles`, `shortestGraphPath`, `searchGraphNodes`, `filterGraph`, connected components, degree, betweenness and PageRank centrality, and Louvain communities (`detectGraphCommunities`) that `graphCommunityGroups` turns into groups.
|
|
210
|
+
- **Scheduling:** `scheduleTasks` on calendars from `buildWorkPeriods`, including IANA time zones, as-late-as-possible, manual, inactive and summary tasks, constraints, pauses and cycle and infeasibility diagnostics. `scheduleTasks(input, { explain: true })` traces why each task starts when it does, and `toPlanningDiagnostics` lists the problems.
|
|
211
|
+
- **Resources:** `calculateResourceLoad` and `levelResources`, with capacity that changes over time (`capacityPeriods`) and assignments that cover only part of a task (`workOffset`, `workDuration`); `projectResourceTimeline` shows a plan by resource, and `buildPlacementInput` keeps unplanned tasks out of the calculation.
|
|
212
|
+
- **Plan updates:** `propagateEdit`, `rescheduleFromStatusDate`, `rescheduleFromActuals` (keeps recorded actuals and forecasts the rest), and `comparePlans`, which separates what you changed from what moved as a result. See [Compare plan scenarios](https://github.com/EightKK/vue-weave/blob/v1.0.0/docs/scheduling.md#compare-plan-scenarios).
|
|
213
|
+
- **Interchange:** Microsoft Project XML (including calendars, resources and assignments), iCalendar and CSV import and export (`fromMsProjectXml`, `toMsProjectXml`, `fromICalendar`, `toICalendar`, `parseCsv`, `toCsv`), and `scheduleToGraph` for a PERT network diagram.
|
|
214
|
+
|
|
215
|
+
### Linked views, large data and saving
|
|
216
|
+
|
|
217
|
+
- **Linked views:** `useLinkedSelection` links a graph, a Gantt chart and load rows through entity bindings; `revealNode`, `revealBar` and `revealLinkedTarget` move to an item, also inside collapsed groups and rows; `timelineBarsInRange` and `resolveTimeRangeTargets` highlight what was worked on in a time range. See [Linking views](https://github.com/EightKK/vue-weave/blob/v1.0.0/docs/integration.md#linking-views).
|
|
218
|
+
- **Large data:** `useWindowedData` fetches only the visible window through your `load` function, with aborts, deduplication and retry; graph expansion helpers and `layoutGraphIncrementally` load a graph one hop at a time without moving the nodes on display; `useAsyncGraphLayout` runs a layout in a Worker, and `routingPolicy="preserve"` keeps the engine's routes. See [Loading only what is visible](https://github.com/EightKK/vue-weave/blob/v1.0.0/docs/integration.md#loading-only-what-is-visible).
|
|
219
|
+
- **Views and saving:** `useTimelineView` for searched and sorted rows, `useEditHistory` for undo and redo, `useEditTransaction` to save through your server adapter with conflict handling, and `serializeWeaveSnapshot` and `restoreWeaveSnapshot` for versioned, validated JSON.
|
|
220
|
+
|
|
221
|
+
### Export, themes and accessibility
|
|
222
|
+
|
|
223
|
+
- `exportSvg(options)` and `exportPng(options)` on both components, and `renderGraphSvg` and `renderTimelineSvg` for SVG on a server.
|
|
224
|
+
- A built-in dark theme (`vw-theme-dark`) and `vw-theme-auto`, which follows `prefers-color-scheme`; theming through `--vw-*` CSS variables; forced colors, reduced motion and print styles.
|
|
225
|
+
- Right-to-left layouts with `dir="rtl"` (or `auto`).
|
|
226
|
+
- Keyboard operation and ARIA names are built in; see [Status and support](#status-and-support) for what has been tested.
|
|
227
|
+
|
|
228
|
+
```ts
|
|
229
|
+
const svg = chart.value!.exportSvg({ title: 'Plan' })
|
|
230
|
+
const png = await chart.value!.exportPng({ scale: 2 })
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
## Status and support
|
|
234
|
+
|
|
235
|
+
- **Version 1.0.** Releases follow [Semantic Versioning](https://semver.org/): breaking changes are made only in major releases and are listed under "Breaking changes" in the [changelog](https://github.com/EightKK/vue-weave/blob/v1.0.0/CHANGELOG.md). [Compatibility and versioning](https://github.com/EightKK/vue-weave/blob/v1.0.0/docs/api.md#compatibility-and-versioning) lists what that covers (exported names and types, props, events, slots, documented `--vw-*` properties and the snapshot format) and what it does not (the exact text of error messages, the emitted `vw-` classes, DOM structure and server-rendered markup).
|
|
236
|
+
- **Vue:** 3.5 or later in 3.x (peer dependency `^3.5.0`).
|
|
237
|
+
- **Modules and TypeScript:** ESM only. Declarations support `Bundler` and `NodeNext` resolution. Item `data` can be typed (`NetworkNode<MyData>`, `TimelineBar<MyData>`), and that type reaches slot props and callbacks without casts.
|
|
238
|
+
- **Node.js:** 22.18 or later for the headless `@eightkk/vue-weave/core` entry, server-side rendering and development.
|
|
239
|
+
- **Browsers:** current evergreen browsers (Chrome, Edge, Firefox and Safari). Automated browser tests run in Chromium only, so the other browsers are not covered by CI.
|
|
240
|
+
- **Accessibility:** keyboard operation and ARIA names are included. Dedicated screen-reader testing has not been done yet (see [Architecture, performance and scope](https://github.com/EightKK/vue-weave/blob/v1.0.0/docs/architecture.md)), so do not assume full conformance.
|
|
241
|
+
|
|
242
|
+
## Run the demo
|
|
243
|
+
|
|
244
|
+
There is no hosted demo. Run it locally with Node.js 22.18+ and npm. From a source checkout or GitHub source ZIP, run:
|
|
245
|
+
|
|
246
|
+
```sh
|
|
247
|
+
npm ci
|
|
248
|
+
npm run build:demo
|
|
249
|
+
npm start
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
The demo has one page per example (listed under [Gallery](#gallery)), export buttons, a theme switch, and **Undo** and **Redo** for accepted edits. Toggles such as **Edit graph** and **Planning overlays** turn on the opt-in features described above. The **Design gallery** row restyles the same two components using only slots, `--vw-*` variables and `vw-` classes. Edits remain in the demo's local state. The backlog, inspector, diagnostics list and toolbar of the demo are examples in `examples/components/`, not part of the package.
|
|
253
|
+
|
|
254
|
+
On Windows you can double-click `Start.cmd` instead. It serves `preview/` when it was built from the current sources, and otherwise builds it first, running `npm ci` beforehand if the installed dependencies do not match `package-lock.json`. `npm start` serves `preview/` as it is.
|
|
255
|
+
|
|
256
|
+
If you have a prebuilt demo archive containing `preview/` (it may be attached to a release), extract it completely and run `npm start`, or double-click `Start.cmd` on Windows. The prebuilt demo needs Node.js but does not require dependency installation. If you change its sources, `Start.cmd` rebuilds it, which needs npm and an internet connection the first time.
|
|
257
|
+
|
|
258
|
+
For development and verification commands, see [Contributing](https://github.com/EightKK/vue-weave/blob/v1.0.0/CONTRIBUTING.md).
|
|
259
|
+
|
|
260
|
+
## Documentation
|
|
261
|
+
|
|
262
|
+
- [Public API and input contracts](https://github.com/EightKK/vue-weave/blob/v1.0.0/docs/api.md)
|
|
263
|
+
- [Vue, Nuxt, custom rendering, time scales and persistence](https://github.com/EightKK/vue-weave/blob/v1.0.0/docs/integration.md)
|
|
264
|
+
- [Architecture, performance and scope](https://github.com/EightKK/vue-weave/blob/v1.0.0/docs/architecture.md)
|
|
265
|
+
- [Scheduling and resource load](https://github.com/EightKK/vue-weave/blob/v1.0.0/docs/scheduling.md)
|
|
266
|
+
- [Contributing and release process](https://github.com/EightKK/vue-weave/blob/v1.0.0/CONTRIBUTING.md)
|
|
267
|
+
- [Security and private vulnerability reporting](https://github.com/EightKK/vue-weave/blob/v1.0.0/docs/security.md)
|
|
268
|
+
- [Code of conduct](https://github.com/EightKK/vue-weave/blob/v1.0.0/docs/code-of-conduct.md)
|
|
269
|
+
- [Changelog](https://github.com/EightKK/vue-weave/blob/v1.0.0/CHANGELOG.md)
|
|
270
|
+
|
|
271
|
+
## License
|
|
272
|
+
|
|
273
|
+
MIT. See [LICENSE](https://github.com/EightKK/vue-weave/blob/v1.0.0/LICENSE). Third-party notices for the prebuilt demo are in [THIRD_PARTY_NOTICES.md](https://github.com/EightKK/vue-weave/blob/v1.0.0/THIRD_PARTY_NOTICES.md) and [Third-party licenses](https://github.com/EightKK/vue-weave/blob/v1.0.0/docs/third-party-licenses.md).
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Third-party notices
|
|
2
|
+
|
|
3
|
+
The prebuilt example includes Vue 3.5.45 and its runtime packages. The following notice applies to those bundled files.
|
|
4
|
+
|
|
5
|
+
The MIT License (MIT)
|
|
6
|
+
|
|
7
|
+
Copyright (c) 2018-present, Yuxi (Evan) You
|
|
8
|
+
|
|
9
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
10
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
11
|
+
in the Software without restriction, including without limitation the rights
|
|
12
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
13
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
14
|
+
furnished to do so, subject to the following conditions:
|
|
15
|
+
|
|
16
|
+
The above copyright notice and this permission notice shall be included in
|
|
17
|
+
all copies or substantial portions of the Software.
|
|
18
|
+
|
|
19
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
20
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
21
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
22
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
23
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
24
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
25
|
+
THE SOFTWARE.
|