@molecule/app-feature-video-timeline-vue 0.0.0-stage → 1.1.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/LICENSE +202 -0
- package/README.md +461 -2
- package/dist/VideoTimeline.d.ts +216 -0
- package/dist/VideoTimeline.d.ts.map +1 -0
- package/dist/VideoTimeline.js +488 -0
- package/dist/VideoTimeline.js.map +1 -0
- package/dist/index.d.ts +79 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +79 -0
- package/dist/index.js.map +1 -0
- package/dist/timeline.d.ts +89 -0
- package/dist/timeline.d.ts.map +1 -0
- package/dist/timeline.js +148 -0
- package/dist/timeline.js.map +1 -0
- package/dist/types.d.ts +75 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +8 -0
- package/dist/types.js.map +1 -0
- package/package.json +71 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,3 +1,462 @@
|
|
|
1
|
-
|
|
1
|
+
<!--
|
|
2
|
+
AUTO-GENERATED — DO NOT EDIT THIS FILE.
|
|
3
|
+
Generated by `mlcl sync-docs` from the package's src/index.ts JSDoc + mlcl/registry.json.
|
|
4
|
+
Edits here are overwritten on the next commit (molecule's pre-commit hook regenerates).
|
|
5
|
+
To change this document, edit the module-level JSDoc in src/index.ts.
|
|
6
|
+
Generated: 2026-11-21T12:46:33.694Z
|
|
7
|
+
-->
|
|
2
8
|
|
|
3
|
-
|
|
9
|
+
# @molecule/app-feature-video-timeline-vue
|
|
10
|
+
|
|
11
|
+
Vue multi-track video timeline for video editors, DAWs and animation tools.
|
|
12
|
+
Composes one `<TrackLane>` per track row with a shared time ruler, playhead,
|
|
13
|
+
zoom slider + Ctrl+wheel zoom, and ripple/insert edit modes.
|
|
14
|
+
|
|
15
|
+
Vue counterpart of `@molecule/app-feature-video-timeline-react`: the same
|
|
16
|
+
props (React names), the same DOM for the same input, and the same callback
|
|
17
|
+
calls, so an app switches framework by changing only the package name it
|
|
18
|
+
imports.
|
|
19
|
+
|
|
20
|
+
Exports `<VideoTimeline>`, the `Track` and `VideoTimelineMode` types,
|
|
21
|
+
and the pure-function helpers `clampZoom`, `zoomFromWheelDelta`,
|
|
22
|
+
`computeRulerTicks`, `computeRippleUpdates`, and `formatTickTime`
|
|
23
|
+
that back the zoom math, ruler tick generation, and ripple-mode
|
|
24
|
+
fan-out.
|
|
25
|
+
|
|
26
|
+
> **Auto-generated, AI-first package reference** for the [molecule.dev](https://molecule.dev) ecosystem.
|
|
27
|
+
> It is written to be read by coding agents as much as by people, and is generated from this
|
|
28
|
+
> package's source — edit `src/index.ts` JSDoc, not this file.
|
|
29
|
+
|
|
30
|
+
## Quick Start
|
|
31
|
+
|
|
32
|
+
```ts
|
|
33
|
+
import { createApp, defineComponent, h, ref } from 'vue'
|
|
34
|
+
import { VideoTimeline } from '@molecule/app-feature-video-timeline-vue'
|
|
35
|
+
|
|
36
|
+
const App = defineComponent({
|
|
37
|
+
setup() {
|
|
38
|
+
const currentTime = ref(3.2)
|
|
39
|
+
const zoom = ref(20)
|
|
40
|
+
return () =>
|
|
41
|
+
h(VideoTimeline, {
|
|
42
|
+
tracks: [
|
|
43
|
+
{
|
|
44
|
+
id: 'v1',
|
|
45
|
+
kind: 'video',
|
|
46
|
+
clips: [{ id: 'a', startTime: 0, duration: 5, label: 'Intro' }],
|
|
47
|
+
},
|
|
48
|
+
{
|
|
49
|
+
id: 'a1',
|
|
50
|
+
kind: 'audio',
|
|
51
|
+
clips: [{ id: 'b', startTime: 0, duration: 12 }],
|
|
52
|
+
},
|
|
53
|
+
],
|
|
54
|
+
currentTime: currentTime.value,
|
|
55
|
+
duration: 60,
|
|
56
|
+
pixelsPerSecond: zoom.value,
|
|
57
|
+
mode: 'ripple',
|
|
58
|
+
onSeek: (t: number) => {
|
|
59
|
+
currentTime.value = t
|
|
60
|
+
},
|
|
61
|
+
onClipMove: (id: string, startTime: number, trackId: string) => {
|
|
62
|
+
updateClip(trackId, id, { startTime })
|
|
63
|
+
},
|
|
64
|
+
onClipResize: (id: string, duration: number, trackId: string) => {
|
|
65
|
+
updateClip(trackId, id, { duration })
|
|
66
|
+
},
|
|
67
|
+
onZoomChange: (pps: number) => {
|
|
68
|
+
zoom.value = pps
|
|
69
|
+
},
|
|
70
|
+
})
|
|
71
|
+
},
|
|
72
|
+
})
|
|
73
|
+
|
|
74
|
+
createApp(App).mount('#app')
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
## Type
|
|
78
|
+
|
|
79
|
+
`feature`
|
|
80
|
+
|
|
81
|
+
## Installation
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
npm install @molecule/app-feature-video-timeline-vue @molecule/app-feature-track-lane-vue @molecule/app-ui @molecule/app-ui-vue @molecule/app-vue vue
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
## API
|
|
88
|
+
|
|
89
|
+
### Interfaces
|
|
90
|
+
|
|
91
|
+
#### `Track`
|
|
92
|
+
|
|
93
|
+
One track row on a `<VideoTimeline>`. Tracks are rendered in array
|
|
94
|
+
order top-to-bottom and each track delegates clip rendering to a
|
|
95
|
+
`<TrackLane>` row.
|
|
96
|
+
|
|
97
|
+
```typescript
|
|
98
|
+
interface Track {
|
|
99
|
+
/** Stable identifier — used as the row key and lane id passed to handlers. */
|
|
100
|
+
id: string
|
|
101
|
+
/** The kind of media on this track. */
|
|
102
|
+
kind: TrackKind
|
|
103
|
+
/** Clips on this track. Order is preserved as-is. */
|
|
104
|
+
clips: Clip[]
|
|
105
|
+
/** Optional human-friendly track name; falls back to a translated kind label. */
|
|
106
|
+
name?: string
|
|
107
|
+
}
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
#### `VideoTimelineProps`
|
|
111
|
+
|
|
112
|
+
Props accepted by the {@link VideoTimeline} component — the same props React's accepts.
|
|
113
|
+
|
|
114
|
+
```typescript
|
|
115
|
+
interface VideoTimelineProps {
|
|
116
|
+
/** Tracks to render. Order is preserved as-is. */
|
|
117
|
+
tracks: Track[]
|
|
118
|
+
/** Current playhead time in seconds. Drives the playhead vertical line. */
|
|
119
|
+
currentTime: number
|
|
120
|
+
/** Total timeline duration in seconds — used to size the scrollable body. */
|
|
121
|
+
duration: number
|
|
122
|
+
/** Called when the user clicks/scrubs the ruler. */
|
|
123
|
+
onSeek?: (time: number) => void
|
|
124
|
+
/** Called when a clip on a lane is dragged horizontally. */
|
|
125
|
+
onClipMove?: (clipId: string, startTime: number, trackId: string) => void
|
|
126
|
+
/** Called when a clip's right-edge resize handle is dragged. */
|
|
127
|
+
onClipResize?: (clipId: string, duration: number, trackId: string) => void
|
|
128
|
+
/** Horizontal scale (px per second). Defaults to 20. */
|
|
129
|
+
pixelsPerSecond?: number
|
|
130
|
+
/** Lower zoom bound for Ctrl+wheel / slider. Defaults to 2. */
|
|
131
|
+
zoomMin?: number
|
|
132
|
+
/** Upper zoom bound for Ctrl+wheel / slider. Defaults to 200. */
|
|
133
|
+
zoomMax?: number
|
|
134
|
+
/** Edit mode for clip drags. Defaults to `'ripple'`. */
|
|
135
|
+
mode?: VideoTimelineMode
|
|
136
|
+
/** Called when the user changes the zoom (slider or Ctrl+wheel). */
|
|
137
|
+
onZoomChange?: (pixelsPerSecond: number) => void
|
|
138
|
+
/** Optional currently-selected clip id. */
|
|
139
|
+
selectedClipId?: string
|
|
140
|
+
/** Called when a clip is clicked (no drag). */
|
|
141
|
+
onClipClick?: (clipId: string, trackId: string) => void
|
|
142
|
+
/** Per-track row height in pixels. Defaults to 44. */
|
|
143
|
+
trackHeight?: number
|
|
144
|
+
/** Width of the leading lane-header column in pixels. Defaults to 120. */
|
|
145
|
+
laneHeaderWidth?: number
|
|
146
|
+
/** Height of the time ruler row in pixels. Defaults to 28. */
|
|
147
|
+
rulerHeight?: number
|
|
148
|
+
/** Extra classes merged onto the root element. */
|
|
149
|
+
className?: string
|
|
150
|
+
}
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
### Types
|
|
154
|
+
|
|
155
|
+
#### `TrackKind`
|
|
156
|
+
|
|
157
|
+
The kind of media a track holds. Drives the lane name fallback,
|
|
158
|
+
the default clip color, and the data attribute parents can hook
|
|
159
|
+
onto for kind-specific styling.
|
|
160
|
+
|
|
161
|
+
```typescript
|
|
162
|
+
type TrackKind = 'video' | 'audio' | 'subtitle'
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
#### `VideoTimelineMode`
|
|
166
|
+
|
|
167
|
+
Edit mode applied to clip drags.
|
|
168
|
+
|
|
169
|
+
- `insert` — dragging a clip just drops it at the new position; other clips
|
|
170
|
+
on the lane stay where they are.
|
|
171
|
+
- `ripple` — dragging a clip shifts every later clip on the same lane by
|
|
172
|
+
the same delta, preserving inter-clip gaps.
|
|
173
|
+
|
|
174
|
+
```typescript
|
|
175
|
+
type VideoTimelineMode = 'ripple' | 'insert'
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
### Functions
|
|
179
|
+
|
|
180
|
+
#### `clampZoom(value, min, max)`
|
|
181
|
+
|
|
182
|
+
Clamp a candidate `pixelsPerSecond` value into `[min, max]`. Used by
|
|
183
|
+
the zoom slider, Ctrl+wheel, and any external zoom button that calls
|
|
184
|
+
`onZoomChange`.
|
|
185
|
+
|
|
186
|
+
```typescript
|
|
187
|
+
function clampZoom(value: number, min: number, max: number): number
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
- `value` — Candidate horizontal scale in px/sec.
|
|
191
|
+
- `min` — Lower bound (inclusive).
|
|
192
|
+
- `max` — Upper bound (inclusive).
|
|
193
|
+
|
|
194
|
+
**Returns:** The clamped value.
|
|
195
|
+
|
|
196
|
+
#### `zoomFromWheelDelta(current, deltaY, min, max)`
|
|
197
|
+
|
|
198
|
+
Compute the next zoom value for a Ctrl+wheel notch. Negative `deltaY`
|
|
199
|
+
(scroll-up) zooms in; positive zooms out. Result is clamped into
|
|
200
|
+
`[min, max]`.
|
|
201
|
+
|
|
202
|
+
```typescript
|
|
203
|
+
function zoomFromWheelDelta(current: number, deltaY: number, min: number, max: number): number
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
- `current` — Current `pixelsPerSecond`.
|
|
207
|
+
- `deltaY` — Wheel `deltaY` (sign-only — magnitude is ignored).
|
|
208
|
+
- `min` — Lower zoom bound.
|
|
209
|
+
- `max` — Upper zoom bound.
|
|
210
|
+
|
|
211
|
+
**Returns:** The clamped next zoom value.
|
|
212
|
+
|
|
213
|
+
#### `computeRulerTicks(duration, pixelsPerSecond)`
|
|
214
|
+
|
|
215
|
+
Compute time tick marks for the ruler. Picks an interval (1, 2, 5, 10,
|
|
216
|
+
30, or 60 seconds, etc.) so that adjacent ticks are at least
|
|
217
|
+
`MIN_TICK_PIXEL_SPACING` apart on screen. Always emits a tick at 0 and
|
|
218
|
+
stops at the last tick `<= duration`.
|
|
219
|
+
|
|
220
|
+
```typescript
|
|
221
|
+
function computeRulerTicks(
|
|
222
|
+
duration: number,
|
|
223
|
+
pixelsPerSecond: number,
|
|
224
|
+
): { time: number; pixel: number }[]
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
- `duration` — Total duration in seconds.
|
|
228
|
+
- `pixelsPerSecond` — Horizontal scale.
|
|
229
|
+
|
|
230
|
+
**Returns:** Tick descriptors with `{ time, pixel }`.
|
|
231
|
+
|
|
232
|
+
#### `computeRippleUpdates(clips, draggedClipId, proposedStartTime)`
|
|
233
|
+
|
|
234
|
+
Compute the ripple-mode update for a clip drag on a single lane.
|
|
235
|
+
Returns one update per affected clip — at minimum the dragged clip,
|
|
236
|
+
plus every clip whose original `startTime` is strictly greater (which
|
|
237
|
+
shifts by the same `delta`).
|
|
238
|
+
|
|
239
|
+
Negative deltas are clamped so no clip's `startTime` goes below 0
|
|
240
|
+
(the dragged clip is the limiting factor — later clips can never
|
|
241
|
+
cross zero before it does, since they all started later).
|
|
242
|
+
|
|
243
|
+
```typescript
|
|
244
|
+
function computeRippleUpdates(
|
|
245
|
+
clips: Clip[],
|
|
246
|
+
draggedClipId: string,
|
|
247
|
+
proposedStartTime: number,
|
|
248
|
+
): { id: string; startTime: number }[]
|
|
249
|
+
```
|
|
250
|
+
|
|
251
|
+
- `clips` — All clips on the lane (any order).
|
|
252
|
+
- `draggedClipId` — The id of the clip being dragged.
|
|
253
|
+
- `proposedStartTime` — The candidate new `startTime` for the dragged clip.
|
|
254
|
+
|
|
255
|
+
**Returns:** Array of `{ id, startTime }` updates to apply.
|
|
256
|
+
|
|
257
|
+
#### `formatTickTime(seconds)`
|
|
258
|
+
|
|
259
|
+
Format a tick time for the ruler — `mm:ss` over a minute, `s.s` below.
|
|
260
|
+
|
|
261
|
+
```typescript
|
|
262
|
+
function formatTickTime(seconds: number): string
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
- `seconds` — Time in seconds.
|
|
266
|
+
|
|
267
|
+
**Returns:** Formatted string for the tick label.
|
|
268
|
+
|
|
269
|
+
### Constants
|
|
270
|
+
|
|
271
|
+
#### `VideoTimeline`
|
|
272
|
+
|
|
273
|
+
Multi-track video timeline. Composes one `<TrackLane>` per track with
|
|
274
|
+
a shared time ruler at the top, a vertical playhead, and a zoom slider
|
|
275
|
+
row. Pointer-down on the ruler scrubs `onSeek`; Ctrl+wheel anywhere
|
|
276
|
+
over the body changes zoom; the slider is keyboard-accessible.
|
|
277
|
+
|
|
278
|
+
In `'ripple'` mode (default), dragging a clip on a lane shifts every
|
|
279
|
+
subsequent clip on that lane by the same delta — `onClipMove` is
|
|
280
|
+
called once per affected clip. In `'insert'` mode, only the dragged
|
|
281
|
+
clip moves.
|
|
282
|
+
|
|
283
|
+
```typescript
|
|
284
|
+
const VideoTimeline: DefineComponent<
|
|
285
|
+
ExtractPropTypes<{
|
|
286
|
+
tracks: { type: PropType<Track[]>; required: true }
|
|
287
|
+
currentTime: { type: NumberConstructor; required: true }
|
|
288
|
+
duration: { type: NumberConstructor; required: true }
|
|
289
|
+
onSeek: { type: PropType<VideoTimelineProps['onSeek']>; default: undefined }
|
|
290
|
+
onClipMove: { type: PropType<VideoTimelineProps['onClipMove']>; default: undefined }
|
|
291
|
+
onClipResize: { type: PropType<VideoTimelineProps['onClipResize']>; default: undefined }
|
|
292
|
+
pixelsPerSecond: { type: PropType<number | undefined>; default: undefined }
|
|
293
|
+
zoomMin: { type: PropType<number | undefined>; default: undefined }
|
|
294
|
+
zoomMax: { type: PropType<number | undefined>; default: undefined }
|
|
295
|
+
mode: { type: PropType<VideoTimelineMode | undefined>; default: undefined }
|
|
296
|
+
onZoomChange: { type: PropType<VideoTimelineProps['onZoomChange']>; default: undefined }
|
|
297
|
+
selectedClipId: { type: PropType<string | undefined>; default: undefined }
|
|
298
|
+
onClipClick: { type: PropType<VideoTimelineProps['onClipClick']>; default: undefined }
|
|
299
|
+
trackHeight: { type: PropType<number | undefined>; default: undefined }
|
|
300
|
+
laneHeaderWidth: { type: PropType<number | undefined>; default: undefined }
|
|
301
|
+
rulerHeight: { type: PropType<number | undefined>; default: undefined }
|
|
302
|
+
className: { type: PropType<string | undefined>; default: undefined }
|
|
303
|
+
}>,
|
|
304
|
+
() => VNode,
|
|
305
|
+
{},
|
|
306
|
+
{},
|
|
307
|
+
{},
|
|
308
|
+
ComponentOptionsMixin,
|
|
309
|
+
ComponentOptionsMixin,
|
|
310
|
+
{},
|
|
311
|
+
string,
|
|
312
|
+
PublicProps,
|
|
313
|
+
Readonly<
|
|
314
|
+
ExtractPropTypes<{
|
|
315
|
+
tracks: { type: PropType<Track[]>; required: true }
|
|
316
|
+
currentTime: { type: NumberConstructor; required: true }
|
|
317
|
+
duration: { type: NumberConstructor; required: true }
|
|
318
|
+
onSeek: { type: PropType<VideoTimelineProps['onSeek']>; default: undefined }
|
|
319
|
+
onClipMove: { type: PropType<VideoTimelineProps['onClipMove']>; default: undefined }
|
|
320
|
+
onClipResize: { type: PropType<VideoTimelineProps['onClipResize']>; default: undefined }
|
|
321
|
+
pixelsPerSecond: { type: PropType<number | undefined>; default: undefined }
|
|
322
|
+
zoomMin: { type: PropType<number | undefined>; default: undefined }
|
|
323
|
+
zoomMax: { type: PropType<number | undefined>; default: undefined }
|
|
324
|
+
mode: { type: PropType<VideoTimelineMode | undefined>; default: undefined }
|
|
325
|
+
onZoomChange: { type: PropType<VideoTimelineProps['onZoomChange']>; default: undefined }
|
|
326
|
+
selectedClipId: { type: PropType<string | undefined>; default: undefined }
|
|
327
|
+
onClipClick: { type: PropType<VideoTimelineProps['onClipClick']>; default: undefined }
|
|
328
|
+
trackHeight: { type: PropType<number | undefined>; default: undefined }
|
|
329
|
+
laneHeaderWidth: { type: PropType<number | undefined>; default: undefined }
|
|
330
|
+
rulerHeight: { type: PropType<number | undefined>; default: undefined }
|
|
331
|
+
className: { type: PropType<string | undefined>; default: undefined }
|
|
332
|
+
}>
|
|
333
|
+
> &
|
|
334
|
+
Readonly<{}>,
|
|
335
|
+
{
|
|
336
|
+
onSeek: ((time: number) => void) | undefined
|
|
337
|
+
onClipMove: ((clipId: string, startTime: number, trackId: string) => void) | undefined
|
|
338
|
+
onClipResize: ((clipId: string, duration: number, trackId: string) => void) | undefined
|
|
339
|
+
onZoomChange: ((pixelsPerSecond: number) => void) | undefined
|
|
340
|
+
onClipClick: ((clipId: string, trackId: string) => void) | undefined
|
|
341
|
+
pixelsPerSecond: number | undefined
|
|
342
|
+
zoomMin: number | undefined
|
|
343
|
+
zoomMax: number | undefined
|
|
344
|
+
mode: VideoTimelineMode | undefined
|
|
345
|
+
selectedClipId: string | undefined
|
|
346
|
+
trackHeight: number | undefined
|
|
347
|
+
laneHeaderWidth: number | undefined
|
|
348
|
+
rulerHeight: number | undefined
|
|
349
|
+
className: string | undefined
|
|
350
|
+
},
|
|
351
|
+
{},
|
|
352
|
+
{},
|
|
353
|
+
{},
|
|
354
|
+
string,
|
|
355
|
+
ComponentProvideOptions,
|
|
356
|
+
true,
|
|
357
|
+
{},
|
|
358
|
+
any
|
|
359
|
+
>
|
|
360
|
+
```
|
|
361
|
+
|
|
362
|
+
- `props` — Component props (see {@link VideoTimelineProps}).
|
|
363
|
+
|
|
364
|
+
**Returns:** The multi-track timeline component.
|
|
365
|
+
|
|
366
|
+
#### `DEFAULT_PIXELS_PER_SECOND`
|
|
367
|
+
|
|
368
|
+
Default horizontal scale.
|
|
369
|
+
|
|
370
|
+
```typescript
|
|
371
|
+
const DEFAULT_PIXELS_PER_SECOND: 20
|
|
372
|
+
```
|
|
373
|
+
|
|
374
|
+
#### `DEFAULT_ZOOM_MIN`
|
|
375
|
+
|
|
376
|
+
Default lower zoom bound.
|
|
377
|
+
|
|
378
|
+
```typescript
|
|
379
|
+
const DEFAULT_ZOOM_MIN: 2
|
|
380
|
+
```
|
|
381
|
+
|
|
382
|
+
#### `DEFAULT_ZOOM_MAX`
|
|
383
|
+
|
|
384
|
+
Default upper zoom bound.
|
|
385
|
+
|
|
386
|
+
```typescript
|
|
387
|
+
const DEFAULT_ZOOM_MAX: 200
|
|
388
|
+
```
|
|
389
|
+
|
|
390
|
+
#### `DEFAULT_TRACK_HEIGHT`
|
|
391
|
+
|
|
392
|
+
Default per-track row height.
|
|
393
|
+
|
|
394
|
+
```typescript
|
|
395
|
+
const DEFAULT_TRACK_HEIGHT: 44
|
|
396
|
+
```
|
|
397
|
+
|
|
398
|
+
#### `DEFAULT_LANE_HEADER_WIDTH`
|
|
399
|
+
|
|
400
|
+
Default lane-header column width.
|
|
401
|
+
|
|
402
|
+
```typescript
|
|
403
|
+
const DEFAULT_LANE_HEADER_WIDTH: 120
|
|
404
|
+
```
|
|
405
|
+
|
|
406
|
+
#### `DEFAULT_RULER_HEIGHT`
|
|
407
|
+
|
|
408
|
+
Default ruler height.
|
|
409
|
+
|
|
410
|
+
```typescript
|
|
411
|
+
const DEFAULT_RULER_HEIGHT: 28
|
|
412
|
+
```
|
|
413
|
+
|
|
414
|
+
#### `ZOOM_WHEEL_FACTOR`
|
|
415
|
+
|
|
416
|
+
Multiplier per Ctrl+wheel notch (positive deltaY zooms out).
|
|
417
|
+
|
|
418
|
+
```typescript
|
|
419
|
+
const ZOOM_WHEEL_FACTOR: 1.1
|
|
420
|
+
```
|
|
421
|
+
|
|
422
|
+
#### `MIN_TICK_PIXEL_SPACING`
|
|
423
|
+
|
|
424
|
+
Minimum spacing (px) between adjacent ruler ticks.
|
|
425
|
+
|
|
426
|
+
```typescript
|
|
427
|
+
const MIN_TICK_PIXEL_SPACING: 60
|
|
428
|
+
```
|
|
429
|
+
|
|
430
|
+
## Injection Notes
|
|
431
|
+
|
|
432
|
+
### Requirements
|
|
433
|
+
|
|
434
|
+
Peer dependencies:
|
|
435
|
+
|
|
436
|
+
- `@molecule/app-feature-track-lane-vue` ^1.0.0
|
|
437
|
+
- `@molecule/app-ui` ^1.0.1
|
|
438
|
+
- `@molecule/app-ui-vue` ^1.1.0
|
|
439
|
+
- `@molecule/app-vue` ^3.5.0
|
|
440
|
+
- `vue` ^3.4.0
|
|
441
|
+
|
|
442
|
+
### Runtime Dependencies
|
|
443
|
+
|
|
444
|
+
- `@molecule/app-feature-track-lane-vue`
|
|
445
|
+
- `@molecule/app-ui`
|
|
446
|
+
- `@molecule/app-ui-vue`
|
|
447
|
+
- `@molecule/app-vue`
|
|
448
|
+
- `vue`
|
|
449
|
+
|
|
450
|
+
- Requires a bonded ClassMap (`cm.flex`, `cm.cn`, …) and the binding's i18n
|
|
451
|
+
plugin for the translated labels — rendering throws without a ClassMap.
|
|
452
|
+
- Ripple mode (default) shifts all later clips on the same lane by the same
|
|
453
|
+
delta when a clip is dragged, preserving inter-clip gaps. Switch to
|
|
454
|
+
`mode: 'insert'` to drop the dragged clip at its new position without
|
|
455
|
+
disturbing the rest of the lane.
|
|
456
|
+
- Every visible string comes from `useTranslation()` (`videoTimeline.aria.*`,
|
|
457
|
+
`videoTimeline.trackKind.*`, `videoTimeline.mode.*`, `videoTimeline.zoom.*`),
|
|
458
|
+
so a locale switch re-renders the timeline.
|
|
459
|
+
|
|
460
|
+
## Translations
|
|
461
|
+
|
|
462
|
+
Translation strings are provided by `@molecule/app-locales-feature-video-timeline`.
|