DruxtRouter

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

DruxtRouter connects Nuxt routing to Drupal routing. A wildcard route catches requests, resolves them through Drupal's Decoupled Router with path aliases and redirects included, and renders the matching Druxt component for the resolved entity or view. Your Nuxt pages/ directory keeps working alongside it, so a custom page can take over any route.

Features

• Vue.js components:
  • DruxtRouter renders a Druxt component for the resolved Decoupled route
• Route providers:
  • Content entity routes resolve DruxtEntity components
  • Drupal Views page routes resolve DruxtView components

Installation

Included with druxt-site. Install it separately only when composing modules yourself.

1. Install the package:

   npm i druxt-router

2. Add the module to nuxt.config.js:

   export default {
     modules: ['druxt-router/nuxt'],
   };

Options

• druxt.router.middleware

  Type: boolean
  Default: true

  Controls whether to execute the Route page middleware and process redirects.

• druxt.router.pages

  Type: boolean
  Default: true if pages/ directory exists, else false

  Controls whether the Nuxt pages/ directory is used to generate routes.

• druxt.router.wildcard

  Type: boolean
  Default: true

  Controls whether the wildcard route should be installed into the Nuxt/Vue router.

Development releases

Every change merged to develop is published under the dev tag:

npm i druxt-router@dev

These are unreleased builds. See development releases before using one.

Vue.js components

DruxtRouter

Renders a Druxt module router component based on the resolved route provided by the Drupal Decoupled Router module.

<DruxtRouter path="/" />

If no Path is provided, the component will default to the Vue router fullpath.

• For more details, refer to the DruxtRouter API documentation.

Deprecations

Retired DruxtRouter client pass-through methods and druxtRouter store resource members, with their replacements, are listed on the deprecations page.

• For the routing API itself, see the DruxtRouter API documentation.

Options

Druxt Router options

These options are specific to this module.

| Option | Type | Required | Default | Description | | ------------------- | --------- | -------- | --------------------------- | ------------------------------------------------------- | | router.middleware | boolean | No | true | Whether to run the Route page middleware and redirects. | | router.pages | boolean | No | true if pages/ exists | Whether to parse the Nuxt pages/ directory. | | router.wildcard | boolean | No | true | Whether to install the wildcard route. |

Base Druxt options

These options are available to all DruxtJS modules.

| Option | Type | Required | Default | Description | | ---------- | -------- | -------- | ---------- | ---------------------------------------------------------------------------- | | axios | object | No | {} | Axios instance settings. | | baseUrl | string | Yes | null | Base URL for the Drupal installation. | | endpoint | string | No | /jsonapi | JSON:API Endpoint of the Drupal installation. |

Links

• DruxtJS: https://druxtjs.org
• Documentation: https://druxtjs.org/modules/router
• Community Discord server: https://discord.druxtjs.org