Skip to content

Write HTML. Render video. Built for agents.

fix(studio): the host can name the Split key shown in the clip menu (#4985)

Miguel Ángeldda0e757b11c
diff --git a/packages/studio/src/components/EditorShell.tsx b/packages/studio/src/components/EditorShell.tsx
index 36ddab8e83..c312569550 100644
--- a/packages/studio/src/components/EditorShell.tsx
+++ b/packages/studio/src/components/EditorShell.tsx
@@ -59,6 +59,7 @@ export interface EditorShellProps extends TimelineEditCallbackDeps {
onDuplicateClip: () => Promise<boolean>;
canPasteClip: () => boolean;
clipMenuItems?: TimelineProps["clipMenuItems"];
+ splitShortcut?: TimelineProps["splitShortcut"];
setCompIdToSrc: (map: Map<string, string>) => void;
setCompositionLoading: (loading: boolean) => void;
shouldShowMotionPath: boolean;
@@ -111,6 +112,7 @@ export const EditorShell = memo(function EditorShell({
onDuplicateClip,
canPasteClip,
clipMenuItems,
+ splitShortcut,
setCompIdToSrc,
setCompositionLoading,
shouldShowMotionPath,
@@ -211,6 +213,7 @@ export const EditorShell = memo(function EditorShell({
onDuplicateClip={onDuplicateClip}
canPasteClip={canPasteClip}
clipMenuItems={clipMenuItems}
+ splitShortcut={splitShortcut}
previewOverlay={
<PreviewOverlays
shouldShowMotionPath={shouldShowMotionPath}
@@ -255,6 +258,7 @@ interface EditorShellBodyProps {
onDuplicateClip: () => Promise<boolean>;
canPasteClip: () => boolean;
clipMenuItems?: TimelineProps["clipMenuItems"];
+ splitShortcut?: TimelineProps["splitShortcut"];
}
function EditorShellBody({
@@ -276,6 +280,7 @@ function EditorShellBody({
onDuplicateClip,
canPasteClip,
clipMenuItems,
+ splitShortcut,
}: EditorShellBodyProps) {
const { compositionStack, updateCompositionStack, containerRef } = useNLEContext();
@@ -329,6 +334,7 @@ function EditorShellBody({
onDuplicateClip={onDuplicateClip}
canPasteClip={canPasteClip}
clipMenuItems={clipMenuItems}
+ splitShortcut={splitShortcut}
onSelectTimelineElement={onSelectTimelineElement}
timelineFooter={
captionEditMode ? (
diff --git a/packages/studio/src/components/nle/TimelinePane.tsx b/packages/studio/src/components/nle/TimelinePane.tsx
index 56f2515a04..37bc32c796 100644
--- a/packages/studio/src/components/nle/TimelinePane.tsx
+++ b/packages/studio/src/components/nle/TimelinePane.tsx
@@ -47,6 +47,7 @@ export interface TimelinePaneProps {
onDuplicateClip?: () => Promise<boolean>;
canPasteClip?: () => boolean;
clipMenuItems?: TimelineProps["clipMenuItems"];
+ splitShortcut?: TimelineProps["splitShortcut"];
}
export function TimelinePane({
@@ -67,6 +68,7 @@ export function TimelinePane({
onDuplicateClip,
canPasteClip,
clipMenuItems,
+ splitShortcut,
}: TimelinePaneProps) {
const {
seek,
@@ -123,6 +125,7 @@ export function TimelinePane({
onDuplicateClip={onDuplicateClip}
canPasteClip={canPasteClip}
clipMenuItems={clipMenuItems}
+ splitShortcut={splitShortcut}
/>
</div>
<AudioMeterStrip />
diff --git a/packages/studio/src/player/components/ClipContextMenu.test.tsx b/packages/studio/src/player/components/ClipContextMenu.test.tsx
index fcbcb13853..b6e56f972c 100644
--- a/packages/studio/src/player/components/ClipContextMenu.test.tsx
+++ b/packages/studio/src/player/components/ClipContextMenu.test.tsx
@@ -160,6 +160,37 @@ describe("ClipContextMenu tools", () => {
return { labels, unmount: () => act(() => root.unmount()) };
}
+ function splitRow(splitShortcut?: string) {
+ const host = document.body.appendChild(document.createElement("div"));
+ const root = createRoot(host);
+ act(() =>
+ root.render(
+ <ClipContextMenu
+ x={10}
+ y={10}
+ element={video}
+ currentTime={1}
+ onClose={vi.fn()}
+ onSplit={vi.fn()}
+ onDelete={vi.fn()}
+ splitShortcut={splitShortcut}
+ />,
+ ),
+ );
+ const row = Array.from(document.body.querySelectorAll("[role=menuitem]")).find((item) =>
+ item.textContent?.startsWith("Split"),
+ );
+ const text = row?.textContent;
+ act(() => root.unmount());
+ host.remove();
+ return text;
+ }
+
+ it("hints Split with Studio's own S, or with the key the host binds Split to", () => {
+ expect(splitRow()).toBe("Split at 1.00sS");
+ expect(splitRow("⌥S")).toBe("Split at 1.00s⌥S");
+ });
+
it("offers Freeze frame and the attribute tools by default", () => {
const { labels, unmount } = menuWith(undefined);
expect(labels().some((label) => label?.startsWith("Freeze frame"))).toBe(true);
diff --git a/packages/studio/src/player/components/ClipContextMenu.tsx b/packages/studio/src/player/components/ClipContextMenu.tsx
index 365b7c91f3..ebf0d544ca 100644
--- a/packages/studio/src/player/components/ClipContextMenu.tsx
+++ b/packages/studio/src/player/components/ClipContextMenu.tsx
@@ -10,6 +10,7 @@ import { ClipMenuAudioItems } from "./clipMenuAudioItems";
import { ClipMenuLinkItems } from "./clipMenuLinkItems";
import { menuClasses } from "../../components/ui/menuStyle";
import { useTimelineEditContextOptional } from "../../contexts/TimelineEditContext";
+import { SPLIT_SHORTCUT_HINT } from "./studioShortcuts";
const MENU_MARGIN = 8;
@@ -40,6 +41,7 @@ interface ClipContextMenuProps {
onDuplicate?: () => Promise<boolean>;
canPaste?: boolean;
hostItems?: readonly TimelineClipMenuItem[] | undefined;
+ splitShortcut?: string | undefined;
}
const itemClass = (enabled: boolean) =>
@@ -95,6 +97,7 @@ export const ClipContextMenu = memo(function ClipContextMenu({
onDuplicate,
canPaste,
hostItems = [],
+ splitShortcut = SPLIT_SHORTCUT_HINT,
}: ClipContextMenuProps) {
const menuRef = useContextMenuDismiss(onClose);
useMenuKeyboardNav(menuRef);
@@ -157,7 +160,7 @@ export const ClipContextMenu = memo(function ClipContextMenu({
}}
>
<span>{splitLabel}</span>
- <span className="text-neutral-500 text-[10px] ml-3">S</span>
+ <span className="text-neutral-500 text-[10px] ml-3">{splitShortcut}</span>
</button>
)}
{tools && splitLabel && (
diff --git a/packages/studio/src/player/components/TimelineOverlays.test.ts b/packages/studio/src/player/components/TimelineOverlays.test.ts
index 3fc2c94554..884f5a3c3e 100644
--- a/packages/studio/src/player/components/TimelineOverlays.test.ts
+++ b/packages/studio/src/player/components/TimelineOverlays.test.ts
@@ -216,4 +216,22 @@ describe("TimelineOverlays context lifecycle", () => {
expect(clipMenuItems).toHaveBeenCalledExactlyOnceWith(current);
expect(document.body.querySelector('[role="menuitem"]')?.textContent).toBe("Ask");
});
+
+ it("hints Split in the clip menu with the host's key", () => {
+ const video = { ...captured, domId: "child", tag: "video" };
+ renderOverlay({
+ capturedElement: video,
+ currentElement: video,
+ overlays: {
+ kfContextMenu: null,
+ clipContextMenu: { x: 10, y: 10, sessionEpoch: 2, element: video },
+ currentTime: 2,
+ splitShortcut: "⌥S",
+ },
+ });
+ const rows = [...document.body.querySelectorAll('[role="menuitem"]')].map(
+ (row) => row.textContent,
+ );
+ expect(rows).toContain("Split at 2.00s⌥S");
+ });
});
diff --git a/packages/studio/src/player/components/TimelineOverlays.tsx b/packages/studio/src/player/components/TimelineOverlays.tsx
index 97fa10d70c..a7c039536d 100644
--- a/packages/studio/src/player/components/TimelineOverlays.tsx
+++ b/packages/studio/src/player/components/TimelineOverlays.tsx
@@ -190,6 +190,7 @@ export function TimelineClipMenuOverlay() {
onDuplicate={overlay.onDuplicateClip}
canPaste={overlay.canPasteClip?.() ?? false}
hostItems={hostItems}
+ splitShortcut={overlay.splitShortcut}
/>
);
}
diff --git a/packages/studio/src/player/components/TimelineProvider.tsx b/packages/studio/src/player/components/TimelineProvider.tsx
index d599e2a9eb..afb6c9ea9a 100644
--- a/packages/studio/src/player/components/TimelineProvider.tsx
+++ b/packages/studio/src/player/components/TimelineProvider.tsx
@@ -112,6 +112,7 @@ export interface TimelineOverlaysState {
onDuplicateClip?: () => Promise<boolean>;
canPasteClip?: () => boolean;
clipMenuItems?: TimelineProps["clipMenuItems"];
+ splitShortcut?: TimelineProps["splitShortcut"];
gapContextMenu: TrackGapContextMenuState | null;
onDismissGapContextMenu: () => void;
onCloseTrackGap: () => void;
diff --git a/packages/studio/src/player/components/TimelineTypes.ts b/packages/studio/src/player/components/TimelineTypes.ts
index 439f9baf28..de2a70cefd 100644
--- a/packages/studio/src/player/components/TimelineTypes.ts
+++ b/packages/studio/src/player/components/TimelineTypes.ts
@@ -43,6 +43,7 @@ export interface TimelineProps
onDuplicateClip?: () => Promise<boolean>;
canPasteClip?: () => boolean;
clipMenuItems?: (element: TimelineElement) => readonly TimelineClipMenuItem[];
+ splitShortcut?: string;
theme?: Partial<TimelineTheme>;
showAudioEffects?: boolean;
showKeyframes?: boolean;
diff --git a/packages/studio/src/player/components/studioShortcuts.ts b/packages/studio/src/player/components/studioShortcuts.ts
index ea8216c0cb..cf46c724c3 100644
--- a/packages/studio/src/player/components/studioShortcuts.ts
+++ b/packages/studio/src/player/components/studioShortcuts.ts
@@ -19,6 +19,8 @@ export interface ShortcutSection {
const hintKey = (key: string) => key.toUpperCase();
+export const SPLIT_SHORTCUT_HINT = hintKey(STUDIO_PLAIN_KEYS.split);
+
/** What PlayerControls' shortcuts panel lists unless an embedder passes its own sections. */
export const DEFAULT_SHORTCUT_SECTIONS: readonly ShortcutSection[] = [
{
@@ -51,7 +53,7 @@ export const DEFAULT_SHORTCUT_SECTIONS: readonly ShortcutSection[] = [
{ key: "⌘C", label: "Copy element" },
{ key: "⌘V", label: "Paste element" },
{ key: "⌘X", label: "Cut element" },
- { key: hintKey(STUDIO_PLAIN_KEYS.split), label: "Split clip at playhead" },
+ { key: SPLIT_SHORTCUT_HINT, label: "Split clip at playhead" },
{ key: hintKey(STUDIO_PLAIN_KEYS.audioGain), label: "Audio Gain for clips with sound" },
{ key: "⇧Click", label: "Razor tool: split all tracks" },
{ key: "[", label: "Select clips starting before the playhead" },
diff --git a/packages/studio/src/player/components/useTimelineProviderState.tsx b/packages/studio/src/player/components/useTimelineProviderState.tsx
index 4843eef65e..954a30df8b 100644
--- a/packages/studio/src/player/components/useTimelineProviderState.tsx
+++ b/packages/studio/src/player/components/useTimelineProviderState.tsx
@@ -72,6 +72,7 @@ export function useTimelineProviderState({
onDuplicateClip,
canPasteClip,
clipMenuItems,
+ splitShortcut,
theme: themeOverrides,
showAudioEffects = true,
showKeyframes = true,
@@ -387,6 +388,7 @@ export function useTimelineProviderState({
onDuplicateClip,
canPasteClip,
clipMenuItems,
+ splitShortcut,
onSelectElement,
selectedElementId,
setRangeSelectionRef,