Skip to main content
Version: 1.x

Plugin

Type: interface

Props#

ID#

A string used to identify the plugin.

ROLE#

An optional PluginRole.

default#

A Svelte component that accepts a player prop.

Example#

This is a Svelte component that compiles into a valid Plugin.

<div></div>
<script context="module">
import { PluginRole } from '@vime-js/complete';
export const ID = 'myPluginId';
// Optional.
export const ROLE = PluginRole.POSTER;
</script>
<script>
export let player;
// ...
</script>