hiwurun/remotion-saas-boilerplate

通过以特定方式编写 Remotion 标记，Remotion Studio 能够识别代码结构并使其具有交互性：

• 允许通过点击选择项目
• 支持拖放、调整大小和旋转
• 编辑 CSS 样式
• 使关键帧和缓动值可编辑

如果标记过于复杂，Studio 无法使其交互，则相关值会变为灰色。

优先使用具有独立时间线的交互组件

对于填充其父组件的组件，请使用 Interactive.withSchema({wrapInSequence: true, layout: 'absolute-fill'})。该包装器提供了视觉根节点和时间线项目，并默认裁剪溢出内容，因此内部组件可以返回 fragment。将时序、预挂载、尺寸和每个实例的样式放在导出的组件上。

将属于同一视觉效果的组件放在一起，以便它们一起移动和修剪。内部布局容器仍然可以提供对齐、在较小区域内裁剪或动画组功能；仅填充场景的容器通常是不必要的。具有自身边界的卡片、文本框和 SVG 可以保留默认的 layout: 'none'，并将 style 转发到其视觉根节点。

import {Video} from '@remotion/media';
import type React from 'react';
import {Interactive, useVideoConfig, type InteractivitySchema} from 'remotion';

type SceneProps = {
  readonly title: string;
};

const SceneInner: React.FC<SceneProps> = ({title}) => {
  const {fps} = useVideoConfig();

  return (
    <>
      <Video
        name="Background footage"
        src="https://remotion.media/video.mp4"
        premountFor={fps}
        objectFit="cover"
        style={{width: '100%', height: '100%'}}
      />
      <Interactive.Div
        name="Scene title"
        style={{
          position: 'absolute',
          left: 80,
          bottom: 80,
          color: 'white',
          fontFamily: 'Helvetica, Arial, sans-serif',
          fontSize: 80,
        }}
      >
        {title}
      </Interactive.Div>
    </>
  );
};

const sceneSchema = {
  title: {type: 'string', default: '', description: 'Title'},
} as const satisfies InteractivitySchema;

export const Scene = Interactive.withSchema({
  Component: SceneInner,
  componentName: 'Scene',
  schema: sceneSchema,
  wrapInSequence: true,
  layout: 'absolute-fill',
});

选择 Schema 字段

Schema 中的每个键都是一个属性，Studio 可以在调用点读取和编辑它。 不在 Schema 中的属性仍然有效，但在 Studio 中不可编辑。 键可以使用点表示法，例如 style.color。

类型	用途	可添加关键帧
string	字符串，例如标题、提示或代码片段	否
number	数字，可选 min、max、step、integer	是
boolean	开/关 开关	是 (保持)
color	CSS 颜色字符串	是
enum	在 variants 之间选择，每个变体有自己嵌套的 schema	选择性 (保持)
array	数字、颜色、枚举等列表	否
asset	媒体源，可选 assetType	否
font-family	CSS 字体系列	否
font-weight	字体粗细	是
translate、scale、rotation-css、rotation-degrees、transform-origin	变换	是
uv-coordinate	元素上的标准化 [x, y] 点	是
svg-path	SVG 路径数据	是
remotion-captions	Caption[] 数据	否
hidden	保持在控件之外的值	—

每个字段都需要一个 default 值，并且应该有一个 description，Studio 会将其显示为标签。 设置 keyframable: false 以显示静态控件。

公开内容和每个实例的外观，例如文本和强调色。 不要为 style.translate、style.scale、style.rotate、style.transformOrigin 和 style.opacity 添加字段：wrapInSequence: true 已经添加了它们。

要使根节点的 CSS 属性在每个实例中可编辑，请展开内置的 schema 片段：

const cardSchema = {
  ...Interactive.textSchema, // style.color、style.fontSize、style.fontWeight...
  ...Interactive.backgroundSchema, // style.backgroundColor
  ...Interactive.borderRadiusSchema, // style.borderRadius...
} as const satisfies InteractivitySchema;

还有：Interactive.borderSchema，以及用于接受字幕的组件的 Interactive.captionsSchema。 对于接受 React.ReactNode 子元素的组件，添加 ...Interactive.childrenSchema。 它提供了子内容控件，并可能在未来支持更丰富的内容。 目前，它使用一个标有“Text”的字符串字段，默认值为 ''。 如果组件只需要纯字符串子元素，请改为声明一个显式的 children 字段，类型为 'string'。 Interactive.textSchema 控制排版样式；childrenSchema 控制内容。 baseSchema 中不包含 children 片段，也不会自动添加到自定义组件中。 嵌套标记和计算得出的子元素目前是只读的。 text-content 是 string 字段类型的已弃用别名。 有关所有选项，请参阅 InteractivitySchema。

将可复用组件注册为连接组合

将重要的场景和具有自己图层或动画的可复用组件注册为独立的组合。Studio 将这些称为连接组合：它们可以在自己的时间线中打开，同时与父视频共享相同的组件实现。

在组件内部定义所需的样式和加载字体，使其无需父组件即可工作。请参阅 父组件独立性。

注册与父组件渲染的相同的导出组件引用。对于上面的示例，使用 component={Scene}，而不是 SceneInner 或内联包装器。 使用 wrapInSequence: true 时，连接不需要额外的 <Sequence>。

import {Composition} from 'remotion';
import {Scene} from './Scene';

export const RemotionRoot = () => (
  <Composition
    id="Scene"
    component={Scene}
    width={1280}
    height={720}
    fps={30}
    durationInFrames={30}
    defaultProps={{
      title: 'A new perspective',
    }}
  />
);

选择唯一的 ID、有代表性的内联默认值以及适合预览组件的尺寸、fps 和持续时间。注册默认值不会自动从父实例复制属性。有关注册和提取的详细信息，请参阅 连接组合。

