Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

druxt-schema

druxt887MIT0.11.3

Drupal Content Entity schema generator for Druxt with support for View and Form displays.

cms, decoupled, drupal, druxt, druxtjs, headless, jsonapi, json:api, nuxt, nuxtjs, module, schema

readme

Druxt.js Schema

npm CircleCI Known Vulnerabilities codecov

Drupal Content Entity schema generator for Druxt with support for View and Form displays.

Install

$ npm install druxt-schema

Usage

Add module to nuxt.config.js

module.exports = {
  modules: [
    ...
    'druxt-schema'
  ],

  druxt: {
    baseUrl: 'https://example.com',
    schema: {
      filter: ['node--.*?--view']
    }
  }
}

Options

Druxt options

These options are available to all Druxt 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.

Druxt Schema options

These options are specific to this module.

Option Type Required Default Description
schema.filter array No [] Array of regular expression rules to filter generated schemas.