Communitygithub.com

jeffersonmendo/remotion-tryslides

以特定方式編寫 Remotion 標記,使其能被 Remotion Studio 識別並實現互動功能。

remotion-tryslides 是什麼?

此技能(Skill)旨在指導開發者如何結構化 Remotion 專案中的 JSX 標記,以充分利用 Remotion Studio 的互動編輯功能。透過遵循其規範,您可以使影片中的元素可選取、拖放、調整大小、旋轉,並直接在 Studio 中編輯 CSS 樣式、關鍵影格和緩動函數。該技能支援所有 Remotion 平台(如 Remotion Studio),其核心機制是透過 `Interactive.create()` 建立可互動元件,並使用 `Track`、`Composition` 等 API 來組織時間軸。此外,它還提供了詳細的 Schema 欄位指南,定義了哪些屬性(如 `string`、`number`、`color`)可被編輯及支援關鍵影格,並強調將所有 CSS 樣式和動畫(如 `interpolate()`)內聯在 JSX 中以維持互動性。總而言之,這項技能是讓 Remotion 專案從靜態程式碼轉變為動態、可視覺化編輯影片的關鍵最佳實踐集合。

相容平台~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/jeffersonmendo/remotion-tryslides/tree/HEAD/.agents/skills/remotion-interactivity

在你喜歡的 AI 中提問

開啟一個已預先載入此 Agent Skill 的新對話。

預覽

來自技能 README

remotion-tryslides preview

說明文件

透過以特定方式編寫 Remotion 標記,Remotion Studio 能夠識別程式碼的結構並使其具有互動性:

  • 允許點擊選取項目
  • 允許拖放、調整大小和旋轉
  • 編輯 CSS 樣式
  • 讓關鍵影格和緩動值可編輯

如果標記過於複雜而 Studio 無法使其互動,則這些值會變成灰色顯示。

偏好使用具有自身時間軸的互動元件

使用 Track、已連接的 Composition 以及 Interactive.create() 來建構新的 Composition。

明確設定 layout 為 'absolute-fill'(用於場景)或 'none'(用於有邊界的元素)。使用 Composition 註冊相同的匯出場景和可重複使用的元件。

從完整的 Track + connected compositions 範例 開始。 它包含了元素、場景、父時間軸和根註冊。

import {Track, useVideoConfig} from 'remotion';
import {Chapter} from './Chapter';

export const MyVideo = () => {
  const {fps} = useVideoConfig();

  return (
    <Track name="Chapters">
      <Chapter
        name="Opening"
        durationInFrames={3 * fps}
        title="Introduction"
      />
      <Chapter
        name="Feature"
        from={3 * fps}
        durationInFrames={4 * fps}
        title="New features"
      />
    </Track>
  );
};

如完整範例所示,將背景和對齊樣式放在每個場景實例上。將僅用於佈局的容器保留為純 HTML。

選擇 Schema 欄位

Schema 中的每個鍵都是一個 prop,Studio 可以在呼叫點讀取和編輯它。 不在 schema 中的 prop 仍然可以運作,但在 Studio 中不可編輯。 鍵可以使用點記號,例如 style.color。

類型用途可設定關鍵影格
string字串,例如標題、提示或程式碼片段否
number數字,可選用 min、max、step、integer是
boolean開/關切換是 (按住)
colorCSS 顏色字串是
enum在 variants 之間選擇,每個選項都有自己的巢狀 schema選擇性加入 (按住)
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 以顯示靜態控制項。

暴露內容和每個實例的外觀,例如文字和強調色。\n不要為 style.translate、style.scale、style.rotate、style.transformOrigin 和 style.opacity 新增欄位:Interactive.create() 會自動新增它們。

要使根元素的 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 children 的元件,請新增 ...Interactive.childrenSchema。 它為 children 內容提供了控制項,並可能發展為支援更豐富的內容。 目前,它使用一個標籤為「Text」的字串欄位,預設值為 ''。 如果元件只需要字串類型的 children,請改用 type: 'string' 宣告一個明確的 children 欄位。 Interactive.textSchema 控制排版樣式;childrenSchema 控制內容。 children 片段不包含在 baseSchema 中,也不會自動新增到自訂元件。 巢狀標記和計算後的 children 目前是唯讀的。 text-content 是 string 欄位類型的已棄用別名。 有關所有選項,請參閱 InteractivitySchema。

將可重複使用的元件註冊為已連接的 Composition

