druxt-schema

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

Usage no npm install needed!

<script type="module">
  import druxtSchema from 'https://cdn.skypack.dev/druxt-schema';
</script>

README

Druxt.js Schema

npm CircleCI Known Vulnerabilities codecov

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

Links

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.