Remotion 5 Breaking Changes

Remotion 5 Breaking Changes

Use the central compile-time flag in packages/core/src/v5-flag.ts:

export const ENABLE_V5_BREAKING_CHANGES = false as const;

Preserve the compile-time flag

• Keep the flag as the literal false as const on the v4/main release line.
• Do not turn it into an environment variable, runtime option, or general boolean. Its literal type selects the public TypeScript API as well as runtime behavior.
• Do not introduce another v5 flag.
• Inside packages/core, import the flag from v5-flag.ts. From another package, use NoReactInternals.ENABLE_V5_BREAKING_CHANGES from remotion/no-react so all packages use the same value.

When the v5 release line is cut, changing this one constant to true as const must activate the v5 runtime behavior and public TypeScript API together.

Gate runtime behavior

Branch defaults and behavior on the central flag while preserving the existing v4 path:

const effectiveValue =
	value ??
	(NoReactInternals.ENABLE_V5_BREAKING_CHANGES ? v5Default : v4Default);

An explicit user value should continue to take precedence unless the v5 API intentionally removes that value. Keep runtime validation aligned with the selected public type so JavaScript callers and callers bypassing TypeScript get the v5 behavior too.

Gate public types

For a breaking signature or options change, select the entire incompatible part with a conditional type based on the literal flag:

type VersionedOptions =
	typeof NoReactInternals.ENABLE_V5_BREAKING_CHANGES extends true
		? V5Options
		: V4Options;