Create Custom Components in Storyblok and Astro

Let’s take it one step further in this part by exploring component schemas in Storyblok. We’ll learn how to modify existing components, create entirely new ones from scratch and, of course, integrate all of these changes into our Astro frontend.

Section titled Requirements Requirements

This tutorial is part 4 of the Ultimate Tutorial Series for Astro. We recommend that you follow the previous tutorials before starting this one.

Section titled Changing Existing Components Changing Existing Components

Section titled Adding an Image Field to the Feature Component Adding an Image Field to the Feature Component

First of all, let’s extend one of the existing components that were created by Storyblok for us: the Feature component. Right now, the Feature components look a little bit bland, don’t they? Adding an image to them would certainly spice things up a little bit.

To modify it right from the Visual Editor, go to the Home story and click on one of the Feature components, which exist as nested blocks in the Grid component. To edit the schema, click on the Block Library button at the top {1}.

Now you immediately start typing. Let’s enter the image as our field name. Now you can click on the newly created field. In this menu, you want to set the Field type to Asset {1} and then choose the file type Images {2}.

And that’s that! After closing the Block Library, you’ll see the image field, providing the possibility to upload an asset. Go ahead and upload some images for the three instances of the Feature component. Of course, they won’t show up in the frontend just yet, so let’s take care of that next.

Section titled Showing the Image Field in Astro Showing the Image Field in Astro

In order to render the images properly in Astro, we have to figure out what exactly is provided by Content Delivery API after the changes to our component schema.

1

2

If you search for the term feature now, you’ll find the image field and all of the data it provides {1}. For now, all that we need are the filename {2} and the alt {3} values.

Perfect. Let’s use those in Astro by updating the storyblok/Feature.astro component:

        
      ---
import { storyblokEditable } from '@storyblok/astro'

const { blok } = Astro.props
---

<div
  {...storyblokEditable(blok)}
  class="w-full bg-[#f7f6fd] rounded-[5px] text-center overflow-hidden"
>
  <img
    src={blok.image.filename}
    alt={blok.image.alt}
    class="w-full h-48 xl:h-72 object-cover"
  />
  <div class="px-12 py-6">
    <h3 class="text-2xl text-[#1d243d] font-bold">
      {blok.name}
    </h3>
  </div>
</div>
    

What’s happening here? The blok object contains all of the information that we need, so the image field and its nested properties filename and alt are easily accessible. In Astro, we can then very easily add these values to any HTML tag, in this case an img.

That already looks much better, doesn’t it?

Section titled Creating New Components Creating New Components

Having successfully modified an existing component, let’s now create a completely new block from scratch. Something that our website could really need is a nice-looking hero component, wouldn’t you agree?

Section titled Rendering the Hero Component in Astro Rendering the Hero Component in Astro

All we have to do is create a new storyblok/Hero.astro component with the following content:

        
      ---
import { storyblokEditable } from '@storyblok/astro'

const { blok } = Astro.props
let dynamicHeroClass = blok.layout === 'constrained' ? 'container mx-auto' : ''
---

<div
  {...storyblokEditable(blok)}
  class={`${dynamicHeroClass} min-h-[500px] relative flex items-end justify-center my-6 rounded-[5px] overflow-hidden`}
>
  <div
    class="relative z-10 w-full text-center bg-gradient-to-t from-black/70 via-black/50 to-transparent py-6"
  >
    <h1 class="text-6xl text-white font-bold mb-3">
      {blok.headline}
    </h1>
    <h2 class="text-4xl text-white font-light">
      {blok.subheadline}
    </h2>
  </div>
  <img
    src={blok.background_image.filename}
    alt={blok.background_image.alt}
    class="absolute top-0 left-0 z-0 w-full h-full object-cover"
  />
</div>
    

At this point, you should be familiar with most of the code. The only novelty is that we create a computed property dynamicHeroClass to determine which classes should be used depending on the value we get from the layout field we created. This computed property is then added to the class using Template literals.

Next, make sure to register the component in the Storyblok integration in astro.config.mjs.

        
      export default defineConfig({
  integrations: [
    storyblok({
      accessToken: env.STORYBLOK_TOKEN,
      components: {
        page: 'storyblok/Page',
        feature: 'storyblok/Feature',
        grid: 'storyblok/Grid',
        teaser: 'storyblok/Teaser',
+        hero: 'storyblok/Hero',
      },
    }),
    tailwind(),
  ],
})
    

If you refresh your Home story in the Visual Editor now, you’ll not only see the Hero component in all its glory – you can also change the layout and save, it will update accordingly!

Section titled Wrapping up Wrapping up

Congratulations, when you reached this point you have successfully adapted the schema of existing components, created new components from scratch and incorporated all of the required code changes in your Astro project! Great work!