storyblok-nuxt
Storyblok Nuxt.js module
Features
The module features
Setup
- Add
axios
dependency as it's a peer dependecy of thestoryblok-js-client
used bystoryblok-nuxt
- Add
storyblok-nuxt
dependency using yarn or npm to your project - Add
storyblok-nuxt
tomodules
section ofnuxt.config.js
{
modules: [
['storyblok-nuxt', {
accessToken: 'YOUR_PREVIEW_TOKEN',
cacheProvider: 'memory'
}],
]
}
Usage
This module adds two objects to the the Nuxt.js context.
- $storyapi: The Storyblok API client.
- $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 })
}
})
}
}
Checkout the following boilerplate to see an example setup: https://github.com/storyblok/vue-nuxt-boilerplate
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.
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
Copyright (c) Storyblok it@storyblok.com