🎥 Make videos programmatically with React
import type {SymbolicatedStackFrame} from '@remotion/studio-shared';
import React, {
useCallback,
useContext,
useEffect,
useRef,
useState,
} from 'react';
import {resolveFileSource} from '../error-overlay/react-overlay/effects/resolve-file-source';
import {OpenInEditor} from '../error-overlay/remotion-overlay/OpenInEditor';
import {StackElement} from '../error-overlay/remotion-overlay/StackFrame';
import {getBrowserStudioOperations} from '../helpers/browser-studio-operations';
import {StudioServerConnectionCtx} from '../helpers/client-id';
import {LIGHT_TEXT} from '../helpers/colors';
import {getCodexAnnotation} from '../helpers/get-codex-annotation';
import {findOriginalPositionInFileAtProperty} from '../helpers/open-in-editor';
import {requestCodexAnnotation} from '../helpers/request-codex-annotation';
import type {ModalState} from '../state/modals';
import {AgentPrompt} from './AgentPrompt';
import {ModalButton} from './ModalButton';
import {getMaxModalHeight, getMaxModalWidth} from './ModalContainer';
import {ModalHeader} from './ModalHeader';
import {DismissableModal} from './NewComposition/DismissableModal';
import {useSettings} from './SettingsContext';
import {useEditorOpening} from './use-default-editor-info';
import {useDownloadProject} from './use-download-project';
const panelStyle: React.CSSProperties = {
borderRadius: 6,
display: 'flex',
flexDirection: 'column',
width: getMaxModalWidth(560),
maxHeight: getMaxModalHeight(800),
minWidth: 0,
overflow: 'hidden',
};
const container: React.CSSProperties = {
padding: 16,
minHeight: 0,
overflowY: 'auto',
};
const text: React.CSSProperties = {
color: LIGHT_TEXT,
fontFamily: 'sans-serif',
fontSize: 14,
lineHeight: 1.5,
};
const sourcePreviewContainer: React.CSSProperties = {
marginBottom: 16,
marginTop: 4,
};
const sourcePreviewStatus: React.CSSProperties = {
...text,
marginBottom: 16,
marginTop: 10,
};
type FixComputedValueModalState = Extract<
ModalState,
{type: 'fix-computed-value'}
>;
type SourcePreviewState =
| {
type: 'loading';
}
| {
type: 'loaded';
stack: SymbolicatedStackFrame;
}
| {
type: 'error';
message: string;
};
export const FixComputedValueModal: React.FC<{
readonly state: FixComputedValueModalState;
}> = ({state}) => {
const {previewServerState} = useContext(StudioServerConnectionCtx);
const {remotionSkillsInfo} = useSettings();
const annotationTarget = useRef<HTMLDivElement>(null);
const interactivitySkill = remotionSkillsInfo?.skills.find(
({name}) => name === 'remotion-interactivity',
);
const interactivitySkillAvailable = Boolean(
interactivitySkill?.installedInProject ||
interactivitySkill?.installedGlobally,
);
const {canOpenInEditor, defaultEditorId, defaultEditorName} =
useEditorOpening(previewServerState.type === 'connected');
const [sourcePreview, setSourcePreview] = useState<SourcePreviewState>({
type: 'loading',
});
const promptLocation =
sourcePreview.type === 'loaded'
? `${sourcePreview.stack.originalFileName}:${sourcePreview.stack.originalLineNumber}:${sourcePreview.stack.originalColumnNumber}`
: `${state.location.source}:${state.location.line}:${state.location.column}`;
const promptDetails = ` ${promptLocation} make "${state.prop}" interactive`;
const isBrowserStudio = getBrowserStudioOperations() !== null;
const downloadProject = useDownloadProject();
const canAnnotate =
!isBrowserStudio &&
sourcePreview.type === 'loaded' &&
!window.remotion_isReadOnlyStudio &&
getCodexAnnotation() !== null;
const onSendToChatGPT = useCallback(() => {
requestCodexAnnotation({
target: annotationTarget.current,
initialComment: interactivitySkillAvailable
? '$remotion-interactivity Make this computed value interactive.'
: 'Make this computed value interactive.',
metadata: {property: state.prop, source: promptLocation},
});
}, [interactivitySkillAvailable, promptLocation, state.prop]);
const canOpenSourceInEditor =
sourcePreview.type === 'loaded' &&
canOpenInEditor &&
defaultEditorId !== null &&
defaultEditorName !== null;
useEffect(() => {
let cancelled = false;
setSourcePreview({type: 'loading'});
findOriginalPositionInFileAtProperty({
originalPosition: state.location,
property: state.prop.split('.').at(-1) ?? state.prop,
})
.then((position) => {
return resolveFileSource(
{
columnNumber: position.column,
fileName: position.source,
lineNumber: position.line,
message: `Computed value "${state.prop}"`,
},
1,
);
})
.then((stack) => {
if (!cancelled) {
setSourcePreview({type: 'loaded', stack});
}
})
.catch((err: unknown) => {
if (!cancelled) {
setSourcePreview({
type: 'error',
message: err instanceof Error ? err.message : String(err),
});
}
});
return () => {
cancelled = true;
};
}, [state.location, state.prop]);
return (
<DismissableModal panelStyle={panelStyle}>
<ModalHeader title="Fix computed value" />
<div style={container}>
<div style={text}>
This value cannot be interactively edited because it is computed:
</div>
{sourcePreview.type === 'loaded' ? (
<div ref={annotationTarget} style={sourcePreviewContainer}>
<StackElement
collapsible={false}
defaultFunctionName={null}
editorId={canOpenInEditor ? defaultEditorId : null}
fontSize={13}
headerAction={
canOpenSourceInEditor ? (
<OpenInEditor
canHaveKeyboardShortcuts={false}
editorId={defaultEditorId}
editorName={defaultEditorName}
size="compact"
stack={sourcePreview.stack}
/>
) : null
}
horizontalSpacing={0}
isFirst
lineNumberWidth={
String(
Math.max(
0,
...(sourcePreview.stack.originalScriptCode ?? []).map(
(line) => line.lineNumber,
),
),
).length
}
s={sourcePreview.stack}
/>
</div>
) : (
<div style={sourcePreviewStatus}>
{sourcePreview.type === 'loading'
? 'Loading code preview...'
: `Could not load code preview: ${sourcePreview.message}`}
</div>
)}
{isBrowserStudio ? (
<>
<div style={text}>
This value requires a code change to become editable. Code editing
and agent-assisted refactoring are unavailable in
remotion.dev/new. Download the project to continue locally.
</div>
{downloadProject ? (
<div style={{marginTop: 16}}>
<ModalButton onClick={downloadProject}>
Download project
</ModalButton>
</div>
) : null}
</>
) : (
<AgentPrompt
action={
canAnnotate ? (
<ModalButton size="compact" onClick={onSendToChatGPT}>
Send to ChatGPT
</ModalButton>
) : null
}
availableText="Use this prompt to make this value editable:"
promptDetails={promptDetails}
skillId="remotion-interactivity"
/>
)}
</div>
</DismissableModal>
);
};