Skip to content
DruxtJS DruxtJS

The core module, DruxtClient, DruxtStore and the DruxtModule base component.

DruxtNuxtModule

View source on GitHub

Functions

DruxtNuxtModule(moduleOptions)

Nuxt module function to install Druxt.

Typedefs

ModuleOptions : object

Module options object.

DruxtNuxtModule(moduleOptions)

Nuxt module function to install Druxt.

Kind: global function

ParamTypeDescription
moduleOptionsModuleOptionsDruxtJS module options.

Example (Nuxt configuration with module options)

module.exports = {
  modules: [
    ['druxt', { baseUrl: 'https://demo-api.druxtjs.org' }]
  ]
}

Example (Nuxt configuration with root level options)

module.exports = {
  modules: [
    'druxt'
  ],
  druxt: {
    baseUrl: 'https://demo-api.druxtjs.org'
  }
}

ModuleOptions : object

Module options object.

Kind: global typedef
Properties

NameTypeDefaultDescription
baseUrlstringThe Base URL of the Drupal JSON:API backend.
[endpoint]string"/jsonapi"The JSON:API endpoint path.
[proxy]objectProxy settings object.
[proxy.api]booleanProxy the JSON:API.
[proxy.files]boolean | stringProxy Drupal's site files directory. Provide String to specify multi-site path.

Example

export default {
  modules: ['druxt'],
  druxt: {
    baseUrl: 'https://demo-api.druxtjs.org',
    endpoint: '/jsonapi',
    proxy: {
      api: true,
      files: 'default'
    }
  }
}