Skip to content

🎥 Make videos programmatically with React

@remotion/studio: Fix default props focus from effects

Jonny Burgerfade2504a381
diff --git a/packages/docs/docs/visual-editing.mdx b/packages/docs/docs/visual-editing.mdx
index 1dbbb312fc..ef982ed417 100644
--- a/packages/docs/docs/visual-editing.mdx
+++ b/packages/docs/docs/visual-editing.mdx
@@ -15,13 +15,7 @@ Basic controls are [inferred from the values in `defaultProps`](/docs/default-pr
## Opening the default props editor
To open the default props editor, press the <svg style={{width: 20, verticalAlign:"middle", marginLeft: 4, marginRight: 4}} viewBox="0 0 100 100" fill="transparent"><rect x="3" y="3" width="94" height="94" rx="7" stroke="var(--ifm-font-color-base)" strokeWidth="6"/><path d="M59 91.5V8.5C59 4.63401 62.134 1.5 66 1.5H92C95.866 1.5 99 4.63401 99 8.5V91.5C99 95.366 95.866 98.5 92 98.5H66C62.134 98.5 59 95.366 59 91.5Z" fill="var(--ifm-font-color-base)" stroke="var(--ifm-font-color-base)"/></svg>
-icon in the top right corner of the Remotion Studio to open the right sidebar. Alternatively, press <kbd>Cmd/Ctrl</kbd> + <kbd>J</kbd> to toggle the sidebar. The composition's default props are in the Default Props section.
-
-## Inspector sections<AvailableFrom v="4.0.526" />
-
-Click a section title, such as Metadata, Default Props, or Actions, to collapse or expand its contents. You can also focus the title with <kbd>Tab</kbd> and press <kbd>Enter</kbd> or <kbd>Space</kbd>. Collapsing Default Props preserves the editor mode and unfinished JSON.
-
-Empty sections, such as Effects without any effects, are not collapsible. Header actions remain separate from the title: adding an effect or importing captions opens the corresponding section.
+icon in the top right corner of the Remotion Studio to open the right sidebar. Alternatively, press <kbd>Cmd/Ctrl</kbd> + <kbd>J</kbd> to toggle the sidebar. Select the <code>Props</code> tab.
## Editing default props
diff --git a/packages/example/e2e/captions-inspector.test.mts b/packages/example/e2e/captions-inspector.test.mts
index 6856c3320d..3d8ec84070 100644
--- a/packages/example/e2e/captions-inspector.test.mts
+++ b/packages/example/e2e/captions-inspector.test.mts
@@ -149,12 +149,6 @@ test.describe('captions inspector', () => {
sourceBeforeFailedImport,
);
- await page
- .getByRole('button', {name: 'Collapse Captions', exact: true})
- .click();
- await expect(defaultCaption).toBeHidden();
- await expect(importCaptionsButton).toBeVisible();
-
await importCaptionsInput.setInputFiles({
name: 'captions.json',
mimeType: 'application/json',
@@ -226,10 +220,6 @@ test.describe('captions inspector', () => {
await expect(importCaptionsButton).toBeVisible({timeout: 1_000});
}).toPass({timeout: 30_000});
- await expect(page.getByText('No captions', {exact: true})).toBeVisible();
- await expect(
- page.getByRole('button', {name: /^(Collapse|Expand) Captions$/}),
- ).toHaveCount(0);
await page.getByLabel('Import captions file').setInputFiles({
name: 'captions.json',
mimeType: 'application/json',
diff --git a/packages/example/e2e/inspector-control-layout.test.mts b/packages/example/e2e/inspector-control-layout.test.mts
index 9c9f2f2a46..e43f273c08 100644
--- a/packages/example/e2e/inspector-control-layout.test.mts
+++ b/packages/example/e2e/inspector-control-layout.test.mts
@@ -65,7 +65,6 @@ test.describe('Inspector control layout', () => {
});
test('keeps inspector controls aligned', async ({page}) => {
- test.setTimeout(90_000);
await page.goto(`${STUDIO_URL}/inspector-control-layout-e2e`);
await expect(page).toHaveURL(/inspector-control-layout-e2e/, {
timeout: 15_000,
@@ -108,15 +107,6 @@ test.describe('Inspector control layout', () => {
expect(
Math.abs(sourceActionBox.x - duplicateActionBox.x),
).toBeLessThanOrEqual(1);
- await page
- .getByRole('button', {name: 'Collapse Actions', exact: true})
- .click();
- await expect(duplicateAction).toBeHidden();
- await expect(sourceAction).toBeVisible();
- await page
- .getByRole('button', {name: 'Expand Actions', exact: true})
- .press('Enter');
- await expect(duplicateAction).toBeVisible();
await expectInspectorControlsToUseAvailableWidth(
origin,
@@ -182,23 +172,5 @@ test.describe('Inspector control layout', () => {
expect(
computedFontFamilyBox.y + computedFontFamilyBox.height,
).toBeLessThanOrEqual(fontSizeBox.y);
-
- await page.goto(`${STUDIO_URL}/assets/framer.webm`);
- await page
- .getByRole('button', {name: 'Collapse File', exact: true})
- .click();
- await expect(page.getByText('Size', {exact: true})).toBeHidden();
- await page
- .getByRole('button', {name: 'Expand File', exact: true})
- .press('Enter');
- await expect(page.getByText('Size', {exact: true})).toBeVisible();
- await page
- .getByRole('button', {name: 'Collapse Video', exact: true})
- .click();
- await expect(page.getByText('Frame rate', {exact: true})).toBeHidden();
- await page
- .getByRole('button', {name: 'Expand Video', exact: true})
- .press('Space');
- await expect(page.getByText('Frame rate', {exact: true})).toBeVisible();
});
});
diff --git a/packages/example/e2e/json-editor.test.mts b/packages/example/e2e/json-editor.test.mts
index c8d4b2197e..25c2bc9b3e 100644
--- a/packages/example/e2e/json-editor.test.mts
+++ b/packages/example/e2e/json-editor.test.mts
@@ -21,42 +21,6 @@ test.describe('visual mode', () => {
test.setTimeout(90_000);
await navigateToSchemaTest(page);
- const collapseMetadata = page.getByRole('button', {
- name: 'Collapse Metadata',
- exact: true,
- });
- await page.mouse.move(0, 0);
- await expect(collapseMetadata).toHaveCSS('cursor', 'default');
- await expect(collapseMetadata).toHaveCSS('color', 'rgb(166, 167, 169)');
- await collapseMetadata.hover();
- await expect(collapseMetadata).toHaveCSS('cursor', 'default');
- await expect(collapseMetadata).toHaveCSS('color', 'rgb(255, 255, 255)');
- await collapseMetadata.click();
- const expandMetadata = page.getByRole('button', {
- name: 'Expand Metadata',
- exact: true,
- });
- await expect(expandMetadata).toBeFocused();
- await expect(expandMetadata).toHaveCSS('box-shadow', 'none');
- await expect(page.getByText('Frame rate', {exact: true})).toBeHidden();
- await page.reload();
- await expect(expandMetadata).toBeVisible();
- await expandMetadata.click();
- await expect(page.getByText('Frame rate', {exact: true})).toBeVisible();
-
- await page
- .getByRole('button', {name: 'Collapse Actions', exact: true})
- .click();
- await expect(
- page.getByRole('button', {name: 'Add Solid', exact: true}),
- ).toBeHidden();
- await page
- .getByRole('button', {name: 'Expand Actions', exact: true})
- .press('Enter');
- await expect(
- page.getByRole('button', {name: 'Add Solid', exact: true}),
- ).toBeVisible();
-
const jsonTab = page.getByRole('button', {name: 'JSON', exact: true});
await expect(jsonTab).toBeVisible({timeout: 10_000});
await jsonTab.click();
@@ -95,24 +59,6 @@ test.describe('visual mode', () => {
await expect(errorDiv).not.toBeEmpty({timeout: 5_000});
await textarea.blur();
- await page
- .getByRole('button', {name: 'Collapse Default Props', exact: true})
- .click();
- await expect(textarea).toBeHidden();
- await expect(jsonTab).toBeHidden();
- const expandDefaultProps = page.getByRole('button', {
- name: 'Expand Default Props',
- exact: true,
- });
- await page.keyboard.press('Tab');
- await page.keyboard.press('Shift+Tab');
- await expect(expandDefaultProps).toBeFocused();
- await expect(expandDefaultProps).not.toHaveCSS('box-shadow', 'none');
- await expandDefaultProps.press('Space');
- await expect(textarea).toBeVisible();
- await expect(textarea).toHaveValue('{invalid json');
- await expect(errorDiv).not.toBeEmpty();
-
await expect
.poll(
() => fs.readFileSync(rootFile, 'utf-8') === contentAfterValidEdit,
diff --git a/packages/example/e2e/multi-sequence-inspector.test.mts b/packages/example/e2e/multi-sequence-inspector.test.mts
index 5ac5435d3e..8357e298ce 100644
--- a/packages/example/e2e/multi-sequence-inspector.test.mts
+++ b/packages/example/e2e/multi-sequence-inspector.test.mts
@@ -36,15 +36,6 @@ test('edits shared controls and preserves relative translations in a single undo
});
const sourceBefore = fs.readFileSync(visualMode3DFile, 'utf-8');
const x = page.getByRole('button', {name: 'Offset X', exact: true});
- await page
- .getByRole('button', {name: 'Collapse Transform', exact: true})
- .click();
- await expect(x).toBeHidden();
- await page
- .getByRole('button', {name: 'Expand Transform', exact: true})
- .press('Space');
- await expect(x).toHaveText('Mixed');
- await expect(x).toBeVisible();
await x.click();
const input = page.getByRole('textbox', {name: 'Offset X', exact: true});
await input.fill('99');
diff --git a/packages/example/e2e/studio.test.mts b/packages/example/e2e/studio.test.mts
index dd1a5a25cd..bfa245e3bd 100644
--- a/packages/example/e2e/studio.test.mts
+++ b/packages/example/e2e/studio.test.mts
@@ -839,9 +839,6 @@ test.describe('visual mode', () => {
});
const timelinePhase = page.getByText('Phase', {exact: true});
await expect(timelinePhase).toHaveCount(1);
- await inspector
- .getByRole('button', {name: 'Collapse Effects', exact: true})
- .click();
await inspector.evaluate((element) => {
element.scrollTop = 0;
});
@@ -855,90 +852,38 @@ test.describe('visual mode', () => {
).toBeVisible();
});
- test('collapses populated Effects and opens them when adding an effect', async ({
+ test('should keep Effects expanded and preserve the inspector scroll position when adding an effect', async ({
page,
}) => {
await page.goto(`${STUDIO_URL}/effect-keyframe-e2e`);
await expect(page).toHaveURL(/effect-keyframe-e2e/, {timeout: 15_000});
const addEffectButton = page.getByTitle('Add effect', {exact: true});
- const inspector = page
- .locator('.__remotion-vertical-scrollbar')
- .filter({has: addEffectButton});
- const effectPicker = page.getByRole('dialog');
if (!(await page.getByRole('button', {name: 'Inspector'}).isVisible())) {
await page.locator('[data-sidebar-toggle="right"]').click();
}
- await expect(async () => {
- await page
- .getByTitle('Timeline expansion', {exact: true})
- .first()
- .click();
- await expect(addEffectButton).toBeVisible({timeout: 1000});
- }).toPass({timeout: 15_000});
- await expect(page.getByText('Effects', {exact: true})).toBeVisible();
- await expect(
- page.getByRole('button', {name: /^(Collapse|Expand) Effects$/}),
- ).toHaveCount(0);
-
- // Adding the first effect must also work after undoing a collapsed one.
- for (let i = 0; i < 2; i++) {
- await addEffectButton.click();
- await effectPicker.getByPlaceholder('Search effects...').fill('blur');
- await effectPicker.getByText('blur()', {exact: true}).click();
- await expect(inspector.getByText('blur()', {exact: true})).toBeVisible();
- await page
- .getByRole('button', {name: 'Collapse Effects', exact: true})
- .click();
- await expect(page.getByRole('button', {name: /^Undo/})).toBeEnabled();
- await page.keyboard.press('ControlOrMeta+z');
- await expect(
- page.getByRole('button', {name: /^(Collapse|Expand) Effects$/}),
- ).toHaveCount(0);
- await expect(inspector.getByText('Effects', {exact: true})).toBeVisible();
- }
-
await expect(async () => {
await page.getByTitle('Scale precision', {exact: true}).first().click();
await expect(addEffectButton).toBeVisible({timeout: 1000});
}).toPass({timeout: 15_000});
await expect(page.getByText('wave()', {exact: true})).toBeVisible();
- await page
- .getByRole('button', {name: 'Collapse Effects', exact: true})
- .click();
- await expect(page.getByText('wave()', {exact: true})).toBeHidden();
- await expect(addEffectButton).toBeVisible();
- await page
- .getByRole('button', {name: 'Expand Effects', exact: true})
- .press('Enter');
- await expect(page.getByText('wave()', {exact: true})).toBeVisible();
- await page
- .locator('[data-timeline-marquee-item][title="Scale precision"]')
- .click();
await expect(
page.getByRole('button', {name: 'Collapse Effects', exact: true}),
- ).not.toBeFocused();
- await page.keyboard.press('Enter');
- const sequenceName = page.getByRole('textbox');
- await expect(sequenceName).toHaveValue('Scale precision');
- await sequenceName.press('Escape');
- await page
- .locator('[data-timeline-marquee-item][title="Scale precision"]')
- .click();
- await page
- .getByRole('button', {name: 'Collapse Effects', exact: true})
- .click();
+ ).toHaveCount(0);
+ const inspector = page
+ .locator('.__remotion-vertical-scrollbar')
+ .filter({has: addEffectButton});
await expect(inspector).toHaveCount(1);
await inspector.evaluate((element) => {
element.scrollTop = element.scrollHeight;
});
await addEffectButton.click();
- await expect(inspector.getByText('wave()', {exact: true})).toBeVisible();
const scrollTopBefore = await inspector.evaluate(
(element) => element.scrollTop,
);
expect(scrollTopBefore).toBeGreaterThan(0);
+ const effectPicker = page.getByRole('dialog');
await effectPicker.getByPlaceholder('Search effects...').fill('blur');
await effectPicker.getByText('blur()', {exact: true}).click();
diff --git a/packages/example/e2e/visual-controls.test.mts b/packages/example/e2e/visual-controls.test.mts
index 364e29378e..0142322137 100644
--- a/packages/example/e2e/visual-controls.test.mts
+++ b/packages/example/e2e/visual-controls.test.mts
@@ -25,14 +25,6 @@ test.describe('visual controls', () => {
.locator('[data-json-path="rotation"]')
.locator('..');
await expect(rotationFieldset).toBeVisible({timeout: 10_000});
- await page
- .getByRole('button', {name: 'Collapse Visual Controls', exact: true})
- .click();
- await expect(rotationFieldset).toBeHidden();
- await page
- .getByRole('button', {name: 'Expand Visual Controls', exact: true})
- .press('Enter');
- await expect(rotationFieldset).toBeVisible();
const rotationDragger = rotationFieldset.locator(
'button.__remotion_input_dragger',
diff --git a/packages/studio/src/api/focus-default-props-path.ts b/packages/studio/src/api/focus-default-props-path.ts
index 898d1e9733..cf046efc67 100644
--- a/packages/studio/src/api/focus-default-props-path.ts
+++ b/packages/studio/src/api/focus-default-props-path.ts
@@ -1,4 +1,3 @@
-import {flushSync} from 'react-dom';
import {
DEFAULT_PROPS_PATH_ACTIVE_CLASSNAME,
DEFAULT_PROPS_PATH_CLASSNAME,
@@ -29,8 +28,13 @@ export const focusDefaultPropsPath = ({
};
}
- flushSync(() => expandDefaultPropsEditorRef.current?.());
- query.scrollIntoView({behavior: scrollBehavior});
+ const scrollToField = () => query.scrollIntoView({behavior: scrollBehavior});
+ if (expandDefaultPropsEditorRef.current === null) {
+ scrollToField();
+ } else {
+ expandDefaultPropsEditorRef.current(scrollToField);
+ }
+
query.classList.add(DEFAULT_PROPS_PATH_ACTIVE_CLASSNAME);
return {
success: true,
diff --git a/packages/studio/src/components/InspectorPanel/CompositionInspector.tsx b/packages/studio/src/components/InspectorPanel/CompositionInspector.tsx
index 1e2989abec..95189a7a22 100644
--- a/packages/studio/src/components/InspectorPanel/CompositionInspector.tsx
+++ b/packages/studio/src/components/InspectorPanel/CompositionInspector.tsx
@@ -3,7 +3,9 @@ import React, {
useContext,
useEffect,
useImperativeHandle,
+ useLayoutEffect,
useMemo,
+ useRef,
useState,
} from 'react';
import type {_InternalTypes} from 'remotion';
@@ -227,11 +229,27 @@ const CompositionDefaultPropsSection: React.FC<{
const [expanded, setExpanded] = useInspectorSectionExpanded(
'composition-default-props',
);
+ const pendingScroll = useRef<(() => void) | null>(null);
useImperativeHandle(
expandDefaultPropsEditorRef,
- () => () => setExpanded(true),
- [setExpanded],
+ () => (onExpanded) => {
+ if (expanded) {
+ onExpanded();
+ return;
+ }
+
+ pendingScroll.current = onExpanded;
+ setExpanded(true);
+ },
+ [expanded, setExpanded],
);
+ useLayoutEffect(() => {
+ if (expanded && pendingScroll.current !== null) {
+ const scroll = pendingScroll.current;
+ pendingScroll.current = null;
+ scroll();
+ }
+ }, [expanded]);
const compositionId = composition.id;
useEffect(() => {
diff --git a/packages/studio/src/components/RenderModal/SchemaEditor/scroll-to-default-props-path.ts b/packages/studio/src/components/RenderModal/SchemaEditor/scroll-to-default-props-path.ts
index e3f8b906d1..286d5278eb 100644
--- a/packages/studio/src/components/RenderModal/SchemaEditor/scroll-to-default-props-path.ts
+++ b/packages/studio/src/components/RenderModal/SchemaEditor/scroll-to-default-props-path.ts
@@ -8,4 +8,5 @@ export const DEFAULT_PROPS_PATH_ACTIVE_CLASSNAME =
export const defaultPropsEditorScrollableAreaRef =
React.createRef<HTMLDivElement>();
-export const expandDefaultPropsEditorRef = React.createRef<() => void>();
+export const expandDefaultPropsEditorRef =
+ React.createRef<(onExpanded: () => void) => void>();
diff --git a/packages/studio/src/components/Timeline/TimelineHeightContainer.tsx b/packages/studio/src/components/Timeline/TimelineHeightContainer.tsx
index 98da7e294b..9debfd4662 100644
--- a/packages/studio/src/components/Timeline/TimelineHeightContainer.tsx
+++ b/packages/studio/src/components/Timeline/TimelineHeightContainer.tsx
@@ -1,4 +1,4 @@
-import React, {useMemo} from 'react';
+import React, {useCallback, useMemo} from 'react';
import {TIMELINE_BACKGROUND} from './TimelineSelection';
import {useTimelineVirtualization} from './TimelineVirtualization';
@@ -15,27 +15,29 @@ const TimelineHeightContainerInner: React.FC<{
}> = ({children}) => {
const {totalSize} = useTimelineVirtualization();
+ const onPointerDownCapture = useCallback(
+ (event: React.PointerEvent<HTMLDivElement>) => {
+ const {activeElement} = document;
+ if (
+ event.button === 0 &&
+ activeElement instanceof HTMLButtonElement &&
+ event.target instanceof Node &&
+ !activeElement.contains(event.target)
+ ) {
+ // Timeline drags can prevent the browser's default focus change.
+ activeElement.blur();
+ }
+ },
+ [],
+ );
+
const style = useMemo<React.CSSProperties>(
() => ({...baseStyle, height: totalSize}),
[totalSize],
);
return (
- <div
- style={style}
- onPointerDownCapture={(event) => {
- const {activeElement} = document;
- if (
- event.button === 0 &&
- activeElement instanceof HTMLButtonElement &&
- event.target instanceof Node &&
- !activeElement.contains(event.target)
- ) {
- // Timeline drags can prevent the browser's default focus change.
- activeElement.blur();
- }
- }}
- >
+ <div style={style} onPointerDownCapture={onPointerDownCapture}>
{children}
</div>
);