storyblok-nuxt

Nuxt module for the Storyblok, Headless CMS.

Getting Started

If you are first-time user of the Storyblok, read Nuxt Getting Started guide at Storyblok website.

Setup

• Add axios dependency as it's a peer dependecy of the storyblok-js-client used by storyblok-nuxt
• Add storyblok-nuxt dependency using yarn or npm to your project
• Add storyblok-nuxt to modules section of nuxt.config.js

Installation

npm install --save-dev nuxt-storyblok axios
// yarn add nuxt-storyblok axios

Hint: You don't have to install Axios if you already installed Axios module of Nuxt.

Add following code to modules section of config.nuxt.js and replace the accessToken with API token from Storyblok space.

{
  modules: [
    ['storyblok-nuxt', {
      accessToken: 'YOUR_PREVIEW_TOKEN',
      cacheProvider: 'memory'
    }],
 ]
}

Initialize with a proxy server

Add following lines for general proxy configuration:

{
  modules: [
    ['storyblok-nuxt', {
      ...
      proxy: {
        host: host,
        port: port,
      },
    }],
 ]
}

The following lines will add authentication:

{
  modules: [
    ['storyblok-nuxt', {
      ...
      proxy: {
        ...
        auth: {
            username: 'foo',
            password: 'bar',
        },
      },
    }],
 ]
}

Add these lines to use https-proxy-agent

{
  modules: [
    ['storyblok-nuxt', {
      ...
      proxy: {
        ...
      },
      useHttpsAgent: true,
    }],
 ]
}

Usage

This module adds two objects to the the Nuxt.js context.

1. $storyapi: The Storyblok API client.
2. $storybridge: A loader for the Storyblok JS bridge that is responsible for adding the editing interface to your website.

Example of fetching data of the homepage and listening to the change events of the JS bridge:

export default {
  data () {
    return {
      story: { content: {} }
    }
  },
  mounted () {
    this.$storybridge(() => {
      const storyblokInstance = new StoryblokBridge()

      storyblokInstance.on(['input', 'published', 'change'], (event) => {
        if (event.action == 'input') {
          if (event.story.id === this.story.id) {
            this.story.content = event.story.content
          }
        } else {
          window.location.reload()
        }
      })
    }, (error) => {
      console.error(error)
    })
  },
  asyncData (context) {
    return context.app.$storyapi.get('cdn/stories/home', {
      version: 'draft'
    }).then((res) => {
      return res.data
    }).catch((res) => {
      if (!res.response) {
        console.error(res)
        context.error({ statusCode: 404, message: 'Failed to receive content form api' })
      } else {
        console.error(res.response.data)
        context.error({ statusCode: res.response.status, message: res.response.data })
      }
    })
  }
}

Hint: Find out more how to use Nuxt together with Storyblok in Nuxt Technology Hub

API

Like described above, this package includes two objects into Nuxt.js context:

$storyapi

This object is a instance of StoryblokClient. You can check the documentation about StoryblokClient in the repository: https://github.com/storyblok/storyblok-js-client

$storybridge(successCallback, errorCallback)

You can use this object to load the Storyblok JS Bridge. In the success callback you will it have available in the window variable StoryblokBridge.

Migrate from 1.x to 2.x

Listening to Visual Editor events in 1.x

Most of our tutorials and recordings still using following deprecated approach for real-time editing and listening to Storyblok's Visual Editor events. This approach can be used only with 1.x version of the storyblok-nuxt.

export default {
  mounted () {
    // Use the input event for instant update of content
    this.$storybridge.on('input', (event) => {
      if (event.story.id === this.story.id) {
        this.story.content = event.story.content
      }
    })
    // Use the bridge to listen the events
    this.$storybridge.on(['published', 'change'], (event) => {
      this.$nuxt.$router.go({
        path: this.$nuxt.$router.currentRoute,
        force: true,
      })
    })
  }
}

Listening to Visual Editor events in 2.x

The recommended approach for 2.x storyblok-nuxt plugin.

export default {
  mounted () {
    this.$storybridge(() => {
      const storyblokInstance = new StoryblokBridge()

      storyblokInstance.on(['input', 'published', 'change'], (event) => {
        if (event.action == 'input') {
          if (event.story.id === this.story.id) {
            this.story.content = event.story.content
          }
        } else {
          this.$nuxt.$router.go({
            path: this.$nuxt.$router.currentRoute,
            force: true,
          })
        }
      })
    }, (error) => {
      console.error(error)
    })
  }
}

Contribution

Fork me on Github.

This project use semantic-release for generate new versions by using commit messages and we use the Angular Convention to naming the commits. Check this question about it in semantic-release FAQ.

License

MIT License

Copyright (c) Storyblok [email protected]