Sitecore JavaScript Rendering SDK NPM packages

Version: 22.x

Sitecore JavaScript Rendering SDK (JSS) is a set of JavaScript packages that add first-class support for JavaScript frameworks and enable the development of modern applications that consume Sitecore data.

JSS provides the following NPM packages:

  • @sitecore-jss/create-sitecore-jss contains initializers / templates for JSS sample applications.

  • @sitecore-jss/sitecore-jss-cli contains the JSS CLI.

  • @sitecore-jss/sitecore-jss contains the core APIs and utilities for JSS, such as JSS Dictionary API,JSS Layout API, JSS GraphQL API, the infrastructure for Sitecore editors integration, and various utilities. Consult the API reference on Github.

  • @sitecore-jss/sitecore-jss-dev-tools contains developer tooling, such as development proxies and deployment scripts.

  • @sitecore-jss/sitecore-jss-proxy contains the headless-mode SSR proxy implementation used for server-side rendering React, Angular, or Vue.js JSS applications.

  • @sitecore-jss/sitecore-jss-rendering-host contains the rendering host implementation.

The functionality they provide is available in JSS applications created based on sample apps. Unless otherwise indicated in a procedure or walkthrough, you do not have to install them individually.

The JSS sample applications leverage framework-specific NPM packages:

  • @sitecore-jss/sitecore-jss-angular contains Angular integration components and services for JSS.

  • @sitecore-jss/sitecore-jss-angular-schematics contains Angular developer code generation schematics.

  • @sitecore-jss/sitecore-jss-nextjs contains Next.js components and integration for JSS.

  • @sitecore-jss/sitecore-jss-react contains React components and integration for JSS.

  • @sitecore-jss/sitecore-jss-react-native contains services and components for React Native.

  • @sitecore-jss/sitecore-jss-vue contains Vue integration and components for JSS.

Do you have some feedback for us?

If you have suggestions for improving this article,