vixt / core/client / defineVixtPlugin

defineVixtPlugin()

defineVixtPlugin(definition): VixtPlugin

A helper function for creating Vixt plugins.

Parameters

definition

PluginDefinition | VixtPlugin

Returns

VixtPlugin

Example

// src/plugins/my-plugin.ts
interface PluginOptions {
  enabled?: boolean
}

declare module '@vixt/core/client' {
  interface VixtAppConfig {
    myPlugin?: PluginOptions
  }
}

export default defineVixtPlugin<PluginOptions>({
  name: 'my-plugin',
  setup(vixt) {
    console.log(vixt) // { app, router, routes, pinia, appConfig }
  }
})