Help Center

Menu

Components at Edge

Want an interactive way to learn about components? Check out the DXP Component Library for best practice examples.

Components at Edge is a Squiz DXP Component Service runtime implementation.

The Edge component runtime does not support the existing way of writing server components.

To use this runtime, developers must modify their components' entrypoint and some runtime APIs.

This documentation covers the differences between extant 'server' and new 'edge' components and explains how to convert an existing component to the new Edge runtime.

Prerequisites

  • If you intend to run components using the at edge runtime implementation, you must have version Node.js 20.13.1 or later.

Goals

At the end of these instructions you will know;

  • How to write a component that uses the Edge runtime implementation,

  • How to convert an existing component to use the Edge runtime implementation.

Steps

  1. Make changes to manifest.json

  2. Change entrypoint code

  3. Remove static files

  4. Change to component context

  5. Use the Fetch API

  6. Change development command

  7. Enable deployment