Configuration

You can configure @cusy/plone-nuxt with the plone property in your nuxt.config.js or directly when registering the module in the buildModules array by using the array syntax.

export default {
  plone: {
    /* configuration */
  }
}

export default {
  buildModules: {
    ['@cusy/plone-nuxt', {
      /* configuration */
    }]
  }
}

Properties

url

• Type: String
• required

The endpoint of your Plone API which will be used as a base for all queries. This can either be the root of your Plone site or a subfolder.

plone: {
  // Getting content from the local Plone site named `my-site`
  url: 'http://localhost:8080/my-site'
}

languages

• Type: Array
• Default: []

Language configuration when using the plone.app.multilingual add-on in Plone.

If your Plone site is configured with multiple languages using the plone.app.multilingual add-on, add all the languages your Nuxt project should support. Note that your Plone site can be configured with more languages than you use in your Nuxt project.

If you don’t use multiple languages in your Plone site, leave this list empty.

plone: {
  // Enable english and french
  languages: ['en', 'fr']
}

missingLanguagesAllowed

• Type: Array
• Default: []

A list of languages which are allowed to be missing on the Plone site.

This has no effect if missingLanguagesError is set to false.

plone: {
  // Enable english, french and german
  languages: ['en', 'fr', 'de'],
  // German might not be available right now, but this is ok.
  missingLanguagesAllowed: ['de']
}

missingLanguagesError

• Type: Boolean
• Default: true

When enabled, the provided generator will throw an error when one of the configured languages is not available on the Plone site.

This is a safeguard for the case your Nuxt.js site is rebuild, but your Plone site is missing a required language. This will stop your build.

plone: {
  // Enable english, french and german
  languages: ['en', 'fr', 'de'],
  // Don’t throw an error when a language is missing on the Plone site
  missingLanguagesError: false
}

updateSitemap

• Type: Boolean
• Default: false

If you are using the sitemap module for Nuxt, you can enable updateSitemap to enhance the information of the individual Plone routes.

By default the sitemap module will take the (dynamic) routes defined in the generate property along with the static routes provided by the Nuxt crawler. The dynamic routes will only contain the url, not the payload the Plone generator provides. So there is no information available about e.g. the last modification date of an item.

When enabling updateSitemap, the Plone generator will add additional information to the dynamic Plone routes:

• lastmod with the item’s last modification date
• set changefreq to daily for collection like content

plone: {
  // Enable sitemap update
  updateSitemap: true
},
sitemap: {
  // No sitemap build caching.
  cacheTime: -1,

  // Set defaults for all sitemap entries.
  // The Plone module will adjust those for dynamic items.
  defaults: {
    changefreq: 'weekly',
    // Use the current date for static content items
    lastmod: new Date(),
  },
},

disableGenerator

• Type: Boolean
• Default: false

This module is providing a crawler feature (generator) that will crawl your Plone site and extend the Nuxt.js generate.routes array (see Nuxt.js documentation about the routes property) with routes to those.

Since version 2.13 Nuxt.js is shipped with a built-in crawler, so this module's generator feature might not be neccessary. If you have Plone content which is hidden from navigation and only linked from within other Plone content, the Nuxt crawler might not be able to find those. If you are in doubt, keep the Plone generator enabled.

plone: {
  // disable module's genrator
  disableGenerator: true
}

nuxtImage (beta)

• Type: Boolean
• Default: false

With the nuxt image module we get a plug-and-play image optimization solution for nuxt projects. If the module is installed and nuxtImage enabled in the Plone module settings, images within RichText fields will be processed and delivered from within nuxt instead of the Plone site. This is especially usefull when the site is generated with the static target, as then no additional requests have to be made to the Plone backend.

Defaults

The default configuration only expects you to provide your Plone API endpoint.

export default {
  plone: {
    disableGenerator: false,
    languages: [],
    missingLanguagesAllowed: [],
    missingLanguagesError: true,
    nuxtImage: false,
    updateSitemap: false
  }
}