Version: 1.x

Boot

ID: vBoot | Type: Plugin

This plugin installs the following plugins:

Setup#

import { Player, Boot } from '@vime-js/complete';
// ...
const player = new Player({
target,
props: {
plugins: [Boot]
}
});

Props#

manifest#

Type: { [id]: boolean } | Default: All plugins default to true.

The manifest determines which plugins should be installed. All plugins are identified by their ID with the v prefix removed and first letter lowercased.

  • vControls = controls
  • vActionDisplay = actionDisplay
  • vClickToPlay = clickToPlay
import { Player, Boot } from '@vime-js/complete';
const target = document.getElementById('player-target');
const player = new Player({
target,
props: {
plugins: [Boot]
}
});
const off = player.$on('mount', () => {
player.vBoot.manifest = {
controls: false,
actionDisplay: false,
clickToPlay: false
};
});