Plugins

You may add additional features to the Vuex ORM through plugins. Plugins usually add global-level functionality to Vuex ORM. Vuex ORM plugin works very similar to Vue Plugin.

Available Plugins

Here is the list of available plugins.

• Vuex ORM Axios – A plugin to sync the store against a RESTful API.
• Vuex ORM GraphQL – A plugin to sync the store against a GraphQL API.
• Vuex ORM Search – This plugin adds a search() method to filter records using fuzzy search logic from the Fuse.js.
• Vuex ORM Change Flags - Vuex ORM plugin for adding IsDirty / IsNew flags to model entities.
• Vuex ORM Soft Delete – Vuex ORM plugin for adding soft delete feature to model entities.

Writing a Plugin

A Vuex ORM plugin should be an object that exposes an install method. The method will be called with the Vuex ORM components such as Model, Repo, Query and such, as the first argument, along with possible options.

const plugin = {
  // `components` contains Vuex ORM objects such as Model and Query.
  // The plugin author can then extend those objects to add
  // whatever features it needs.
  install (components, options) {
    // Add global (static) method or property.
    components.Model.globalMethod = function () {
      // Logic...
    }

    // Add an instance method or property.
    components.Query.prototype.instanceMethod = function () {
      // Logic...
    }
  }
}

Extendable Components

The following components are included within the components argument.

• Model
• Database
• Query
• Attribute
• Type
• Attr
• String
• Number
• Boolean
• Uid
• Relation
• HasOne
• BelongsTo
• HasMany
• HasManyBy
• BelongsToMany
• HasManyThrough
• MorphTo
• MorphOne
• MorphMany
• MorphToMany
• MorphedByMany
• Getters
• RootGetters
• Actions
• RootActions
• RootMutations

Using a Plugin

Use plugins by calling the VuexORM.use() method.

import VuexORM from '@vuex-orm/core'
import plugin from 'vuex-orm-plugin'

VuexORM.use(plugin)

You can optionally pass in some options too.

VuexORM.use(plugin, { someOption: true })