將場景和可重複使用的元件註冊為獨立的 Composition。Studio 稱這些為 已連接的 Composition:它們可以在自己的時間軸中開啟,同時與父影片共用同一個元件實作。

在元件內部定義必要的樣式和載入字型,使其能夠在沒有父元件的環境下獨立運作。請參閱 父元件獨立性。

註冊父元件所渲染的相同匯出元件參考。對於上面的範例,請使用 component={Chapter},而不是 ChapterInner 或內聯包裝器。 Interactive.create() 提供了序列,因此不需要額外的 <Sequence> 來建立連線。

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

export const RemotionRoot = () => (
  <Composition
    id="Chapter"
    component={Chapter}
    width={1280}
    height={720}
    fps={30}
    durationInFrames={90}
    defaultProps={{
      title: 'A new perspective',
      style: {
        backgroundColor: '#111111',
        justifyContent: 'center',
        alignItems: 'center',
      },
    }}
  />
);

選擇一個唯一的 ID、具代表性的內聯預設值,以及適合預覽元件的尺寸、fps 和 持續時間。註冊預設值不會自動從父實例複製 props。請參閱 已連接的 Composition,以了解 註冊和提取的詳細資訊。

將時間直接放在元件上

避免在一個已經接受時間 props 的元件周圍使用單獨的 <Sequence>。 內建的互動元件和使用 Interactive.create() 製作的自訂元件可以直接接收 name、from、durationInFrames、 trimBefore 和 playbackRate。

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

對於共用的場景時間,將內容分組到一個使用 Interactive.create() 製作的元件中,並為該實例設定時間。管理的根元素也接受 width 和 height 以供 useVideoConfig() 使用。

使用 <Track> 將項目放在同一個 Studio 時間軸行上。 當場景是順序播放時,使用 <TransitionSeries>。

為每個可獨立編輯的項目提供其自己的 JSX 節點

Studio 編輯的是建立項目的 JSX 原始碼節點。如果多個執行時期項目來自同一個 JSX 節點,它們將共用一個原始碼編輯目標。

對於每個 Composition 註冊、剪輯、場景、圖層或序列(應該獨立編輯的),撰寫一個單獨的 JSX 節點,並將其可編輯的 props 保留在該節點上。這適用於 <Composition>、<Still>、內建媒體 元件、<Sequence>、<TransitionSeries.Sequence> 和自訂元件。

例如,撰寫一個如下所示的可編輯時間軸:

import { Track } from "remotion";

<Track name="Scenes">
  <Introduction name="Introduction" durationInFrames={90} />
  <Demo name="Demo" from={90} durationInFrames={150} />
</Track>

使用 .map() 或其他程式化迴圈會從一個 JSX 原始碼節點建立多個執行時期項目。 這適用於刻意作為一個模板控制的重複輸出,例如視覺化長條圖或 粒子。但當實例需要獨立的 ID 或 名稱、props、元資料、時間、排序、刪除或複製(在 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>

僅在文字是動態或可重複使用時才使用 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}),
        output: 'perceptual-scale',
        extrapolateLeft: 'clamp',
        extrapolateRight: 'clamp'
      }
    ),
  }}
/>
const translateY = interpolate(frame, [0, 30], [0, 120]); // ❌ 數學運算應直接在標記中

<Interactive.Div
  name="Product card"
  style={{
    translate: translateY, // ❌ 僅支援內聯的 interpolate() 呼叫,
    rotate: interpolate(frame, [start, start + 10], [0, Math.PI]), // ❌ 不能使用帶有任意變數的數學運算,不能使用常數
    scale: interpolate(anyVariable, [0, 30], [0, 1]) // ❌ 只能解譯 `frame` 變數。
  }}
/>

使用 Interactive.Path 保持 SVG 路徑可編輯

使用 remotion 中的 <Interactive.Path> 而不是 SVG 內部的 <path>,使路徑在視覺上可編輯。

為路徑插值和 Studio 路徑關鍵影格安裝 @remotion/paths:

bunx remotion add @remotion/paths

如果幾何形狀是靜態的,請將路徑字串直接放在 d prop 中。不要將其提取為常數。

import {Interactive} from 'remotion';

<Interactive.Svg width={300} height={300} viewBox="0 0 300 300">
  <Interactive.Path
    name="Triangle"
    d="M 40 40 L 260 40 L 150 260 Z"
    fill="#0b84f3"
  />
</Interactive.Svg>

使用內聯路徑變形

...(此處原始內容截斷)

Individual skills in this repo

This repo contains 1 individual skill — each has its own dedicated page.

相關技能