API Documentation

DruxtSchemaMixin

schema

Mixins

DruxtSchemaMixin

Lazy loads a schema into the Vuex State object.

Functions

getSchema()

Maps druxtSchema/get Vuex action to this.getSchema.

DruxtSchemaMixin

Lazy loads a schema into the Vuex State object.

Kind: global mixin
Example

<script>
import { DruxtSchemaMixin } from 'druxt-schema'
export default {
  mixins: [DruxtSchemaMixin],
}
</script>

.props

Kind: static property of DruxtSchemaMixin


.mode : string

The Drupal Display mode.

Kind: static property of props
Default: "default"


.schemaType : 'view' | 'form'

Drupal display schema type, 'view' or 'form'.

Kind: static property of props


.type : string

The JSON:API Resource type.

Kind: static property of props


.methods

Kind: static property of DruxtSchemaMixin


.fetch()

Loads the Schema from the Vuex store.

Kind: static method of DruxtSchemaMixin


.data()

Kind: static method of DruxtSchemaMixin
Properties

NameTypeDescription
schemaobjectThe Drupal Schema data.

getSchema()

Maps druxtSchema/get Vuex action to this.getSchema.

Kind: global function