API Documentation
DruxtSchema
Modules
- DruxtSchema :
class
The core module functionality.
Provides methods for generating Druxt.js Schema files from the Drupal JSON:API.
- DruxtSchemaMixin :
object
Vue.js Mixin.
Adds required props and methods for lazy-loaded Schema support to custom Vue.js components.
- DruxtSchemaStore :
function
The Vuex store module.
Contains actions for interacting with and caching the generated Schema files.
- DruxtSchemaNuxtModule :
function
The Nuxt.js module function.
Installs the module functionality in a Nuxt.js frontend.
class
DruxtSchema : The core module functionality.
Provides methods for generating Druxt.js Schema files from the Drupal JSON:API.
See: DruxtSchema
Example
import { DruxtSchema } from 'druxt-schema'
const druxtSchema = new DruxtSchema('https://example.com', {})
object
DruxtSchemaMixin : Vue.js Mixin.
Adds required props and methods for lazy-loaded Schema support to custom Vue.js components.
See: DruxtSchemaMixin
Example
<script>
import { DruxtSchemaMixin } from 'druxt-schema'
export default {
mixins: [DruxtSchemaMixin]
}
</script>
function
DruxtSchemaStore : The Vuex store module.
Contains actions for interacting with and caching the generated Schema files.
See: DruxtSchemaStore
function
DruxtSchemaNuxtModule : The Nuxt.js module function.
Installs the module functionality in a Nuxt.js frontend.
See: DruxtSchemaNuxtModule
Example (nuxt.config.js)
module.exports = {
modules: [
'druxt-schema'
],
druxt: {
baseUrl: 'https://example.com'
}
}