@storyblok/astro v7.0.0
Kickstart a new project
Are you eager to dive into coding? Follow these steps to kickstart a new project with Storyblok and Astro, and get started in just a few minutes!
Ultimate Tutorial
Are you looking for a hands-on, step-by-step tutorial? The Astro Ultimate Tutorial has you covered! It provides comprehensive instructions on building a complete, multilingual website using Storyblok and Astro from start to finish.
Installation
Install @storyblok/astro
:
npm install @storyblok/astro
# yarn add @storyblok/astro
# See below for pnpm
!NOTE
With pnpm, hoist Storyblok dependencies publicly with.npmrc
. For more information, please refer to the pnpm documentation.
Add the following code to astro.config.mjs
and replace the accessToken
with the preview API token of your Storyblok space.
import { defineConfig } from "astro/config";
import { storyblok } from "@storyblok/astro";
export default defineConfig({
integrations: [
storyblok({
accessToken: "<your-access-token>",
}),
],
});
!WARNING This SDK uses the Fetch API under the hood. If your environment doesn't support it, you need to install a polyfill like isomorphic-fetch. More info on storyblok-js-client docs.
Options
When you initialize the integration, you can pass all @storyblok/js options.
// Defaults
storyblok({
accessToken: "<your-access-token>",
bridge: true,
livePreview: false,
apiOptions: {}, // storyblok-js-client options
components: {},
componentsDir: "src",
enableFallbackComponent: false,
customFallbackComponent: "",
useCustomApi: false,
});
!NOTE
By default, theapiPlugin
from@storyblok/js
is loaded. If you want to use your own method to fetch data from Storyblok, you can disable this behavior by settinguseCustomApi
totrue
, resulting in an optimized final bundle.
Region parameter
Possible values:
eu
(default): For spaces created in the EUus
: For spaces created in the USca
: For spaces created in Canadaap
: For spaces created in Australiacn
: For spaces created in China
Full example for a space created in the US:
storyblok({
accessToken: "<your-access-token>",
apiOptions: {
region: "us",
},
});
!WARNING The
region
parameter must be specified unless the space was created in the EU.
Getting started
1. Creating and linking your components to the Storyblok Visual Editor
Link your Astro components to their equivalents created in Storyblok with the following steps.
First, load the components globally by specifying their name and their path in astro.config.mjs
:
components: {
page: "storyblok/Page",
feature: "storyblok/Feature",
grid: "storyblok/Grid",
teaser: "storyblok/Teaser",
},
!NOTE
Thesrc
folder is automatically added to the beginning of the path, so in this example your Astro components should be located here:
src/storyblok/Page.astro
src/storyblok/Feature.astro
src/storyblok/Grid.astro
src/storyblok/Teaser.astro
You can choose any other folder in the
src
directory for your Astro components.!NOTE If you prefer to use a different folder than
src
, you can specify one using thecomponentsDir
option:storyblok({ componentsDir: "app", });
Now, your Storyblok components can be located anywhere in the
app
folder, e.g.page: "storyblok/Page"
forapp/storyblok/Page.astro
orpage: "Page"
forapp/Page.astro
.
For each component, use the storyblokEditable()
function on its root element, passing the blok
property that they receive:
---
import { storyblokEditable } from "@storyblok/astro";
const { blok } = Astro.props
---
<div {...storyblokEditable(blok)}>
<h2>{blok.headline}</h2>
</div>
Finally, you can use the provided <StoryblokComponent>
for nested components; it will automatically render them (if they are registered globally):
---
import { storyblokEditable } from "@storyblok/astro";
import StoryblokComponent from "@storyblok/astro/StoryblokComponent.astro";
const { blok } = Astro.props
---
<main {...storyblokEditable(blok)}>
{blok.body?.map(blok => {return <StoryblokComponent blok={blok} />})}
</main>
!NOTE
Theblok
is the actual blok data coming from Storblok's Content Delivery API.
Using fallback components
By default, @storyblok/astro
throws an error if a component is not implemented. Setting enableFallbackComponent
to true
bypasses that behavior, rendering a fallback component in the frontend instead. You can also use a custom fallback component by (for example) setting customFallbackComponent: "storyblok/MyCustomFallback"
.
Using partial hydration
If you want to use partial hydration with any of the frameworks supported by Astro, follow these steps:
- Install the official Astro integration for your desired framework
- Create an Astro component that serves as a wrapper and utilizes the most suitable client directive
- Create the actual component in Vue, Svelte, React or any other supported framework
For working examples, please refer to the Live Demo on Stackblitz.
2. Getting Storyblok Stories and using the Storyblok Bridge
Fetching one Story
Use the useStoryblokApi
function to have access to an instance of storyblok-js-client
:
---
import { useStoryblokApi } from "@storyblok/astro";
import StoryblokComponent from "@storyblok/astro/StoryblokComponent.astro";
const storyblokApi = useStoryblokApi();
const { data } = await storyblokApi.get("cdn/stories/home", {
version: "draft",
});
const story = data.story;
---
<StoryblokComponent blok={story.content} />
!NOTE
The available methods are described in the storyblok-js-client repository.
Dynamic Routing
In order to dynamically generate Astro pages based on the Stories in your Storyblok Space, you can use the Storyblok Links API and the Astro getStaticPaths()
function similar to this example:
---
import { useStoryblokApi } from "@storyblok/astro";
import StoryblokComponent from "@storyblok/astro/StoryblokComponent.astro";
export async function getStaticPaths() {
const storyblokApi = useStoryblokApi();
const { data } = await storyblokApi.getAll("cdn/links", {
version: "draft",
});
let links = data.links;
links = Object.values(links);
return links.map((link) => {
return {
params: { slug: link.slug },
};
});
}
const { slug } = Astro.params;
const storyblokApi = useStoryblokApi();
const { data } = await storyblokApi.get(`cdn/stories/${slug}`, {
version: "draft",
});
const story = data.story;
---
<StoryblokComponent blok={story.content} />
Using the Storyblok Bridge
The Storyblok Bridge is enabled by default. If you would like to disable it or enable it conditionally (e.g. depending on the environment) you can set the bridge
parameter to true
or false
in astro.config.mjs
:
You can also provide a StoryblokBridgeConfigV2
configuration object to the bridge
parameter.
bridge: {
customParent?: string,
preventClicks?: boolean, // Defaults to false.
resolveRelations?: strings[],
resolveLinks?: string
}
customParent
is used to provide a custom URL for the Storyblok editor iframe.preventClicks
prevents the default behaviour of clicks when inside the Storyblok editor.resolveRelations
may be needed to resolve the same relations that are already resolved in the API requests via theresolve_relations
parameter.resolveLinks
may be needed to resolve link fields.
!NOTE
resolveRelations
andresolveLinks
will only become effective if the live preview feature is used (getLiveStory()
).
The provided options will be used when initializing the Storyblok Bridge. You can find more information about the Storyblok Bridge and its configuration options on the In Depth Storyblok Bridge guide.
If you want to deploy a dedicated preview environment with the Bridge enabled, allowing users of the Storyblok CMS to see their changes being reflected on the frontend directly without having to rebuild the static site, you can enable Server Side Rendering for that particular use case. More information can be found in the Astro Docs.
Enabling Live Preview for Storyblok's Visual Editor
The Astro SDK provides a live preview feature, designed to offer real-time editing capabilities for an enhanced user experience in Storyblok's Visual Editor.
!NOTE
To utilize the Astro Storyblok Live feature, Astro must be configured to run in SSR mode.
To activate the live preview feature, follow these steps:
- Set
livePreview
totrue
in yourastro.config.mjs
file.
//astro.config.mjs
export default defineConfig({
integrations: [
storyblok({
accessToken: "OsvN..",
livePreview: true,
}),
],
output: "server", // Astro must be configured to run in SSR mode
});
- Additionally, use
getLiveStory
on your Astro pages.
//pages/[...slug].astro
---
import { getLiveStory, useStoryblokApi } from '@storyblok/astro';
import StoryblokComponent from "@storyblok/astro/StoryblokComponent.astro";
const { slug } = Astro.params;
let story = null;
const liveStory = await getLiveStory(Astro);
if (liveStory) {
story = liveStory;
} else {
const sbApi = useStoryblokApi();
const { data } = await sbApi.get(`cdn/stories/${slug || 'home'}`, {
version: 'draft',
resolve_relations: ['featured-articles.posts'],
});
story = data?.story;
}
// If you are using `resolve_relations` or `resolve_links`, you must also pass them to the Bridge configuration in `astro.config.mjs`.
---
<StoryblokComponent blok={story.content} />
Dom update event
//page.astro
<script>
document.addEventListener('storyblok-live-preview-updated', () => {
// Here is the callback we could run code every time the body is updated via live preview
console.log('Live preview: body updated');
// Example regenerated all your css
});
</script>
Rendering Rich Text
!NOTE The
@storyblok/astro
now provides the exports for the newrichTextResolver
API from@storyblok/js
. Until a dedicatedStoryblokRichText.astro
is developed, we recommend using the vanilla solution below.
---
import { richTextResolver } from "@storyblok/astro";
const renderedRichText = richTextResolver({
// options like custom resolvers
}).render(doc);
---
<div set:html={renderedRichText}></div>
To learn more about the new richTextResolver
API, please refer to the storyblok-richtext docs.
Or use the renderRichText
function to render rich text.
---
import { renderRichText } from "@storyblok/astro";
const renderedRichText = renderRichText(data, options);
---
<div set:html={renderedRichText}></div>
API
useStoryblokApi()
Returns the instance of the storyblok-js-client
.
The Storyblok JavaScript SDK Ecosystem
Acknowledgements
Astro
We extend our deepest gratitude to the Astro team, especially Tony Sullivan, Matthew Philips, and Nate Moore, for their unwavering support in enhancing this integration. Your partnership is immensely valued.
Virtual Identity
Our heartfelt thanks go to Virtual Identity, one of our closest agency partners. The live preview feature owes its existence to the ingenuity and innovation of their team. Special recognition goes to their developer Mario Hamann for his pivotal live preview POC and continuous support.
Further Resources
Support
- Bugs or Feature Requests? Submit an issue;
- Do you have questions about this SDK? Or would you like to join the growing community of
@storyblok/astro
users? Join the Astro Discord Community - Do you have questions about Storyblok or do you need help? Join the Storyblok Discord Community.
Contributing
Please review our Contributing Guidelines and Code of Conduct before contributing.
This project employs semantic-release to generate new versions based on commit messages, following the Angular Commit Message Convention.
When using playgrounds during development, ensure the build is running in watch mode for an efficient workflow.
4 months ago
4 months ago
2 months ago
2 months ago
4 months ago
4 months ago
5 months ago
5 months ago
5 months ago
4 months ago
7 months ago
7 months ago
7 months ago
7 months ago
6 months ago
10 months ago
11 months ago
1 year ago
10 months ago
11 months ago
12 months ago
10 months ago
10 months ago
1 year ago
12 months ago
1 year ago
10 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago