Communitygithub.com

Guilhermeslvg/video-portfolio

以特定方式组织 Remotion 标记,使其在 Studio 中具有交互性

video-portfolio 是什么?

此技能指导开发者如何编写 Remotion 标记,以使 Remotion Studio 能够识别代码结构并实现交互功能,例如通过点击选择项目、拖放、调整大小和旋转,以及编辑 CSS 样式、关键帧和缓动值。它强调使用 `Interactive.withSchema({wrapInSequence: true, layout: 'absolute-fill'})` 来创建带有自己时间线的交互式组件,并详细说明了如何选择模式字段(如字符串、数字、布尔值、颜色、枚举、数组等),以确保内容在 Studio 中可编辑。技能还提供了最佳实践,包括:将时机直接放在组件上(避免单独的 `<Sequence>`)、为每个可独立编辑的项目创建单独的 JSX 节点、使用 `Interactive` 让 HTML 元素可交互、首选用内联文本、为元素添加描述性名称、将所有 CSS 样式内联,以及使用 `interpolate()` 进行动画。该技能适用于所有 Remotion 项目,特别是需要在 Studio 中进行可视化编辑的场景,如视频组合、动画和交互式演示。

兼容平台~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/Guilhermeslvg/video-portfolio/tree/HEAD/.agents/skills/remotion-interactivity

在你喜欢的 AI 中提问

打开一个已预加载此 Agent Skill 的新对话。

预览

来自技能 README

video-portfolio preview

文档

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

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

如果标记对于 Studio 来说过于复杂而无法使其交互,则这些值会变为灰色。

优先使用带有自己时间线的交互式组件

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

将属于一起的视觉效果保留在同一个组件中,以便它们一起移动和修剪。内部布局容器仍然可以提供对齐、在更小区域内裁剪,或动画组;只填充场景的容器通常是不必要的。卡片、文本框和具有自身边界的 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',
});

选择模式字段

模式中的每个键都是 Studio 可以在调用点读取和编辑的 prop。 不在模式中的 prop 仍然有效,但在 Studio 中不可编辑。 键可以使用点号表示法,例如 style.color。

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

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

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

要使根的 CSS 属性在每个实例上可编辑,请展开内置的模式片段:

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”、默认值为 '' 的字符串字段。 如果组件只需要字符串子项,请改用具有 type: 'string' 的显式 children 字段。 Interactive.textSchema 控制排版样式;childrenSchema 控制内容。 子片段不包含在 baseSchema 中,也不会自动添加到自定义组件。 嵌套标记和计算后的子项目前是只读的。 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 和时长。注册默认值不会自动从父实例复制 props。有关注册和提取详细信息,请参阅连接组合。

将时机直接放在组件上

避免在已经接受时机 props 的组件周围使用单独的 <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>:它为多个同级提供共享时机,包装不处理时机的组件,或者提供子组件无法直接接受的尺寸。管理根也接受 useVideoConfig() 的 width 和 height。对于连续布局(无论是否有过渡),保留 <TransitionSeries.Sequence>;直接的 from props 不能替代这些行为。

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

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

对于每个应该单独编辑的组合注册、剪辑、场景、图层或序列,编写一个单独的 JSX 节点,并将其可编辑 props 保留在该节点上。这适用于 <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 源节点创建多个运行时项目。这对于有意作为模板控制的重复输出(例如可视化条或粒子)是合适的。当实例在 Studio 中需要独立的 ID 或名称、props、元数据、时机、排序、删除或复制时,这不合适。

使用 Interactive 使 HTML 元素可交互

每个 HTML 和 SVG 元素(<Img> 除外,它已经是交互式的)都可以使用 Interactive 变为交互式:

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

这允许在 Studio 中设置样式和关键帧。请合理使用,如果组件有许多元素,时间线可能会变得混乱。

优先使用内联文本

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

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

仅在文本是动态或可重用时才使用 prop 或变量。

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

向元素添加 name prop 以使其易于识别。 避免使用计算名称,请硬编码。

<>
  <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({damping: 200}),
        extrapolateLeft: 'clamp',
        extrapolateRight: 'clamp'
      }
    )
  }}
>
  内容
</Interactive.Div>

Individual skills in this repo

This repo contains 5 individual skills — each has its own dedicated page.

相关技能