Skip to content

πŸŽ₯ Make videos programmatically with React

Show trim timing tooltip while dragging timeline edges

JonnyBurgerfcef28a7a8ca
diff --git a/packages/studio/src/components/Timeline/TimelineSequence.tsx b/packages/studio/src/components/Timeline/TimelineSequence.tsx
index a871010fce..24b8a54b02 100644
--- a/packages/studio/src/components/Timeline/TimelineSequence.tsx
+++ b/packages/studio/src/components/Timeline/TimelineSequence.tsx
@@ -1092,6 +1092,8 @@ const TimelineSequenceInner: React.FC<{
nodePathInfo={nodePathInfo}
windowWidth={windowWidth}
timelineDurationInFrames={video.durationInFrames ?? 1}
+ initialEdgeFrame={s.from}
+ fps={video.fps}
onDragEnd={dragAwareDoubleClick.endPointerGesture}
onSelect={onSelect}
selected={selected}
@@ -1106,6 +1108,18 @@ const TimelineSequenceInner: React.FC<{
mediaDurationDragLimits={mediaDurationDragLimits}
windowWidth={windowWidth}
timelineDurationInFrames={video.durationInFrames ?? 1}
+ initialEdgeFrame={
+ s.from +
+ Math.max(
+ 0,
+ Math.min(
+ displayDurationInFrames,
+ effectiveMaxMediaDuration ?? Infinity,
+ video.durationInFrames - s.from,
+ ),
+ )
+ }
+ fps={video.fps}
onDragEnd={dragAwareDoubleClick.endPointerGesture}
onSelect={onSelect}
selected={selected}
diff --git a/packages/studio/src/components/Timeline/TimelineSequenceRightEdgeDragHandle.tsx b/packages/studio/src/components/Timeline/TimelineSequenceRightEdgeDragHandle.tsx
index 9d85adb303..512c3adcf2 100644
--- a/packages/studio/src/components/Timeline/TimelineSequenceRightEdgeDragHandle.tsx
+++ b/packages/studio/src/components/Timeline/TimelineSequenceRightEdgeDragHandle.tsx
@@ -3,7 +3,13 @@ import {
stringifySequenceExpandedRowKey,
stringifySequenceSubscriptionKey,
} from '@remotion/studio-shared';
-import React, {useCallback, useContext, useEffect, useRef} from 'react';
+import React, {
+ useCallback,
+ useContext,
+ useEffect,
+ useRef,
+ useState,
+} from 'react';
import type {
CanUpdateSequencePropStatus,
CanUpdateSequencePropStatusKeyframed,
@@ -45,6 +51,10 @@ import {
type TimelineSelection,
type TimelineSelectionInteraction,
} from './TimelineSelection';
+import {
+ TimelineTrimTooltip,
+ type TimelineTrimTooltipState,
+} from './TimelineTrimTooltip';
const HANDLE_INSET = 6;
const HANDLE_OUTSET = 8;
@@ -1240,6 +1250,8 @@ const TimelineSequenceLeftEdgeDragHandleInner: React.FC<{
readonly nodePathInfo: SequenceNodePathInfo;
readonly windowWidth: number;
readonly timelineDurationInFrames: number;
+ readonly initialEdgeFrame: number;
+ readonly fps: number;
readonly onDragEnd: (wasDragged: boolean) => void;
readonly onSelect: (interaction?: TimelineSelectionInteraction) => void;
readonly selected: boolean;
@@ -1247,6 +1259,8 @@ const TimelineSequenceLeftEdgeDragHandleInner: React.FC<{
nodePathInfo,
windowWidth,
timelineDurationInFrames,
+ initialEdgeFrame,
+ fps,
onDragEnd,
onSelect,
selected,
@@ -1263,6 +1277,8 @@ const TimelineSequenceLeftEdgeDragHandleInner: React.FC<{
);
const {previewServerState} = useContext(StudioServerConnectionCtx);
const currentSelection = useCurrentTimelineSelectionStateAsRef();
+ const [trimTooltip, setTrimTooltip] =
+ useState<TimelineTrimTooltipState | null>(null);
const stopPointerSessionRef = useRef<(() => void) | null>(null);
const dragStateRef = useRef<{
@@ -1277,6 +1293,7 @@ const TimelineSequenceLeftEdgeDragHandleInner: React.FC<{
const latestRef = useRef({
nodePathInfo,
+ initialEdgeFrame,
setPropStatuses,
setDragOverrides,
clearDragOverrides,
@@ -1287,6 +1304,7 @@ const TimelineSequenceLeftEdgeDragHandleInner: React.FC<{
});
latestRef.current = {
nodePathInfo,
+ initialEdgeFrame,
setPropStatuses,
setDragOverrides,
clearDragOverrides,
@@ -1303,6 +1321,7 @@ const TimelineSequenceLeftEdgeDragHandleInner: React.FC<{
}
dragStateRef.current = null;
+ setTrimTooltip(null);
latestRef.current.onDragEnd(dragState.didMove);
document.body.style.userSelect = '';
document.body.style.webkitUserSelect = '';
@@ -1406,6 +1425,16 @@ const TimelineSequenceLeftEdgeDragHandleInner: React.FC<{
propStatuses: propStatusesRef.current,
}) ?? [])
: [];
+ const draggedKey = stringifySequenceSubscriptionKey(
+ latestNodePathInfo.sequenceSubscriptionKey,
+ );
+ const draggedTarget = targets.find(
+ (target) =>
+ stringifySequenceSubscriptionKey(target.nodePath) === draggedKey,
+ );
+ const handleRect = e.currentTarget.getBoundingClientRect();
+ const initialEdgeClientY = handleRect.top;
+ const initialTimelineEdge = latestRef.current.initialEdgeFrame;
stopPointerSessionRef.current?.();
dragStateRef.current = {
@@ -1468,6 +1497,26 @@ const TimelineSequenceLeftEdgeDragHandleInner: React.FC<{
Internals.makeStaticDragOverride(nextValues.trimBefore),
);
}
+
+ if (dragState.didMove && draggedTarget) {
+ const values = getTimelineSequenceLeftEdgeDragValues({
+ initialDuration: draggedTarget.initialDuration,
+ initialFrom: draggedTarget.initialFrom,
+ initialTrimBefore: draggedTarget.initialTrimBefore,
+ deltaFrames,
+ playbackRate: draggedTarget.playbackRate,
+ minimumDuration: draggedTarget.minimumDuration,
+ });
+ const appliedDelta = values.from - draggedTarget.initialFrom;
+ const edgeDelta =
+ draggedTarget.positionField === null ? 0 : appliedDelta;
+ setTrimTooltip({
+ deltaFrames: appliedDelta,
+ edgeFrame: initialTimelineEdge + edgeDelta,
+ x: pointerEvent.clientX,
+ y: initialEdgeClientY,
+ });
+ }
};
const onUp = (pointerEvent: PointerEvent) => {
@@ -1531,13 +1580,18 @@ const TimelineSequenceLeftEdgeDragHandleInner: React.FC<{
};
return (
- <div
- role="separator"
- aria-orientation="vertical"
- title="Drag to trim start"
- style={style}
- onPointerDown={onPointerDown}
- />
+ <>
+ <div
+ role="separator"
+ aria-orientation="vertical"
+ title="Drag to trim start"
+ style={style}
+ onPointerDown={onPointerDown}
+ />
+ {trimTooltip === null ? null : (
+ <TimelineTrimTooltip state={trimTooltip} fps={fps} />
+ )}
+ </>
);
};
@@ -1833,6 +1887,8 @@ const TimelineSequenceRightEdgeDragHandleInner: React.FC<{
readonly mediaDurationDragLimits: TimelineSequenceMediaDurationDragLimits | null;
readonly windowWidth: number;
readonly timelineDurationInFrames: number;
+ readonly initialEdgeFrame: number;
+ readonly fps: number;
readonly onDragEnd: (wasDragged: boolean) => void;
readonly onSelect: (interaction?: TimelineSelectionInteraction) => void;
readonly selected: boolean;
@@ -1841,6 +1897,8 @@ const TimelineSequenceRightEdgeDragHandleInner: React.FC<{
mediaDurationDragLimits,
windowWidth,
timelineDurationInFrames,
+ initialEdgeFrame,
+ fps,
onDragEnd,
onSelect,
selected,
@@ -1860,6 +1918,8 @@ const TimelineSequenceRightEdgeDragHandleInner: React.FC<{
const mediaDurationDragLimitsRegistry = useContext(
TimelineSequenceMediaDurationDragLimitsContext,
);
+ const [trimTooltip, setTrimTooltip] =
+ useState<TimelineTrimTooltipState | null>(null);
const stopPointerSessionRef = useRef<(() => void) | null>(null);
const dragStateRef = useRef<{
@@ -1876,6 +1936,7 @@ const TimelineSequenceRightEdgeDragHandleInner: React.FC<{
const latestRef = useRef({
nodePathInfo,
mediaDurationDragLimits,
+ initialEdgeFrame,
setPropStatuses,
setDragOverrides,
clearDragOverrides,
@@ -1887,6 +1948,7 @@ const TimelineSequenceRightEdgeDragHandleInner: React.FC<{
latestRef.current = {
nodePathInfo,
mediaDurationDragLimits,
+ initialEdgeFrame,
setPropStatuses,
setDragOverrides,
clearDragOverrides,
@@ -1903,6 +1965,7 @@ const TimelineSequenceRightEdgeDragHandleInner: React.FC<{
}
dragStateRef.current = null;
+ setTrimTooltip(null);
latestRef.current.onDragEnd(dragState.didMove);
document.body.style.userSelect = '';
document.body.style.webkitUserSelect = '';
@@ -2010,6 +2073,16 @@ const TimelineSequenceRightEdgeDragHandleInner: React.FC<{
timelineDurationInFrames,
}) ?? [])
: [];
+ const draggedKey = stringifySequenceSubscriptionKey(
+ latestNodePathInfo.sequenceSubscriptionKey,
+ );
+ const draggedTarget = targets.find(
+ (target) =>
+ stringifySequenceSubscriptionKey(target.nodePath) === draggedKey,
+ );
+ const handleRect = e.currentTarget.getBoundingClientRect();
+ const initialEdgeClientY = handleRect.top;
+ const initialTimelineEdge = latestRef.current.initialEdgeFrame;
stopPointerSessionRef.current?.();
dragStateRef.current = {
@@ -2058,6 +2131,22 @@ const TimelineSequenceRightEdgeDragHandleInner: React.FC<{
Internals.makeStaticDragOverride(previewValue),
);
}
+
+ if (dragState.didMove && draggedTarget) {
+ const previewValue = getTimelineSequenceDurationDragValue({
+ initialDuration: draggedTarget.initialDuration,
+ deltaFrames,
+ maximumDuration: draggedTarget.maximumDuration,
+ minimumDuration: draggedTarget.minimumDuration,
+ });
+ const appliedDelta = previewValue - draggedTarget.initialDuration;
+ setTrimTooltip({
+ deltaFrames: appliedDelta,
+ edgeFrame: initialTimelineEdge + appliedDelta,
+ x: pointerEvent.clientX,
+ y: initialEdgeClientY,
+ });
+ }
};
const onUp = (pointerEvent: PointerEvent) => {
@@ -2122,13 +2211,18 @@ const TimelineSequenceRightEdgeDragHandleInner: React.FC<{
};
return (
- <div
- role="separator"
- aria-orientation="vertical"
- title="Drag to change duration"
- style={style}
- onPointerDown={onPointerDown}
- />
+ <>
+ <div
+ role="separator"
+ aria-orientation="vertical"
+ title="Drag to change duration"
+ style={style}
+ onPointerDown={onPointerDown}
+ />
+ {trimTooltip === null ? null : (
+ <TimelineTrimTooltip state={trimTooltip} fps={fps} />
+ )}
+ </>
);
};
diff --git a/packages/studio/src/components/Timeline/TimelineTrimTooltip.tsx b/packages/studio/src/components/Timeline/TimelineTrimTooltip.tsx
new file mode 100644
index 0000000000..819433c4df
--- /dev/null
+++ b/packages/studio/src/components/Timeline/TimelineTrimTooltip.tsx
@@ -0,0 +1,65 @@
+import React, {useContext} from 'react';
+import {createPortal} from 'react-dom';
+import {BLACK_ALPHA_85, LIGHT_TEXT, WHITE} from '../../helpers/colors';
+import {renderFrame} from '../../state/render-frame';
+import {TimelineTickFormatContext} from './TimelineTickFormatProvider';
+
+export type TimelineTrimTooltipState = {
+ readonly deltaFrames: number;
+ readonly edgeFrame: number;
+ readonly x: number;
+ readonly y: number;
+};
+
+const tooltip: React.CSSProperties = {
+ backgroundColor: BLACK_ALPHA_85,
+ borderRadius: 2,
+ boxSizing: 'border-box',
+ color: WHITE,
+ fontSize: 11,
+ fontVariantNumeric: 'tabular-nums',
+ lineHeight: '14px',
+ padding: '4px 7px',
+ pointerEvents: 'none',
+ position: 'fixed',
+ textAlign: 'right',
+ whiteSpace: 'nowrap',
+ zIndex: 2147483647,
+};
+
+export const TimelineTrimTooltip: React.FC<{
+ readonly state: TimelineTrimTooltipState;
+ readonly fps: number;
+}> = ({state, fps}) => {
+ const {showFrames} = useContext(TimelineTickFormatContext);
+ const delta = Math.round(state.deltaFrames);
+ const edge = Math.max(0, Math.round(state.edgeFrame));
+ const format = (frame: number) =>
+ showFrames ? `${frame}f` : renderFrame(frame, fps);
+ const deltaLabel =
+ delta === 0
+ ? format(0)
+ : `${delta < 0 ? 'βˆ’' : '+'}${format(Math.abs(delta))}`;
+ const edgeLabel = format(edge);
+ const tooltipWidth = Math.max(
+ 82,
+ Math.ceil(Math.max(deltaLabel.length, edgeLabel.length) * 7 + 14),
+ );
+ const left = Math.max(
+ 8,
+ Math.min(state.x - tooltipWidth / 2, window.innerWidth - tooltipWidth - 8),
+ );
+ const top = Math.max(8, Math.min(state.y - 40, window.innerHeight - 44));
+
+ return createPortal(
+ <div
+ aria-hidden="true"
+ style={{...tooltip, left, top, width: tooltipWidth}}
+ data-remotion-timeline-trim-tooltip="true"
+ >
+ <div>{deltaLabel}</div>
+ <div style={{color: LIGHT_TEXT}}>{edgeLabel}</div>
+ </div>,
+ document.body,
+ );
+};