跳到主要内容

编辑器

编辑器插件是运行时插件的扩展,它包含用于扩展编辑器界面本身的额外钩子。

Experimental
This is an experimental feature. The behavior and API may change drastically between minor releases.

让我们更新插件的入口点,使其导出一个编辑器插件。主要区别在于,我们现在使用从 @motion-canvas/ui 导入的 makeEditorPlugin 函数来定义它:

src/plugin.ts
import {makeEditorPlugin} from '@motion-canvas/ui';
import {CustomTabConfig} from './CustomTabConfig';

export default makeEditorPlugin({
name: 'editor-test',
tabs: [CustomTabConfig],
});

这使我们能够使用一些额外的钩子来扩展界面。在上面的示例中,我们使用 tabs 声明 一个自定义标签页数组,这些标签页将被添加到左侧边栏。

标签页配置从一个名为 CustomTabConfig.tsx 的新文件导入,该文件我们尚未创建。 让我们看看它可能是什么样子:

src/CustomTabConfig.tsx
/* @jsxImportSource preact */

import {
Pane,
PhotoCamera,
PluginTabConfig,
PluginTabProps,
Separator,
Tab,
} from '@motion-canvas/ui';

function TabComponent({tab}: PluginTabProps) {
return (
<Tab title="My Tab" id="custom-tab" tab={tab}>
<PhotoCamera />
</Tab>
);
}

function PaneComponent() {
return (
<Pane title="My Pane" id="custom-pane">
<Separator size={1} />
Hello <strong>World</strong>!
</Pane>
);
}

export const CustomTabConfig: PluginTabConfig = {
name: 'inspector',
tabComponent: TabComponent,
paneComponent: PaneComponent,
};

首先,编辑器构建在 Preact 之上。与 Motion Canvas 一样, Preact 使用 JSX 来定义组件。这意味着在用于扩展编辑器的 tsx 文件中,我们需要让 TypeScript 知道它应从 preact 而非 @motion-canvas/2d 导入 jsx 工厂函数。这有 多种实现方式。在这个简单的示例中,我们只在文件顶部使用一个注释:

/* @jsxImportSource preact */

接下来,我们为标签页本身定义一个组件。该组件将渲染在左侧的导航栏中。我们使用来自 @motion-canvas/ui 的 Tab 组件,以与编辑器的其余部分保持一致。我们还借用 PhotoCamera 图标并将其放入其中:

function TabComponent({tab}: PluginTabProps) {
return (
<Tab title="My Tab" id="custom-tab" tab={tab}>
<PhotoCamera />
</Tab>
);
}

类似地,我们为窗格定义一个组件,当选中该标签页时将渲染该窗格:

function PaneComponent() {
return (
<Pane title="My Pane" id="custom-pane">
<Separator size={1} />
Hello <strong>World</strong>!
</Pane>
);
}

最后,我们导出配置对象:

export const CustomTabConfig: PluginTabConfig = {
name: 'inspector',
tabComponent: TabComponent,
paneComponent: PaneComponent,
};

编辑器插件仍处于实验阶段,其 API 尚未完善文档,但如果你想试用其他一些可用的钩子, 可以查看由 @motion-canvas/2d 包提供的这个编辑器插件。它负责 显示检查器标签页,并在点击不同节点时在预览之上绘制一个覆盖层。