createPlugin API

API reference for the createPlugin composable.

Explore these related pages for additional context and usage patterns.

Page	Category
createPlugin	Foundation
createContext	Foundation
createTrinity	Foundation
Plugins	Fundamentals

Functions

createPlugin

(options: PluginOptions) => Z

Creates a new Vue plugin.

createPluginContext

(defaultNamespace: string, factory: (options: Omit<O, "namespace" | "persist">) => E, config?: PluginContextConfig<Omit<O, "namespace" | "persist">, E> | undefined) => readonly [<_E extends E = E>(_options?: O) => ContextTrinity<_E>, (_options?: O) => Plugin, <_E extends E = E>(namespace?: string) => _E]

Creates the three standard functions for a plugin composable.

Options

namespace required

string

provide required

(app: App) => void

setup

((app: App) => void) | undefined