Skip to content
druxt-schema

Schema

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

Druxt.js Schema

npm CI 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.

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

Druxt Schema options

These options are specific to this module.

OptionTypeRequiredDefaultDescription
schema.filterarrayNo[]Array of regular expression rules to filter generated schemas.

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