Skip to content

🎥 Make videos programmatically with React

`@remotion/studio`: Add folder selection when creating compositions

Jonny Burger07e8a7df261a
diff --git a/packages/example/e2e/studio.test.mts b/packages/example/e2e/studio.test.mts
index 1f00dde721..267d29e02d 100644
--- a/packages/example/e2e/studio.test.mts
+++ b/packages/example/e2e/studio.test.mts
@@ -322,6 +322,7 @@ test.describe('visual mode', () => {
await expect(missingComposition).toBeVisible();
expect(await dropFile({...file, target: missingComposition})).toBe(true);
await expect(modalTitle).toBeVisible();
+ await expect(page.getByTitle('Folder')).toHaveText('Root');
await page.keyboard.press('Escape');
await page.getByText('Assets', {exact: true}).click();
@@ -1091,6 +1092,7 @@ test.describe('visual mode', () => {
test('should navigate to a newly created composition', async ({page}) => {
const compositionId = 'NewlyCreatedComposition';
+ const rootFile = path.join(exampleDir, 'src', 'E2eTestRoot.tsx');
const compositionFile = path.join(
exampleDir,
'src',
@@ -1108,6 +1110,12 @@ test.describe('visual mode', () => {
await page
.getByRole('textbox', {name: 'Composition ID'})
.fill(compositionId);
+ await page.getByTitle('Folder').click();
+ await page
+ .getByRole('button', {name: 'Schema', exact: true})
+ .last()
+ .click();
+ await expect(page.getByTitle('Folder')).toHaveText('Schema');
const createButton = page.getByRole('button', {
name: /Add to .*/,
@@ -1121,9 +1129,19 @@ test.describe('visual mode', () => {
await expect(page).toHaveTitle(new RegExp(compositionId), {
timeout: 5_000,
});
+ const rootContents = fs.readFileSync(rootFile, 'utf8');
+ const folderStart = rootContents.indexOf('<Folder name="Schema">');
+ const folderEnd = rootContents.indexOf('</Folder>', folderStart);
+ if (folderStart === -1 || folderEnd === -1) {
+ throw new Error('Could not find the Schema folder in the root file');
+ }
+
+ const compositionPosition = rootContents.indexOf(`id="${compositionId}"`);
+ expect(compositionPosition).toBeGreaterThan(folderStart);
+ expect(compositionPosition).toBeLessThan(folderEnd);
} finally {
const undoButton = page.getByRole('button', {name: /^Undo/});
- if (await undoButton.isEnabled()) {
+ if ((await undoButton.count()) > 0 && (await undoButton.isEnabled())) {
await undoButton.click();
await expect.poll(() => fs.existsSync(compositionFile)).toBe(false);
}
diff --git a/packages/studio/src/components/NewComposition/NewComposition.tsx b/packages/studio/src/components/NewComposition/NewComposition.tsx
index 7ae0dec545..ffc04d770b 100644
--- a/packages/studio/src/components/NewComposition/NewComposition.tsx
+++ b/packages/studio/src/components/NewComposition/NewComposition.tsx
@@ -3,23 +3,28 @@ import React, {
useCallback,
useContext,
useEffect,
+ useMemo,
useRef,
useState,
} from 'react';
import {Internals} from 'remotion';
import {getStaticFiles} from '../../api/get-static-files';
import {writeStaticFile} from '../../api/write-static-file';
+import {getFolderId} from '../../helpers/get-folder-id';
import {installRequiredPackages} from '../../helpers/install-required-package';
import {
getUniqueCompositionName,
useCreateComposition,
} from '../../helpers/use-create-composition';
+import {Checkmark} from '../../icons/Checkmark';
import type {CanvasCaptureImport} from '../../state/modals';
import {Spacing} from '../layout';
import {ModalFooterContainer} from '../ModalFooter';
import {ModalHeader} from '../ModalHeader';
import {label, optionRow, rightRow} from '../RenderModal/layout';
import {CodemodFooter} from './CodemodFooter';
+import type {ComboboxValue} from './ComboBox';
+import {Combobox} from './ComboBox';
import {DismissableModal} from './DismissableModal';
import {getNewCompositionDefaults} from './get-new-composition-defaults';
import {InputAndValidationContainer} from './InputAndValidationContainer';
@@ -36,17 +41,88 @@ const content: React.CSSProperties = {
minWidth: 500,
};
-const folderPathStyle: React.CSSProperties = {
- fontSize: 14,
+const folderSelectStyle: React.CSSProperties = {
+ boxSizing: 'border-box',
+ width: 250,
};
+const rootFolderId = 'new-composition-root-folder';
+const folderSelectIdPrefix = 'new-composition-folder-';
+
const NewCompositionLoaded: React.FC<{
readonly folderName: string | null;
readonly parentName: string | null;
readonly stack: string | null;
readonly canvasCapture: CanvasCaptureImport | null;
}> = ({canvasCapture, folderName, parentName, stack}) => {
- const {compositions} = useContext(Internals.CompositionManager);
+ const {compositions, folders} = useContext(Internals.CompositionManager);
+ const [selectedFolder, setSelectedFolder] = useState(() => ({
+ folderName,
+ parentName,
+ stack,
+ }));
+ const selectedFolderId = selectedFolder.folderName
+ ? `${folderSelectIdPrefix}${getFolderId({
+ folderName: selectedFolder.folderName,
+ parentName: selectedFolder.parentName,
+ })}`
+ : rootFolderId;
+ const folderValues = useMemo((): ComboboxValue[] => {
+ return [
+ {
+ id: rootFolderId,
+ keyHint: null,
+ label: 'Root',
+ leftItem: selectedFolder.folderName === null ? <Checkmark /> : null,
+ onClick: () => {
+ setSelectedFolder({
+ folderName: null,
+ parentName: null,
+ stack: null,
+ });
+ },
+ quickSwitcherLabel: null,
+ subMenu: null,
+ type: 'item',
+ value: rootFolderId,
+ },
+ ...folders
+ .slice()
+ .sort((a, b) => {
+ return getFolderId({
+ folderName: a.name,
+ parentName: a.parent,
+ }).localeCompare(
+ getFolderId({folderName: b.name, parentName: b.parent}),
+ );
+ })
+ .map((folder): ComboboxValue => {
+ const folderPath = getFolderId({
+ folderName: folder.name,
+ parentName: folder.parent,
+ });
+ const id = `${folderSelectIdPrefix}${folderPath}`;
+ return {
+ id,
+ keyHint: null,
+ label: folderPath,
+ leftItem: selectedFolderId === id ? <Checkmark /> : null,
+ onClick: () => {
+ setSelectedFolder({
+ folderName: folder.name,
+ parentName: folder.parent,
+ stack: folder.stack,
+ });
+ },
+ quickSwitcherLabel: null,
+ subMenu: null,
+ type: 'item',
+ value: id,
+ disabled: folder.stack === null,
+ };
+ }),
+ ];
+ }, [folders, selectedFolder.folderName, selectedFolderId]);
const resolvedComposition = Internals.useResolvedVideoConfig(null);
const initialComposition =
resolvedComposition?.type === 'success' ||
@@ -138,9 +214,9 @@ const NewCompositionLoaded: React.FC<{
} = useCreateComposition({
compositions,
durationInFrames,
- folderName,
+ folderName: selectedFolder.folderName,
newId,
- parentName,
+ parentName: selectedFolder.parentName,
selectedFrameRate,
size,
canvasCapture:
@@ -193,8 +269,6 @@ const NewCompositionLoaded: React.FC<{
e.preventDefault();
}, []);
- const folderPath = [parentName, folderName].filter(Boolean).join('/');
-
return (
<>
<ModalHeader
@@ -204,14 +278,17 @@ const NewCompositionLoaded: React.FC<{
/>
<form onSubmit={onSubmit}>
<div style={content}>
- {folderPath ? (
- <div style={optionRow}>
- <div style={label}>Folder</div>
- <div style={rightRow}>
- <span style={folderPathStyle}>{folderPath}</span>
- </div>
+ <div style={optionRow}>
+ <div style={label}>Folder</div>
+ <div style={rightRow}>
+ <Combobox
+ values={folderValues}
+ selectedId={selectedFolderId}
+ style={folderSelectStyle}
+ title="Folder"
+ />
</div>
- ) : null}
+ </div>
<div style={optionRow}>
<div style={label}>ID</div>
<div style={rightRow}>
@@ -334,7 +411,7 @@ const NewCompositionLoaded: React.FC<{
genericSubmitLabel="Add to root file"
submitLabel={({relativeRootPath}) => `Add to ${relativeRootPath}`}
codemod={codemod}
- stack={stack}
+ stack={selectedFolder.stack}
valid={valid}
onSuccess={null}
applyCodemod={({signal, symbolicatedStack}) =>