Skip to content

🎥 Make videos programmatically with React

Studio: Move composition sorting to explorer menu

Jonny Burger9fec738b5390
diff --git a/packages/example/e2e/studio.test.mts b/packages/example/e2e/studio.test.mts
index 509d340418..1f00dde721 100644
--- a/packages/example/e2e/studio.test.mts
+++ b/packages/example/e2e/studio.test.mts
@@ -965,6 +965,14 @@ test.describe('visual mode', () => {
'Schema',
'AnimatedBarChart',
]);
+ const registeredCompositionItems = await page
+ .locator('.__remotion-composition-selector-item[data-compname]')
+ .evaluateAll((items) =>
+ items.map((item) => item.getAttribute('data-compname') ?? ''),
+ );
+ const alphabeticalCompositionItems = [...registeredCompositionItems].sort(
+ (a, b) => a.localeCompare(b, undefined, {numeric: true}),
+ );
await page.getByRole('button', {name: 'More composition actions'}).click();
await expect(
page.getByRole('button', {name: 'New composition...', exact: true}),
@@ -972,6 +980,47 @@ test.describe('visual mode', () => {
await expect(
page.getByRole('button', {name: 'New folder...', exact: true}),
).toBeVisible();
+ await expect(page.getByText('Sort', {exact: true})).toBeVisible();
+ await page
+ .getByRole('button', {name: 'Alphabetically', exact: true})
+ .click();
+ await expect
+ .poll(() =>
+ page
+ .locator('.__remotion-composition-selector-item[data-compname]')
+ .evaluateAll((items) =>
+ items.map((item) => item.getAttribute('data-compname') ?? ''),
+ ),
+ )
+ .toEqual(alphabeticalCompositionItems);
+ await page.reload();
+ await expect(page.getByRole('button', {name: 'Schema'})).toBeVisible({
+ timeout: 15_000,
+ });
+ await expect
+ .poll(() =>
+ page
+ .locator('.__remotion-composition-selector-item[data-compname]')
+ .evaluateAll((items) =>
+ items.map((item) => item.getAttribute('data-compname') ?? ''),
+ ),
+ )
+ .toEqual(alphabeticalCompositionItems);
+ await page.getByRole('button', {name: 'More composition actions'}).click();
+ await page
+ .getByRole('button', {name: 'As registered', exact: true})
+ .click();
+ await expect
+ .poll(() =>
+ page
+ .locator('.__remotion-composition-selector-item')
+ .evaluateAll((items) =>
+ items.slice(0, 3).map((item) => item.getAttribute('title')),
+ ),
+ )
+ .toEqual(firstCompositionItems);
+
+ await page.getByRole('button', {name: 'More composition actions'}).click();
await page
.getByRole('button', {name: 'New composition...', exact: true})
.click();
diff --git a/packages/studio/src/components/CompositionSelector.tsx b/packages/studio/src/components/CompositionSelector.tsx
index 13d49fea83..c17417948b 100644
--- a/packages/studio/src/components/CompositionSelector.tsx
+++ b/packages/studio/src/components/CompositionSelector.tsx
@@ -16,7 +16,6 @@ import {
sortFolderTreeAlphabetically,
} from '../helpers/create-folder-tree';
import {ExpandedFoldersContext} from '../helpers/persist-open-folders';
-import {sortItemsByNonceHistory} from '../helpers/sort-by-nonce-history';
import {FolderContext} from '../state/folders';
import {SetSelectedModalContext} from '../state/modals';
import {useZIndex} from '../state/z-index';
@@ -158,36 +157,13 @@ export const CompositionSelector: React.FC = () => {
const {tabIndex} = useZIndex();
const selectComposition = useSelectComposition();
- // In alphabetical mode the tree gets sorted by name afterwards, so the
- // expensive nonce sorting can be skipped.
- const sortedCompositions = useMemo(() => {
- return compositionSortOrder === 'alphabetical'
- ? compositions
- : sortItemsByNonceHistory(compositions);
- }, [compositionSortOrder, compositions]);
-
- const sortedFolders = useMemo(() => {
- return compositionSortOrder === 'alphabetical'
- ? folders
- : sortItemsByNonceHistory(folders);
- }, [compositionSortOrder, folders]);
-
const items = useMemo(() => {
- const tree = createFolderTree(
- sortedCompositions,
- sortedFolders,
- foldersExpanded,
- );
+ const tree = createFolderTree(compositions, folders, foldersExpanded);
return compositionSortOrder === 'alphabetical'
? sortFolderTreeAlphabetically(tree)
: tree;
- }, [
- compositionSortOrder,
- sortedCompositions,
- sortedFolders,
- foldersExpanded,
- ]);
+ }, [compositionSortOrder, compositions, folders, foldersExpanded]);
const list: React.CSSProperties = useMemo(() => {
return {
diff --git a/packages/studio/src/components/root-composition-menu-items.tsx b/packages/studio/src/components/root-composition-menu-items.tsx
index c62bee9e27..7a73bc1351 100644
--- a/packages/studio/src/components/root-composition-menu-items.tsx
+++ b/packages/studio/src/components/root-composition-menu-items.tsx
@@ -62,47 +62,19 @@ export const getRootCompositionMenuItems = ({
type: 'divider',
},
{
- id: 'sort-compositions',
- keyHint: null,
- label: 'Sort by',
- leftItem: null,
- onClick: () => undefined,
- quickSwitcherLabel: null,
- type: 'item',
- value: 'sort-compositions',
- subMenu: {
- leaveLeftSpace: true,
- preselectIndex: compositionSortOrder === 'alphabetical' ? 1 : 0,
- items: getCompositionSortOrderMenuItems({
- compositionSortOrder,
- setCompositionSortOrder,
- onSelected: () => undefined,
- }),
- },
+ id: 'sort-compositions-header',
+ label: 'Sort',
+ type: 'section-header',
},
- ];
-};
-
-export const getCompositionSortOrderMenuItems = ({
- compositionSortOrder,
- setCompositionSortOrder,
- onSelected,
-}: {
- compositionSortOrder: CompositionSortOrder;
- setCompositionSortOrder: (sortOrder: CompositionSortOrder) => void;
- onSelected: () => void;
-}): ComboboxValue[] => {
- return [
{
id: 'sort-compositions-registration',
keyHint: null,
- label: 'Order in root file',
+ label: 'As registered',
leftItem: compositionSortOrder === 'registration' ? <Checkmark /> : null,
onClick: () => {
- onSelected();
setCompositionSortOrder('registration');
},
- quickSwitcherLabel: 'Sort compositions by order in root file',
+ quickSwitcherLabel: 'Sort compositions as registered',
subMenu: null,
type: 'item',
value: 'registration' as CompositionSortOrder,
@@ -110,13 +82,12 @@ export const getCompositionSortOrderMenuItems = ({
{
id: 'sort-compositions-alphabetical',
keyHint: null,
- label: 'Name',
+ label: 'Alphabetically',
leftItem: compositionSortOrder === 'alphabetical' ? <Checkmark /> : null,
onClick: () => {
- onSelected();
setCompositionSortOrder('alphabetical');
},
- quickSwitcherLabel: 'Sort compositions by name',
+ quickSwitcherLabel: 'Sort compositions alphabetically',
subMenu: null,
type: 'item',
value: 'alphabetical' as CompositionSortOrder,
diff --git a/packages/studio/src/helpers/create-folder-tree.ts b/packages/studio/src/helpers/create-folder-tree.ts
index 78df63f5bf..b21d340d56 100644
--- a/packages/studio/src/helpers/create-folder-tree.ts
+++ b/packages/studio/src/helpers/create-folder-tree.ts
@@ -263,8 +263,7 @@ export const createFolderTree = (
/**
* Sorts the tree returned by createFolderTree by name, on every level.
- * Folders stay above compositions like they do in registration order - only
- * the order within each of the two groups changes.
+ * Folders stay grouped above compositions, and both groups are sorted.
*/
export const sortFolderTreeAlphabetically = (
items: CompositionSelectorItemType[],
diff --git a/packages/studio/src/helpers/use-menu-structure.tsx b/packages/studio/src/helpers/use-menu-structure.tsx
index 3b5674ff0c..ac1602e2b0 100644
--- a/packages/studio/src/helpers/use-menu-structure.tsx
+++ b/packages/studio/src/helpers/use-menu-structure.tsx
@@ -14,7 +14,6 @@ import type {
import {showNotification} from '../components/Notifications/NotificationCenter';
import type {TQuickSwitcherResult} from '../components/QuickSwitcher/QuickSwitcherResult';
import {openInFileExplorer} from '../components/RenderQueue/actions';
-import {getCompositionSortOrderMenuItems} from '../components/root-composition-menu-items';
import {getPreviewSizeLabel, getUniqueSizes} from '../components/SizeSelector';
import {useResolvedStack} from '../components/Timeline/use-resolved-stack';
import {inOutHandles} from '../components/TimelineInOutToggle';
@@ -28,7 +27,6 @@ import {EditorShowPixelGridContext} from '../state/editor-pixel-grid';
import {EditorShowRulersContext} from '../state/editor-rulers';
import {EditorSnappingContext} from '../state/editor-snapping';
import {EditorZoomGesturesContext} from '../state/editor-zoom-gestures';
-import {FolderContext} from '../state/folders';
import type {ModalState} from '../state/modals';
import {SetSelectedModalContext} from '../state/modals';
import type {SidebarCollapsedState} from '../state/sidebar';
@@ -308,8 +306,6 @@ export const useMenuStructure = (
EditorShowGuidesContext,
);
const {editorSnapping, setEditorSnapping} = useContext(EditorSnappingContext);
- const {compositionSortOrder, setCompositionSortOrder} =
- useContext(FolderContext);
const {size, setSize} = useContext(Internals.PreviewSizeContext);
const {canvasContent, compositions} = useContext(
Internals.CompositionManager,
@@ -734,25 +730,6 @@ export const useMenuStructure = (
},
onClick: () => undefined,
},
- {
- id: 'sort-compositions',
- label: 'Sort Compositions By',
- keyHint: null,
- type: 'item' as const,
- value: 'sort-compositions',
- leftItem: null,
- quickSwitcherLabel: null,
- subMenu: {
- leaveLeftSpace: true,
- preselectIndex: compositionSortOrder === 'alphabetical' ? 1 : 0,
- items: getCompositionSortOrderMenuItems({
- compositionSortOrder,
- setCompositionSortOrder,
- onSelected: closeMenu,
- }),
- },
- onClick: () => undefined,
- },
{
id: 'timeline-divider-2',
type: 'divider' as const,
@@ -1160,7 +1137,6 @@ export const useMenuStructure = (
sidebarCollapsedStateLeft,
sidebarCollapsedStateRight,
checkerboard,
- compositionSortOrder,
isFullscreenSupported,
remotion_packageManager,
mobileLayout,
@@ -1178,7 +1154,6 @@ export const useMenuStructure = (
setEditorSnapping,
setSidebarCollapsedState,
setCheckerboard,
- setCompositionSortOrder,
setSelectedModal,
]);
diff --git a/packages/studio/src/state/folders.tsx b/packages/studio/src/state/folders.tsx
index 27f1655bfb..c99997238a 100644
--- a/packages/studio/src/state/folders.tsx
+++ b/packages/studio/src/state/folders.tsx
@@ -2,8 +2,8 @@ import React, {createContext, useCallback, useMemo, useState} from 'react';
import type {ExpandedFoldersState} from '../helpers/persist-open-folders';
import {loadExpandedFolders} from '../helpers/persist-open-folders';
-// 'registration' keeps the order in which the compositions are written in the
-// root file, 'alphabetical' sorts them by name on every level of the tree.
+// 'registration' keeps the order in which compositions and folders are
+// registered, 'alphabetical' sorts them by name on every level of the tree.
export type CompositionSortOrder = 'registration' | 'alphabetical';
const compositionSortOrderKey = 'remotion.compositionSortOrder';
diff --git a/packages/studio/src/test/folder-tree.test.ts b/packages/studio/src/test/folder-tree.test.ts
index 62d109e878..26b0056a36 100644
--- a/packages/studio/src/test/folder-tree.test.ts
+++ b/packages/studio/src/test/folder-tree.test.ts
@@ -337,7 +337,12 @@ test('sortFolderTreeAlphabetically sorts every level and keeps folders on top',
testComp('Scene2', 'zoo'),
testComp('Apple', null),
],
- [testFolder('zoo', null), testFolder('animals', null)],
+ [
+ testFolder('zoo', null),
+ testFolder('animals', null),
+ testFolder('zulu', 'zoo'),
+ testFolder('alpha', 'zoo'),
+ ],
{},
);
@@ -358,5 +363,5 @@ test('sortFolderTreeAlphabetically sorts every level and keeps folders on top',
zoo.items.map((item) =>
item.type === 'folder' ? item.folderName : item.composition.id,
),
- ).toEqual(['Scene2', 'Scene10']);
+ ).toEqual(['alpha', 'zulu', 'Scene2', 'Scene10']);
});
diff --git a/packages/studio/src/test/root-composition-menu-items.test.ts b/packages/studio/src/test/root-composition-menu-items.test.ts
index 51b9c4872a..d40bd3ab7b 100644
--- a/packages/studio/src/test/root-composition-menu-items.test.ts
+++ b/packages/studio/src/test/root-composition-menu-items.test.ts
@@ -93,19 +93,24 @@ test('root composition menu switches the sort order and is usable read-only', ()
setCompositionSortOrder: (sortOrder) => sortOrders.push(sortOrder),
});
- const sortBy = items.find((item) => item.id === 'sort-compositions');
- if (sortBy?.type !== 'item' || sortBy.subMenu === null) {
- throw new Error('Expected a sort submenu');
- }
-
- expect(sortBy.disabled).toBe(undefined);
- expect(sortBy.subMenu.preselectIndex).toBe(0);
+ expect(items.map((item) => item.id)).toEqual([
+ 'new-root-composition',
+ 'new-root-folder',
+ 'sort-compositions-divider',
+ 'sort-compositions-header',
+ 'sort-compositions-registration',
+ 'sort-compositions-alphabetical',
+ ]);
- for (const item of sortBy.subMenu.items) {
+ for (const item of items) {
if (item.type !== 'item') {
continue;
}
+ if (!item.id.startsWith('sort-compositions-')) {
+ continue;
+ }
+
item.onClick(item.id, null);
}