Documentation / @ripl/vue-3d / createRipl3D

Function: createRipl3D()

createRipl3D(): Plugin

Defined in: vue-3d/src/plugin.ts:82

Creates the Vue plugin that registers every Ripl 3D component globally, along with the core components from @ripl/vue that a 3D scene needs — <ripl-scene>, <ripl-renderer> and <ripl-transition>.

Applying createRipl() as well, in either order, is harmless: a name already registered is skipped rather than re-registered.

Returns

Plugin

A plugin to pass to app.use().

Example

import { createRipl3D } from '@ripl/vue-3d';

createApp(App).use(createRipl3D()).mount('#app');