nuxtjs-drupal-ce

nuxtjs-drupal-ce - Nuxt.js Drupal Custom Elements Connector

Connects Nuxt.js with Drupal via the Lupus Custom Elements Renderer

Please refer to https://stack.lupus.digital for more info.

📖 Release Notes

Pre-requisites

• A Drupal backend with the Lupus Custom Elements Renderer module installed.

Setup

• Add nuxtjs-drupal-ce dependency to your Nuxt project

yarn add nuxtjs-drupal-ce@alpha # or npm install nuxtjs-drupal-ce@alpha

• Add nuxtjs-drupal-ce to the modules section of nuxt.config.js

export default defineNuxtConfig({
  modules: [
    'nuxtjs-drupal-ce',
  ],
  drupalCe: {
    baseURL: 'https://your-drupal.example.com/ce-api',
    // more options...
  }
})

Options

• baseURL: The Drupal base URL. Defaults to the DRUPAL_BASE_URL environment variable if provided, otherwise to http://localhost:8888.

• menuEndpoint: The menu endpoint pattern used for fetching menus. Defaults to 'api/menu_items/$$$NAME$$$' as fitting to the API provided by the Rest menu items Drupal module. $$$NAME$$$ is replaced by the menu name being fetched.

• addRequestContentFormat: If specified, the given value is added as _content_format URL parameter to requests. Disabled by default.

• customErrorPages: By default, error pages provided by Drupal (e.g. 403, 404 page) are shown, while keeping the right status code. By enabling customErrorPages, the regular Nuxt error pages are shown instead, such that the pages can be customized with Nuxt. Defaults to false.

TODO list of options (not yet implemented)

• addRequestFormat: If set to true, the _format=custom_elements URL parameter is added automatically to requests. Defaults to true.

• useLocalizedMenuEndpoint: If enabled, the menu endpoint will use a language prefix as configured by nuxtjs/i18n module. Defaults to true.

• useProxy: If set to dev-only and nuxt is in dev-mode, the module automatically configures /api to the Drupal backend via @nuxtjs/proxy and uses it instead of the Drupal backend, such that there are no CORS issues. Other values supported are always or false. Note: When using always the module must be added to the nuxt modules section instead of the buildModules section.

• pageErrorHandler: The default page error handler can be overridden.

• menuErrorHandler: The default menu error handler can be overridden.

Options not supported in 2.x version

• addVueCompiler: This is necessary if you want to render custom elements markup on runtime. If you need this, you may find a solution in this GitHub issue.

• axios: Options to pass-through to the drupal-ce axios instance.

Development

• Clone this repository.
• Install dependencies using npm install.
• Run npm run dev:prepare to generate type stubs.
• Use npm run dev to start playground in development mode.
• Update baseURL setting in Nuxt config with Lupus Decoupled Drupal instance URL and append the API-prefix /ce-api, e.g. https://8080-shaal-drupalpod-8m3z0ms7mb6.ws-eu67.gitpod.io/ce-api

Run on StackBlitz

• Launch it on StackBlitz
• Update baseURL setting in Nuxt config with Lupus Decoupled Drupal instance URL and append the API-prefix /ce-api, e.g. https://8080-shaal-drupalpod-8m3z0ms7mb6.ws-eu67.gitpod.io/ce-api

License

MIT License

Credits

Development sponsored by drunomics [e-mail]