getComponentSnapshot

An instance method of the Makeswift client that fetches a snapshot of a Makeswift component by its id. This snapshot is only intended to be rendered by <MakeswiftComponent> and <Slot>.

Arguments

1. id · string · required

   The id of the component.

2. options · object · required

   Options for site version and locale.

   Show child attributes

   siteVersion · SiteVersion · required

   For App Router, this is the return value from calling getSiteVersion. For Pages Router, this is the return value from Makeswift.getSiteVersion.

   locale · string

   A valid locale string.

   allowLocaleFallback · boolean · default: true

   Controls whether a request for a localized component should fallback to the default locale if the requested locale is not available.

Return type

snapshot · Promise<MakeswiftComponentSnapshot | null>

An opaque MakeswiftComponentSnapshot object that is only intended to be rendered by <MakeswiftComponent> and <Slot>.

Examples

The following examples expect that you have a Makeswift client instance already configured and exported from "@/makeswift/client.ts". If you don’t, see the client reference.

Basic usage

import { getSiteVersion } from "@makeswift/runtime/next/server";
import { Makeswift } from "@makeswift/runtime/next";
import { ReactRuntime } from "@makeswift/runtime/react";

export const runtime = new ReactRuntime();

export const client = new Makeswift(process.env.MAKESWIFT_SITE_API_KEY, {
  runtime,
});

const productDetailSnapshot = await client.getComponentSnapshot(
  `my-product-details`,
  {
    siteVersion: getSiteVersion(),
  }
);

Localization

import { getSiteVersion } from "@makeswift/runtime/next/server";
import { Makeswift } from "@makeswift/runtime/next";
import { ReactRuntime } from "@makeswift/runtime/react";

export const runtime = new ReactRuntime();

export const client = new Makeswift(process.env.MAKESWIFT_SITE_API_KEY, {
  runtime,
});

const locale = "en-US";
const snapshot = await client.getComponentSnapshot(id, {
  siteVersion: getSiteVersion(),
  locale,
});

Changelog

Version	Changes
v0.23.0	getComponentSnapshot method introduced