Get Started with Studio React SDK

Use this guide to get started with the Studio React SDK. You will learn how to install the @contentstack/studio-react package, connect it to the Contentstack Delivery SDK, and render your first composition in a React component.

In this guide, you will:

• Set up the stack client.
• Initialize the SDK using studioSdk.init.
• Load and render a composition with useCompositionData and StudioComponent.

Before you begin, ensure the following requirements are met:

• A Contentstack stack is set up, and you have valid API credentials.
• The Contentstack Delivery SDK (TypeScript) is installed and imported into your React app.
• Live Preview is enabled in the Delivery SDK configuration.
• Node.js v18 or later is running in your development environment.

Open your terminal and install the Studio React SDK using the npm command.

npm install @contentstack/studio-react

Once the SDK is installed, initialize it to connect your React app to Studio.

The studioSdk object manages configuration and communication between your React app and Studio. Initialization allows you to fetch and render compositions, including support for SSR.

When you initialize the SDK, you create a runtime link between your app and Studio. During initialization, perform the following steps:

• Pass the Contentstack Delivery SDK stack (with Live Preview enabled) to studioSdk.init().
• Register the SDK configuration options (for example, content type, CSLP settings, and “Open in Studio” button options).
• Optional parameters are automatically applied with default values.
• Gain access to helper methods and configuration (via getConfig() and other returned utilities) for fetching and rendering compositions, including support for SSR.

The studioSdk.init() method initializes the SDK with your configuration.

Returns: An object containing methods to fetch the compositions in SSR mode.

Parameters:

Example:

import { studioSdk } from '@contentstack/studio-react';
import contentstack from '@contentstack/delivery-sdk';
const stack = contentstack.stack({
  apiKey: "YOUR_API_KEY",
  deliveryToken: "YOUR_DELIVERY_TOKEN",
  environment: "YOUR_ENVIRONMENT",
  live_preview: {
    preview_token: "YOUR_PREVIEW_TOKEN",
    enable: true,
  },
});
// Initialize the SDK with your configuration
studioSdk.init({
  stackSdk: stack, // Contentstack Delivery SDK instance (REQUIRED)
});

Note: If options are not provided, the SDK uses the following default values:

{
  contentTypeUid: "",
  cslp: {
    appendTags: false,
  },
  openInStudioButton: {
    enable: true,
    position: "bottom",
  }
}

The fetchComposition(compositionQuery, options) method fetches composition data and specifications from Studio.

Returns:

Type Promise <CompositionData>

Parameters:

Example:

const composition = await studioSdk.fetchComposition({
  compositionUid: 'my-composition-uid',
  searchQuery: window.location.search,
});

The getConfig() method retrieves the current SDK configuration.

Returns:

Type Config - The current SDK configuration.

Example:

const config = studioSdk.getConfig();

Studio provides a list of React Components that render the composition in different scenarios. StudioComponent is the primary component that enables editing and preview of the spec.

The StudioComponent React component renders a complete Studio composition in edit or preview mode.

• Edit Mode: Enables drag-and-drop, inline editing, and all Studio features.
• Preview Mode: Displays the composition as end users see it, without editing tools.

Props:

Example:

export function Home() {
  const { specOptions } = useCompositionData({
    compositionUid: "homepage",
  });
  return (
    <>
      <StudioComponent
        specOptions={specOptions}
        data={{ version: "latest", cursor: "pointer" }}
      />
    </>
  );
}

The PreviewRenderer React component renders UI specifications in a lightweight, read-only format without providing editing capabilities.

Props:

Example:

import { PreviewRenderer } from '@contentstack/studio-react';
<PreviewRenderer
  spec={compositionSpec} // This is not SpecOptions, it is the composition spec
  data={componentData}
/>

The StudioCanvas React component enables visual editing and composition building.

It automatically detects the composition being edited and fetches its data, without requiring spec or data props. This component is useful when rendering compositions without setting up a page in the project, such as through a wildcard route.

Example:

import { StudioCanvas } from '@contentstack/studio-react';
<StudioCanvas />

• Use advanced hooks like useSelected and useHiddenElementNotification to manage component states.
• Register custom components, JSON RTE elements, and design tokens to customize composition behavior.
• Refer to the API Reference for detailed documentation on all methods, utilities, and configuration options.