Skip to content
druxt-router

Router

Drupal router for Nuxt, powered by the Drupal Decoupled Router module.

DruxtJS Router

CI Known Vulnerabilities codecov

Drupal router for Nuxt, powered by the Drupal Decoupled Router module.

Features

  • Nuxt.js module with out of the box page routing: druxt-router
  • Vuex store: druxtRouter
  • Vue component: <DruxtRouter />
  • Vue mixin: DruxtRouterEntityMixin

Install

$ npm install druxt-router

Usage

Add module to nuxt.config.js

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

Options

Druxt Router options

These options are specific to this module.

OptionTypeRequiredDefaultDescription
router.pagesbooleanNotrueWhether to parse the Nuxt pages/ directory.
router.wildcardbooleanNotrueWhether to install the wildcard route.

Base Druxt options

These options are available to all DruxtJS modules.

OptionTypeRequiredDefaultDescription
axiosobjectNo{}Axios instance settings.
baseUrlstringYesnullBase URL for the Drupal installation.
endpointstringNo/jsonapiJSON:API Endpoint of the Drupal installation.

Note: The contents of this file were automatically generated from the packages/router/README.md.