Creating Your First Sitecore Astro Rendering

Anton Tishchenko
Anton Tishchenko
Cover Image for Creating Your First Sitecore Astro Rendering

Working with Astro as a frontend framework is very similar to other web frameworks supported by Sitecore. We will go through the all process of rendering creation.


You need Sitecore XM configured headless website and initialized Astro website.

Creating rendering

  1. Each Sitecore rendering should have data to render. The format of data is defined by templates. Let’s create a template named AstroTemplate with 4 fields that have different types

Sitecore Template

  1. Next, we need a rendering. The most important fields are:
    • rendering Name, it should match the name of the rendering in the frontend project.
    • Datasource location, we need to set it to query:$site/*[@@name='Data']/*[@@name='AstroTemplate']|query:$sharedSites/*[@@name='Data']/*[@@name='AstroTemplate'] to force datasource selection dialog. Otherwise, we need to check if fields are null on the rendering level.
  2. Now, we can create the rendering itself. It should be named Astrorendering.astro to match to rendering name in the Sitecore.
import { RichText } from '@astro-sitecore-jss/astro-sitecore-jss';
import { Text } from '@astro-sitecore-jss/astro-sitecore-jss';
import { Image } from '@astro-sitecore-jss/astro-sitecore-jss';

export interface Props {
  route: any;

const { fields } = Astro.props.route;

  <Text tag="h1" field={fields.SingleLineText} />
  <Text tag="h2" field={fields.MultiLineText} />
  <RichText field={fields.RichText} />
  <Image field={fields.Image} />
  1. We need to restart the Astro node server to renew the renderings factory. It has a hot reload on changing renderings but doesn’t have a hot reload on adding new renderings.
  2. Add a rendering to the allowed controls in the placeholder, where you want to use this rendering
  3. Add rendering to the page


  1. Add data to the fields

Experience Editor

  1. Save the page

Congratulation! You have created your first Astro rendering.