将时序直接放在组件上

避免在已经接受时序属性的组件周围使用单独的 <Sequence>。 使用 wrapInSequence: true 创建的内置交互组件和自定义组件可以直接接收 name、from、durationInFrames、trimBefore、playbackRate 和 premountFor。

<Scene
  name="Opening scene"
  from={30}
  durationInFrames={90}
  premountFor={fps}
  style={{opacity: 0.9}}
  title="A new perspective"
/>

删除冗余的序列时，将其时序和名称移动到子组件。 保留任何现有的子时序；不要覆盖或双重应用偏移量。 组件内部的 useCurrentFrame() 调用读取其本地帧，而调用点的样式表达式仍使用调用者的帧。移动动画样式时请保留此区别。

在以下情况下保留 <Sequence>：它为多个兄弟元素提供共享时序、包装了一个不处理时序的组件，或者提供了子组件无法直接接受的尺寸。托管根节点也接受 width 和 height 用于 useVideoConfig()。对于连续的布局，无论是否有过渡，都保留 <TransitionSeries.Sequence>；直接的 from 属性不能替代这些行为。

为每个独立可编辑的项目提供自己的 JSX 节点

Studio 编辑创建项目的 JSX 源节点。如果多个运行时项目来自同一个 JSX 节点，它们共享一个源编辑目标。

对于每个应该独立编辑的组合注册、剪辑、场景、图层或序列，编写单独的 JSX 节点，并保持其可编辑属性位于该节点上。这适用于 <Composition>、<Still>、内置媒体组件、<Sequence>、<TransitionSeries.Sequence> 和自定义组件。

例如，像这样编写一个可编辑的时间线：

import { TransitionSeries } from "@remotion/transitions";

<TransitionSeries>
  <TransitionSeries.Sequence name="Introduction" durationInFrames={90}>
    <Introduction />
  </TransitionSeries.Sequence>
  <TransitionSeries.Sequence name="Demo" durationInFrames={150}>
    <Demo />
  </TransitionSeries.Sequence>
</TransitionSeries>

.map() 或其他程序化循环会从一个 JSX 源节点创建多个运行时项目。这对于有意作为单个模板控制的重复输出（例如可视化条形图或粒子）是合适的。当实例需要独立的 ID 或名称、属性、元数据、时序、排序、删除或在 Studio 中复制时，这不合适。

使用 Interactive 使 HTML 元素具有交互性

每个 HTML 和 SVG 元素（<Img> 除外，它已经是交互式的），例如 <div>，都可以使用 Interactive 变成交互式的：

<Interactive.Div
  name="Greeting card"
  style={{fontSize: 80, padding: 24}}
>
  Hello
</Interactive.Div>

这允许在 Studio 中设置样式和关键帧。要明智使用，如果组件有很多元素，时间线可能会变得混乱。

优先使用内联文本

如果文本是固定的且只使用一次，请直接将其写在交互元素内部，而不是将其提取到常量中。

// 👍 固定副本保持可编辑
<Interactive.Div name="Title">
  Remotion Best Practices
</Interactive.Div>

仅当文本是动态或可复用时，才使用属性或变量。

为交互元素提供描述性名称

为元素添加 name 属性，使其易于识别。 避免使用计算出的名称，直接硬编码它们。

<>
  <Interactive.Div name="Hero title" style={{fontSize: 80}}>
    Launch day
  </Interactive.Div>
  <Img name="Avatar" src="https://remotion.media/image.jpeg" />
  <Video name="Background" src="https://remotion.media/video.mp4" />
  <Interactive.Div name="Title">
    Launch day
  </Interactive.Div>
</>

将所有 CSS 样式保持内联

最好的方法是直接将一个普通对象传递给 style——不要引用常量、不要展开对象、不要进行数学计算。

<Interactive.Div
  style={{
    fontSize: 80,
    color: 'red',
  }}
>
  Hello World!
</Interactive.Div>

const baseStyle = useMemo(() => {
  return {
    fontSize: 12 // ❌ 不支持非内联样式
  }
}, []);

<Interactive.Div
  style={{
    ...baseStyle, // ❌ 不支持展开
    color: RED, // ❌ 不支持引用常量
    scale: frame * 10 // ❌ 不支持数学计算
  }}
>
  Hello World!
</Interactive.Div>

使用 interpolate() 进行动画

将动画编写为对更改属性的内联 interpolate() 调用。
输出范围、缓动、外推和 output 属性应使用硬编码值。

输入范围还可以额外使用直接从 useVideoConfig() 解构的 durationInFrames、fps、width 和 height。支持裸标识符（例如 durationInFrames）、与数字相乘（例如 2 * fps 或 fps * 2）以及减去数字（例如 durationInFrames - 1）。

const {fps, durationInFrames} = useVideoConfig();

// 👍 内联值可以标准化并添加关键帧
<Interactive.Div
  name="Product card"
  style={{
    color: 'white',
    fontSize: 80,
    scale: interpolate(frame, [0, fps], [0, 1], {
      easing: Easing.spring({damping: 200}),
      output: 'perceptual-scale',
      extrapolateLeft: 'clamp',
      extrapolateRight: 'clamp'
    }),
    rotate: interpolate(frame, [0, 1 * fps], ['0deg', '20deg'], {
      easing: Easing.spring({damping: 200}),
      extrapolateLeft: 'clamp',
      extrapolateRight: 'clamp'
    }),
    translate: interpolate(
      frame,
      [durationInFrames - 30, durationInFrames],
      ['0px 0px', '0px 120px'],
      {
        easing: Easing.spring({d

…

[内容已截断]