Skip to content

🎥 Make videos programmatically with React

`@remotion/studio`: Compact tabs and make canvas tabs configurable

JonnyBurger9c8752bdcbd7
diff --git a/packages/browser-studio/src/BrowserStudio.tsx b/packages/browser-studio/src/BrowserStudio.tsx
index 90a94a0c9c..6a2c424d38 100644
--- a/packages/browser-studio/src/BrowserStudio.tsx
+++ b/packages/browser-studio/src/BrowserStudio.tsx
@@ -669,6 +669,7 @@ export const BrowserStudio: React.FC<BrowserStudioProps> = ({
keyboardShortcutsEnabled: true,
maxTimelineTracks: null,
publicLicenseKey: null,
+ canvasTabsEnabled: true,
configFileStudioSettings: null,
},
studioServerCommand: null,
diff --git a/packages/bundler/src/bundle.ts b/packages/bundler/src/bundle.ts
index 78684132fd..17dea565f3 100644
--- a/packages/bundler/src/bundle.ts
+++ b/packages/bundler/src/bundle.ts
@@ -461,6 +461,7 @@ export const internalBundle = async (
studioRuntimeConfig: {
askAIEnabled: actualArgs.askAIEnabled,
bufferStateDelayInMilliseconds: actualArgs.bufferStateDelayInMilliseconds,
+ canvasTabsEnabled: true,
defaultCodingAgent: null,
defaultEditor: null,
interactivityEnabled: actualArgs.interactivityEnabled,
diff --git a/packages/cli/src/config/index.ts b/packages/cli/src/config/index.ts
index 0d38cdb16b..6bf9c61e8c 100644
--- a/packages/cli/src/config/index.ts
+++ b/packages/cli/src/config/index.ts
@@ -143,6 +143,7 @@ const {
publicLicenseKeyOption,
interactivityOption,
keyboardShortcutsOption,
+ canvasTabsOption,
forceNewStudioOption,
experimentalKeepAudioContextAliveOption,
numberOfSharedAudioTagsOption,
@@ -234,6 +235,12 @@ declare global {
* @default true
*/
readonly setInteractivityEnabled: (enabled: boolean) => void;
+ /**
+ * Enable the tabs above the Remotion Studio canvas.
+ * @param enabled Boolean whether to show the canvas tabs
+ * @default true
+ */
+ readonly setCanvasTabsEnabled: (enabled: boolean) => void;
/**
* Allow the experimental HTML-in-canvas capture path in Studio client-side renders.
* @default false
@@ -783,6 +790,7 @@ export const Config: FlatConfig = {
setKeyboardShortcutsEnabled: keyboardShortcutsOption.setConfig,
setKeyboardShortcuts,
setInteractivityEnabled: interactivityOption.setConfig,
+ setCanvasTabsEnabled: canvasTabsOption.setConfig,
setAllowHtmlInCanvasEnabled: allowHtmlInCanvasOption.setConfig,
setRspack: rspackOption.setConfig,
setExperimentalRspackEnabled: rspackOption.setConfig,
diff --git a/packages/cli/src/parsed-cli.ts b/packages/cli/src/parsed-cli.ts
index e767246b9c..2aef725891 100644
--- a/packages/cli/src/parsed-cli.ts
+++ b/packages/cli/src/parsed-cli.ts
@@ -53,6 +53,7 @@ const {
packageManagerOption,
webpackPollOption,
keyboardShortcutsOption,
+ canvasTabsOption,
interactivityOption,
imageSequencePatternOption,
scaleOption,
@@ -166,6 +167,7 @@ export type CommandLineOptions = {
[keyboardShortcutsOption.cliFlag]: TypeOfOption<
typeof keyboardShortcutsOption
> | null;
+ [canvasTabsOption.cliFlag]: TypeOfOption<typeof canvasTabsOption> | null;
[interactivityOption.cliFlag]: TypeOfOption<
typeof interactivityOption
> | null;
@@ -230,6 +232,7 @@ export const BooleanFlags = [
ignoreCertificateErrorsOption.cliFlag,
headlessOption.cliFlag,
keyboardShortcutsOption.cliFlag,
+ canvasTabsOption.cliFlag,
interactivityOption.cliFlag,
ipv4Option.cliFlag,
beepOnFinishOption.cliFlag,
@@ -258,6 +261,7 @@ export const parsedCli = minimist<CommandLineOptions>(process.argv.slice(2), {
[ignoreCertificateErrorsOption.cliFlag]: null,
[headlessOption.cliFlag]: null,
[keyboardShortcutsOption.cliFlag]: null,
+ [canvasTabsOption.cliFlag]: null,
[interactivityOption.cliFlag]: null,
[ipv4Option.cliFlag]: null,
[beepOnFinishOption.cliFlag]: null,
diff --git a/packages/cli/src/print-help.ts b/packages/cli/src/print-help.ts
index 2f11749d4a..c54d146267 100644
--- a/packages/cli/src/print-help.ts
+++ b/packages/cli/src/print-help.ts
@@ -65,6 +65,7 @@ const studioOptions = options([
'disable-git-source',
'audio-latency-hint',
'disable-keyboard-shortcuts',
+ 'disable-canvas-tabs',
'disable-interactivity',
'allow-html-in-canvas',
'editor',
diff --git a/packages/cli/src/studio.ts b/packages/cli/src/studio.ts
index 6ac7476eb4..53e2aa26e4 100644
--- a/packages/cli/src/studio.ts
+++ b/packages/cli/src/studio.ts
@@ -42,6 +42,7 @@ const {
askAIOption,
interactivityOption,
keyboardShortcutsOption,
+ canvasTabsOption,
forceNewStudioOption,
experimentalKeepAudioContextAliveOption,
numberOfSharedAudioTagsOption,
@@ -185,6 +186,9 @@ export const studioCommand = async (
publicLicenseKey: publicLicenseKeyOption.getValue({
commandLine: parsedCli,
}).value,
+ canvasTabsEnabled: canvasTabsOption.getValue({
+ commandLine: parsedCli,
+ }).value,
configFileStudioSettings: {
askAIEnabled: askAIOption.getConfigValue(),
audioLatencyHint: audioLatencyHintOption.getConfigValue(),
@@ -198,6 +202,7 @@ export const studioCommand = async (
StudioServerInternals.getConfiguredMaxTimelineTracks(),
numberOfSharedAudioTags: numberOfSharedAudioTagsOption.getConfigValue(),
rspack: rspackOption.getConfigValue(),
+ canvasTabsEnabled: canvasTabsOption.getConfigValue(),
},
};
};
diff --git a/packages/docs/docs/cli/studio.mdx b/packages/docs/docs/cli/studio.mdx
index 90b9e8e07c..166dc27195 100644
--- a/packages/docs/docs/cli/studio.mdx
+++ b/packages/docs/docs/cli/studio.mdx
@@ -53,6 +53,10 @@ Inline JSON string isn't supported on Windows shells because it removes the `"`
<Options id="disable-keyboard-shortcuts" />
+### `--disable-canvas-tabs`<AvailableFrom v="4.0.530" />
+
+<Options id="disable-canvas-tabs" />
+
### `--disable-interactivity`<AvailableFrom v="4.0.487" />
<Options id="disable-interactivity" />
diff --git a/packages/docs/docs/config.mdx b/packages/docs/docs/config.mdx
index 807bd40240..2a58d3635e 100644
--- a/packages/docs/docs/config.mdx
+++ b/packages/docs/docs/config.mdx
@@ -266,6 +266,18 @@ Config.setInteractivityEnabled(false);
The [command line flag](/docs/cli/studio#--disable-interactivity) `--disable-interactivity` will take precedence over this option.
+## `setCanvasTabsEnabled()`<AvailableFrom v="4.0.530" />
+
+Show or hide the tabs above the canvas in the Studio. The tabs are shown by default.
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setCanvasTabsEnabled(false);
+```
+
+The [command line flag](/docs/cli/studio#--disable-canvas-tabs) `--disable-canvas-tabs` will take precedence over this option.
+
## `setDefaultEditor()`<AvailableFrom v="4.0.503" />
<Options id="editor" />
diff --git a/packages/renderer/src/options/canvas-tabs.tsx b/packages/renderer/src/options/canvas-tabs.tsx
new file mode 100644
index 0000000000..765fecb1b0
--- /dev/null
+++ b/packages/renderer/src/options/canvas-tabs.tsx
@@ -0,0 +1,39 @@
+import type {AnyRemotionOption} from './option';
+
+let canvasTabsEnabled = true;
+let configuredCanvasTabsEnabled: boolean | null = null;
+
+const cliFlag = 'disable-canvas-tabs' as const;
+
+export const canvasTabsOption = {
+ name: 'Disable or enable Studio canvas tabs',
+ cliFlag,
+ description: () => <>Enable or disable the tabs above the Studio canvas.</>,
+ ssrName: null,
+ docLink: 'https://www.remotion.dev/docs/config#setcanvastabsenabled',
+ type: false as boolean,
+ getValue: ({commandLine}) => {
+ if (commandLine[cliFlag] !== undefined && commandLine[cliFlag] !== null) {
+ canvasTabsEnabled = commandLine[cliFlag] === false;
+ return {
+ value: canvasTabsEnabled,
+ source: 'cli',
+ };
+ }
+
+ return {
+ value: canvasTabsEnabled,
+ source: 'config',
+ };
+ },
+ setConfig(value) {
+ canvasTabsEnabled = value;
+ configuredCanvasTabsEnabled = value;
+ },
+ getConfigValue: () => configuredCanvasTabsEnabled,
+ reset: () => {
+ canvasTabsEnabled = true;
+ configuredCanvasTabsEnabled = null;
+ },
+ id: cliFlag,
+} satisfies AnyRemotionOption<boolean>;
diff --git a/packages/renderer/src/options/index.tsx b/packages/renderer/src/options/index.tsx
index e4c9a38328..d4885d94c4 100644
--- a/packages/renderer/src/options/index.tsx
+++ b/packages/renderer/src/options/index.tsx
@@ -9,6 +9,7 @@ import {binariesDirectoryOption} from './binaries-directory';
import {browserOption} from './browser';
import {browserExecutableOption} from './browser-executable';
import {bundleCacheOption} from './bundle-cache';
+import {canvasTabsOption} from './canvas-tabs';
import {chromeModeOption} from './chrome-mode';
import {colorSpaceOption} from './color-space';
import {concurrencyOption} from './concurrency';
@@ -166,6 +167,7 @@ export const allOptions = {
askAIOption,
interactivityOption,
keyboardShortcutsOption,
+ canvasTabsOption,
framesOption,
forceNewStudioOption,
experimentalKeepAudioContextAliveOption,
diff --git a/packages/studio-server/src/test/file-source-route.test.ts b/packages/studio-server/src/test/file-source-route.test.ts
index 0e833b0d7f..bbe0ebe043 100644
--- a/packages/studio-server/src/test/file-source-route.test.ts
+++ b/packages/studio-server/src/test/file-source-route.test.ts
@@ -86,6 +86,7 @@ test('serves file source from an origin-less GET request', async () => {
getStudioRuntimeConfig: () => ({
askAIEnabled: false,
bufferStateDelayInMilliseconds: null,
+ canvasTabsEnabled: true,
defaultCodingAgent: null,
defaultEditor: null,
interactivityEnabled: true,
diff --git a/packages/studio-server/src/test/update-config.test.ts b/packages/studio-server/src/test/update-config.test.ts
index 34cdcd3b13..26b004db33 100644
--- a/packages/studio-server/src/test/update-config.test.ts
+++ b/packages/studio-server/src/test/update-config.test.ts
@@ -15,6 +15,7 @@ import {
const studioRuntimeConfig = (elementLibraryUrls: readonly string[]) => ({
askAIEnabled: false,
bufferStateDelayInMilliseconds: null,
+ canvasTabsEnabled: true,
configFileStudioSettings: null,
defaultCodingAgent: null,
defaultEditor: null,
diff --git a/packages/studio-server/src/test/upload-output-security.test.ts b/packages/studio-server/src/test/upload-output-security.test.ts
index b37ff0d7db..1da52df9e4 100644
--- a/packages/studio-server/src/test/upload-output-security.test.ts
+++ b/packages/studio-server/src/test/upload-output-security.test.ts
@@ -90,6 +90,7 @@ const requestWriteRoute = async ({
getStudioRuntimeConfig: () => ({
askAIEnabled: false,
bufferStateDelayInMilliseconds: null,
+ canvasTabsEnabled: true,
configFileStudioSettings: null,
defaultCodingAgent: null,
defaultEditor: null,
diff --git a/packages/studio-shared/src/config-method-lifecycles.ts b/packages/studio-shared/src/config-method-lifecycles.ts
index 11313289f5..933bd9eacb 100644
--- a/packages/studio-shared/src/config-method-lifecycles.ts
+++ b/packages/studio-shared/src/config-method-lifecycles.ts
@@ -23,6 +23,7 @@ export const configMethodLifecycles = {
setBufferStateDelayInMilliseconds: 'runtime',
setBundleOutDir: 'runtime',
setCachingEnabled: 'runtime',
+ setCanvasTabsEnabled: 'runtime',
setChromeMode: 'runtime',
setChromiumDarkMode: 'runtime',
setChromiumDisableWebSecurity: 'runtime',
diff --git a/packages/studio-shared/src/studio-runtime-config.ts b/packages/studio-shared/src/studio-runtime-config.ts
index 6044a71720..20a13ec769 100644
--- a/packages/studio-shared/src/studio-runtime-config.ts
+++ b/packages/studio-shared/src/studio-runtime-config.ts
@@ -16,6 +16,7 @@ export type ConfigFileStudioSettings = {
readonly maxTimelineTracks: number | null;
readonly numberOfSharedAudioTags: number | null;
readonly rspack: boolean | null;
+ readonly canvasTabsEnabled: boolean | null;
};
export type StudioElementLibrary = {
@@ -34,5 +35,6 @@ export type StudioRuntimeConfig = {
readonly defaultCodingAgent: DefaultCodingAgent | null;
readonly defaultEditor: BuiltInEditor | 'custom' | null;
readonly publicLicenseKey: string | null;
+ readonly canvasTabsEnabled: boolean | null;
readonly configFileStudioSettings: ConfigFileStudioSettings | null;
};
diff --git a/packages/studio/src/components/CanvasTabs.tsx b/packages/studio/src/components/CanvasTabs.tsx
index e016c34b12..f2fffc47d2 100644
--- a/packages/studio/src/components/CanvasTabs.tsx
+++ b/packages/studio/src/components/CanvasTabs.tsx
@@ -50,7 +50,8 @@ import {
getDraggedRenderOutputCanvasContent,
RENDER_OUTPUT_TAB_DRAG_MIME_TYPE,
} from './RenderQueue/use-render-output-file-drag';
-import {Tab, Tabs} from './Tabs';
+import {useSettings} from './SettingsContext';
+import {TAB_HEIGHT, Tab, Tabs} from './Tabs';
import {useResolvedStack} from './Timeline/use-resolved-stack';
import {useOpenInMenuApps} from './use-open-in-menu-apps';
import {useSelectAsset} from './use-select-asset';
@@ -147,7 +148,7 @@ const loadTabs = (): CanvasContent[] => {
const container: React.CSSProperties = {
backgroundColor: TIMELINE_BACKGROUND_COLOR,
flexShrink: 0,
- height: 34,
+ height: TAB_HEIGHT,
overflowX: 'auto',
overflowY: 'hidden',
overscrollBehaviorX: 'none',
@@ -490,6 +491,8 @@ const CanvasTab: React.FC<{
};
export const CanvasTabs: React.FC = () => {
+ const {studioRuntimeConfig} = useSettings();
+ const canvasTabsEnabled = studioRuntimeConfig?.canvasTabsEnabled ?? true;
const {canvasContent, compositions} = useContext(
Internals.CompositionManager,
);
@@ -873,7 +876,7 @@ export const CanvasTabs: React.FC = () => {
[],
);
- if (tabs.length === 0) {
+ if (!canvasTabsEnabled || tabs.length === 0) {
return null;
}
diff --git a/packages/studio/src/components/StudioSettings.tsx b/packages/studio/src/components/StudioSettings.tsx
index d3bd1dbeab..963b4f4497 100644
--- a/packages/studio/src/components/StudioSettings.tsx
+++ b/packages/studio/src/components/StudioSettings.tsx
@@ -54,6 +54,7 @@ const initialSettings: ConfigFileStudioSettings = {
maxTimelineTracks: null,
numberOfSharedAudioTags: null,
rspack: null,
+ canvasTabsEnabled: null,
};
const ConfigNumber = ({
@@ -178,6 +179,7 @@ export const StudioSettings: React.FC = () => {
),
update('setRspack', settings.rspack),
update('setInteractivityEnabled', settings.interactivityEnabled),
+ update('setCanvasTabsEnabled', settings.canvasTabsEnabled),
update('setLogLevel', settings.logLevel),
].filter((item) => editedSetters.has(item.setter));
@@ -285,6 +287,22 @@ export const StudioSettings: React.FC = () => {
/>
</div>
</label>
+ <label style={optionRow}>
+ <div style={label}>Tabs above Canvas</div>
+ <div style={rightRow}>
+ <Checkbox
+ checked={settings.canvasTabsEnabled !== false}
+ name="Tabs above Canvas"
+ onChange={(event) =>
+ changeSetting(
+ 'canvasTabsEnabled',
+ 'setCanvasTabsEnabled',
+ event.target.checked ? null : false,
+ )
+ }
+ />
+ </div>
+ </label>
<label style={optionRow}>
<div style={label}>Interactivity enabled</div>
<div style={rightRow}>
diff --git a/packages/studio/src/components/Tabs/index.tsx b/packages/studio/src/components/Tabs/index.tsx
index 8c9007f9f7..e3f979ffe9 100644
--- a/packages/studio/src/components/Tabs/index.tsx
+++ b/packages/studio/src/components/Tabs/index.tsx
@@ -15,6 +15,8 @@ const tabsContainer: React.CSSProperties = {
flexDirection: 'row',
};
+export const TAB_HEIGHT = 27;
+
export const Tabs: React.FC<{
readonly children: React.ReactNode;
readonly style?: React.CSSProperties;
@@ -33,7 +35,7 @@ const selectorButton: React.CSSProperties = {
border: 'none',
flex: 1,
padding: 3,
- height: 34,
+ height: TAB_HEIGHT,
paddingLeft: 10,
display: 'flex',
flexDirection: 'row',
diff --git a/packages/studio/src/helpers/studio-runtime-config.ts b/packages/studio/src/helpers/studio-runtime-config.ts
index 7acf1564c6..b498a0acb4 100644
--- a/packages/studio/src/helpers/studio-runtime-config.ts
+++ b/packages/studio/src/helpers/studio-runtime-config.ts
@@ -11,6 +11,7 @@ const defaultStudioRuntimeConfig: StudioRuntimeConfig = {
keyboardShortcutsEnabled: true,
maxTimelineTracks: null,
publicLicenseKey: null,
+ canvasTabsEnabled: true,
configFileStudioSettings: null,
};