storyblok-nuxt-routes

Uses the Storyblok JS client to get all stories and add them as routes for nuxt generate.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
storyblok-nuxt-routes
581.3.0-beta.42 years ago5 years agoMinified + gzip package size for storyblok-nuxt-routes in KB

Readme

storyblok-nuxt-routes
Uses the Storyblok JS Client to get all stories and add them as routes for nuxt generate.

NPM Version NPM Downloads GitHub license

Setup

  • Add storyblok-nuxt-routes dev dependency using yarn or npm to your project
  • Add storyblok-nuxt-routes to buildModules section of nuxt.config.js

{
  buildModules: [
    ['storyblok-nuxt-routes', {
      accessToken: 'YOUR_ACCESS_TOKEN',
      defaultLanguage: 'YOUR_DEFAULT_LANGUAGE', // optional
      contentTypes: 'YOUR_CONTENT_TYPES_NUXT_SHOULD_GENERATE_ROUTES_FOR', // optional
      resolveLinks: 'url', // optional
      resolveRelations: 'page.author', // optional
      exclude: [], // optional
      routeRealPath: true, // optional
      excludingFields: 'title,content' // optional
    }],
  ]
}

Options

accessToken

Your access token.

defaultLanguage

Your default language code.
Optional. If you have multiple languages, set defaultLanguage to the key of your Storyblok default language.

contentTypes

Your content types nuxt should generate routes for.

resolveLinks

The parameter resolveLinks will automatically resolve internal links of the multilink field type. If the value is story the whole story object will be included. If the value is url only uuid, id, name, path, slug, fullslug and url will be included.

resolveRelations

The parameter resolveRelations will automatically resolve relationships to other Stories of a multi-option or single-option field-type. Provide the component name and the field key as comma separated string. The limit of resolved relationships is 100 Stories. Example: resolveRelations: 'page.author,page.categories'

exclude

It accepts an array of string and will prevent generation of routes matching them.

routeRealPath

Boolean, default false
If true, Nuxt routes will be generated using the Stories Real Path configuration, instead of the default path. This can be useful for example to generate a Story with path of / instead of /home.
See https://www.storyblok.com/cl/real-path-added-to-content-delivery-api

excludingFields

Exclude specific fields of your content type by comma seperated names. Example: excluding
fields=title,content

Usage

nuxt.config.js

export default {
  buildModules: [
    ['storyblok-nuxt-routes', {
      accessToken: '<YOUR_ACCESS_TOKEN>',
      defaultLanguage: 'en',
      contentTypes: 'page,news',
      resolveLinks: 'url',
      resolveRelations: 'page.author',
      exclude: [ '^\/admin' ] ,
      routeRealPath: true
    }]
  ],
  generate: {
    fallback: true,
    interval: 100
  }
}

Now we can access the payload inside pages/.vue like so:

async asyncData ({ route, payload, app }) {
  if (payload) {
    return { story: payload }
  } else {
    const res = await app.$storyapi.get(`cdn/stories${route.path}`)
    return res.data
  }
}

License

MIT License
Copyright (c) Heiko Pfahl