getPageSnapshot

An instance method of the Makeswift client that fetches a snapshot of a Makeswift page at a given path. This snapshot is only intended to be rendered by the <Page> component.

Arguments

1. pathname

   string

   required

   The path of the page.

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.

Return type

snapshot

Promise<MakeswiftPageSnapshot | null>

An opaque Snapshot object that is only intended to be rendered by the <Page> component.

Examples

Basic usage

The following example sets up a catch all route where page snapshots are fetched from Makeswift and rendered using the <Page> component.

Localization

The following example uses the locale param in getStaticProps to fetch a localized snapshot of a page.

pages/[[...path]].tsx

import { Makeswift, Page as MakeswiftPage } from "@makeswift/runtime/next"

import { client } from "@/makeswift/client"

export async function getStaticPaths() {
  const pages = await client.getPages()

  return {
    paths: pages.map((page) => ({
      params: {
        path: page.path.split("/").filter((segment) => segment !== ""),
      },
    })),
    fallback: "blocking",
  }
}

export async function getStaticProps({ params, previewData, locale }) {
  if (params == null) return { notFound: true }

  const path = "/" + (params.path ?? []).join("/")
  const snapshot = await client.getPageSnapshot(path, {
    siteVersion: Makeswift.getSiteVersion(previewData),
    locale,
  })

  if (snapshot == null) return { notFound: true }

  return { props: { snapshot } }
}

export default function Page({ snapshot }) {
  return <MakeswiftPage snapshot={snapshot} />
}