Skip to content

Documentation / @ripl/vue / createRipl

Function: createRipl() ​

createRipl(): Plugin

Defined in: adapters/vue/src/plugin.ts:71

Creates the Vue plugin that registers every Ripl component globally, so templates can use <ripl-circle> and <RiplCircle> without importing them.

Components can equally be imported one at a time; the plugin is a convenience, not a requirement. Applying it more than once, directly or through a sibling adapter's plugin, is a no-op.

Returns ​

Plugin

A plugin to pass to app.use().

Example ​

ts
import { createRipl } from '@ripl/vue';

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