Skip to content

Visualize Your Ideas With Code

feat(ui): add direct range selection & playhead shortcuts (#907)

Jannik Mänzer39264fc074da
diff --git a/packages/ui/src/components/timeline/RangeSelector.tsx b/packages/ui/src/components/timeline/RangeSelector.tsx
index 5b689f2a..575d3728 100644
--- a/packages/ui/src/components/timeline/RangeSelector.tsx
+++ b/packages/ui/src/components/timeline/RangeSelector.tsx
@@ -19,8 +19,8 @@ export interface RangeSelectorProps {
}
export function RangeSelector({rangeRef}: RangeSelectorProps) {
- const {pixelsToFrames, framesToPercents} = useTimelineContext();
-
+ const {pixelsToFrames, framesToPercents, pointerToFrames} =
+ useTimelineContext();
const {player, meta} = useApplication();
const {range} = useSharedSettings();
const {fps} = usePreviewSettings();
@@ -30,6 +30,7 @@ export function RangeSelector({rangeRef}: RangeSelectorProps) {
const [start, setStart] = useState(startFrame);
const [end, setEnd] = useState(endFrame);
const shiftHeld = useKeyHold('Shift');
+ const controlHeld = useKeyHold('Control');
const onDrop = useCallback(() => {
labelClipDraggingLeftSignal.value = null;
@@ -51,24 +52,22 @@ export function RangeSelector({rangeRef}: RangeSelectorProps) {
return (
<div
ref={rangeRef}
- style={{
- flexDirection: start > end ? 'row-reverse' : 'row',
- left: `${framesToPercents(Math.ceil(Math.max(0, normalizedStart)))}%`,
- right: `${
- 100 - framesToPercents(Math.ceil(Math.min(duration, normalizedEnd)))
- }%`,
- }}
- className={clsx(styles.range, shiftHeld && styles.active)}
+ className={clsx(
+ styles.rangeTrack,
+ shiftHeld && controlHeld && styles.active,
+ )}
onPointerDown={event => {
if (event.button === MouseButton.Left) {
event.preventDefault();
event.stopPropagation();
event.currentTarget.setPointerCapture(event.pointerId);
+
+ setStart(pointerToFrames(event.clientX));
+ setEnd(pointerToFrames(event.clientX));
}
}}
onPointerMove={event => {
if (event.currentTarget.hasPointerCapture(event.pointerId)) {
- setStart(start + pixelsToFrames(event.movementX));
setEnd(end + pixelsToFrames(event.movementX));
}
}}
@@ -78,13 +77,46 @@ export function RangeSelector({rangeRef}: RangeSelectorProps) {
onDrop();
}
}}
- onDblClick={() => {
- meta.shared.range.update(0, Infinity, duration, fps);
- }}
>
- <RangeHandle value={start} setValue={setStart} onDrop={onDrop} />
- <div class={styles.handleSpacer} />
- <RangeHandle value={end} setValue={setEnd} onDrop={onDrop} />
+ <div
+ style={{
+ flexDirection: start > end ? 'row-reverse' : 'row',
+ left: `${framesToPercents(Math.ceil(Math.max(0, normalizedStart)))}%`,
+ right: `${
+ 100 - framesToPercents(Math.ceil(Math.min(duration, normalizedEnd)))
+ }%`,
+ }}
+ className={clsx(
+ styles.range,
+ shiftHeld && !controlHeld && styles.active,
+ )}
+ onPointerDown={event => {
+ if (event.button === MouseButton.Left) {
+ event.preventDefault();
+ event.stopPropagation();
+ event.currentTarget.setPointerCapture(event.pointerId);
+ }
+ }}
+ onPointerMove={event => {
+ if (event.currentTarget.hasPointerCapture(event.pointerId)) {
+ setStart(start + pixelsToFrames(event.movementX));
+ setEnd(end + pixelsToFrames(event.movementX));
+ }
+ }}
+ onPointerUp={event => {
+ if (event.button === MouseButton.Left) {
+ event.currentTarget.releasePointerCapture(event.pointerId);
+ onDrop();
+ }
+ }}
+ onDblClick={() => {
+ meta.shared.range.update(0, Infinity, duration, fps);
+ }}
+ >
+ <RangeHandle value={start} setValue={setStart} onDrop={onDrop} />
+ <div class={styles.handleSpacer} />
+ <RangeHandle value={end} setValue={setEnd} onDrop={onDrop} />
+ </div>
</div>
);
}
diff --git a/packages/ui/src/components/timeline/Timeline.module.scss b/packages/ui/src/components/timeline/Timeline.module.scss
index dc5be0f3..972c5efa 100644
--- a/packages/ui/src/components/timeline/Timeline.module.scss
+++ b/packages/ui/src/components/timeline/Timeline.module.scss
@@ -45,14 +45,6 @@
width: 100%;
height: 100%;
background-color: var(--surface-color);
-
- &::before {
- width: 100%;
- height: 32px;
- display: block;
- content: '';
- background-color: var(--background-color);
- }
}
.timestamp {
@@ -283,6 +275,16 @@
}
}
+.rangeTrack {
+ height: 32px;
+ cursor: pointer;
+ pointer-events: none;
+
+ &.active {
+ pointer-events: auto;
+ }
+}
+
.range {
border-radius: var(--radius);
cursor: move;
@@ -299,6 +301,10 @@
pointer-events: auto;
border-color: rgba(255, 255, 255, 0.24);
}
+
+ .rangeTrack.active > & {
+ border-color: rgba(255, 255, 255, 0.24);
+ }
}
.handle {
diff --git a/packages/ui/src/components/timeline/Timeline.tsx b/packages/ui/src/components/timeline/Timeline.tsx
index ee125781..0b3dbece 100644
--- a/packages/ui/src/components/timeline/Timeline.tsx
+++ b/packages/ui/src/components/timeline/Timeline.tsx
@@ -2,7 +2,7 @@ import styles from './Timeline.module.scss';
import {useSignal, useSignalEffect} from '@preact/signals';
import clsx from 'clsx';
-import {useCallback, useLayoutEffect, useMemo, useRef} from 'preact/hooks';
+import {useLayoutEffect, useMemo, useRef} from 'preact/hooks';
import {
TimelineContextProvider,
TimelineState,
@@ -13,6 +13,7 @@ import {
useDuration,
usePreviewSettings,
useReducedMotion,
+ useSharedSettings,
useSize,
useStateChange,
useStorage,
@@ -35,7 +36,8 @@ const MAX_FRAME_SIZE = 128;
export function Timeline() {
const [hoverRef] = useShortcut<HTMLDivElement>('timeline');
- const {player} = useApplication();
+ const {player, meta} = useApplication();
+ const {range} = useSharedSettings();
const containerRef = useRef<HTMLDivElement>();
const playheadRef = useRef<HTMLDivElement>();
const rangeRef = useRef<HTMLDivElement>();
@@ -94,6 +96,7 @@ export function Timeline() {
relativeOffset + sizes.viewLength + TIMESTAMP_SPACING,
) / clampedSegmentDensity,
) * clampedSegmentDensity;
+ const startPosition = sizes.paddingLeft + rect.x - offset;
return {
viewLength: sizes.viewLength,
@@ -102,6 +105,8 @@ export function Timeline() {
lastVisibleFrame,
density,
segmentDensity,
+ pointerToFrames: (value: number) =>
+ conversion.pixelsToFrames(value - startPosition),
...conversion,
};
}, [sizes, conversion, duration, offset]);
@@ -123,24 +128,33 @@ export function Timeline() {
[duration / fps, rect.width],
);
- useDocumentEvent(
- 'keydown',
- useCallback(
- event => {
- if (document.activeElement.tagName === 'INPUT') {
- return;
- }
- if (event.key !== 'f') return;
- const frame = player.onFrameChanged.current;
+ useDocumentEvent('keydown', event => {
+ if (document.activeElement.tagName === 'INPUT') {
+ return;
+ }
+
+ const frame = player.onFrameChanged.current;
+ switch (event.key) {
+ case 'f': {
const maxOffset = sizes.fullLength - sizes.viewLength;
const scrollLeft = state.framesToPixels(frame);
const newOffset = clamp(0, maxOffset, scrollLeft);
containerRef.current.scrollLeft = newOffset;
setOffset(newOffset);
- },
- [sizes],
- ),
- );
+ break;
+ }
+ case 'b': {
+ const end = player.status.secondsToFrames(range[1]);
+ meta.shared.range.update(frame, end, duration, fps);
+ break;
+ }
+ case 'n': {
+ const start = player.status.secondsToFrames(range[0]);
+ meta.shared.range.update(start, frame, duration, fps);
+ break;
+ }
+ }
+ });
useLayoutEffect(() => {
containerRef.current.scrollLeft = offset;
@@ -157,9 +171,7 @@ export function Timeline() {
});
const scrub = (x: number) => {
- const frame = Math.floor(
- state.pixelsToFrames(offset - sizes.paddingLeft + x - rect.x),
- );
+ const frame = Math.floor(state.pointerToFrames(x));
seeking.value = player.clampRange(frame);
if (player.onFrameChanged.current !== frame) {
diff --git a/packages/ui/src/contexts/shortcuts.tsx b/packages/ui/src/contexts/shortcuts.tsx
index 1d9d2113..934db8ab 100644
--- a/packages/ui/src/contexts/shortcuts.tsx
+++ b/packages/ui/src/contexts/shortcuts.tsx
@@ -37,7 +37,11 @@ const InitialShortcuts: ShortcutsByModule = {
available: () => typeof EyeDropper === 'function',
},
],
- timeline: [{key: 'F', action: 'Focus playhead'}],
+ timeline: [
+ {key: 'F', action: 'Focus playhead'},
+ {key: 'B', action: 'Move range start to playhead'},
+ {key: 'N', action: 'Move range end to playhead'},
+ ],
none: [],
};
diff --git a/packages/ui/src/contexts/timeline.tsx b/packages/ui/src/contexts/timeline.tsx
index 63b4ed3c..e2a22815 100644
--- a/packages/ui/src/contexts/timeline.tsx
+++ b/packages/ui/src/contexts/timeline.tsx
@@ -31,13 +31,17 @@ export interface TimelineState {
*/
framesToPercents: (value: number) => number;
/**
- * Convert frames pixels
+ * Convert frames to pixels.
*/
framesToPixels: (value: number) => number;
/**
* Convert pixels to frames.
*/
pixelsToFrames: (value: number) => number;
+ /**
+ * Convert current pointer position to frames.
+ */
+ pointerToFrames: (value: number) => number;
}
const TimelineContext = createContext<TimelineState>({
@@ -50,6 +54,7 @@ const TimelineContext = createContext<TimelineState>({
framesToPercents: value => value,
framesToPixels: value => value,
pixelsToFrames: value => value,
+ pointerToFrames: value => value,
});
export function TimelineContextProvider({