Sitecore JavaScript Rendering SDK (JSS)
repository·dev·Indexed 43 days ago
https://github.com/sitecore/jssA SDK providing tools and templates to build headless applications using JavaScript frameworks such as React, Angular, and Next.js that connect to Sitecore XP or Sitecore XM. JSS 23 supports Sitecore XP 10.5. The SDK includes the create-sitecore-jss module for scaffolding, support for Server-Side Rendering (SSR) via Node/Express, and experimental React Native implementation.
What's inside Sitecore JSS
- The Sitecore JavaScript Rendering SDK (JSS) for React Native provides the necessary services and components to integrate Sitecore headless content into React Native applications. It is part of the broader Sitecore JSS ecosystem.
Overview of the mediaApi namespace
devThemediaApinamespace in@sitecore-jss/sitecore-jssprovides a set of utility functions designed to handle media-related tasks within a Sitecore JSS application. These functions assist with manipulating image URLs, generating responsive image attributes likesrcset, and managing media tags within the Sitecore Experience Editor.Overview of Sitecore JSS Rendering Host
devThesitecore-jss-rendering-hostis a module provided as part of the Sitecore JavaScript Rendering SDK (JSS). It contains the implementation of the rendering host, which is responsible for handling requests from Sitecore and managing the rendering lifecycle for headless applications.Overview of @sitecore-jss/sitecore-jss-proxy
devThe@sitecore-jss/sitecore-jss-proxypackage provides a headless proxy implementation for Sitecore JSS. It is designed to facilitate headless rendering by providing middleware and utility functions to manage request paths, server bundles, and analytics cookies within a proxy environment.Overview of @sitecore-jss/sitecore-jss-rendering-host
devThe@sitecore-jss/sitecore-jss-rendering-hostpackage provides the core logic for running a Sitecore JSS rendering host. It includes essential components for managing the rendering lifecycle, such as middleware for Server-Side Rendering (SSR) and functions to start the rendering host server or tunnels. This package is a foundational piece for developers building headless rendering hosts that interact with Sitecore.Overview of Sitecore JSS for Angular
devThe@sitecore-jss/sitecore-jss-angularmodule is a specialized integration of the Sitecore JavaScript Rendering SDK (JSS) designed specifically for Angular applications. It provides the necessary Angular components and services to enable headless development with Sitecore, allowing you to build component-based user interfaces that consume Sitecore data.Overview of Sitecore JavaScript Rendering SDK (JSS) core module
devThe@sitecore-jss/sitecore-jssmodule is the core component of the Sitecore JavaScript Rendering SDK. It provides the fundamental JSS APIs, specifically the Layout Service integration, and various core utilities required for headless development with Sitecore.Overview of @sitecore-jss/sitecore-jss-nextjs utils
devThe
@sitecore-jss/sitecore-jss-nextjspackage provides a set of utility variables and functions designed to assist with Sitecore Experience Editor integration, environment configuration, and URL resolution within a Next.js application.Available Variables
isEditorActive: Detects if the Sitecore Experience Editor is currently active.resetEditorChromes: Utility for managing Experience Editor UI elements (chromes).tryParseEnvValue: Safely parses environment variable values.
Available Functions
getPublicUrl: Retrieves the public-facing URL for the application.handleEditorFastRefresh: Manages Next.js fast refresh behavior when working within the Experience Editor.resolveUrl: Resolves relative or absolute URLs within the Sitecore context.
Overview of @sitecore-jss/sitecore-jss-dev-tools
devThe@sitecore-jss/sitecore-jss-dev-toolspackage provides developer utilities for working with Sitecore JSS. It includes tools for managing manifests, generating content, handling disconnected services (Layout Service, Dictionary Service, etc.), and managing pipelines and processors. It is designed to assist in scaffolding, deploying, and simulating Sitecore environments during development.Overview of @sitecore-jss/sitecore-jss modules
devThe
@sitecore-jss/sitecore-jsspackage is the core SDK for Sitecore JavaScript Rendering. It is organized into several functional modules that provide specialized capabilities for headless Sitecore development:- editing: Tools for Sitecore Experience Editor support.
- graphql: Utilities for interacting with Sitecore GraphQL APIs.
- i18n: Internationalization and localization support.
- layout: Logic for handling Sitecore layout service data and component rendering.
- media: Utilities for managing and resolving Sitecore media items.
- site: Context and configuration related to the current Sitecore site.
- tracking: Support for Sitecore xDB and user tracking.
- utils: General purpose helper functions.
- index: The main entry point for the SDK.
Overview of @sitecore-jss/sitecore-jss-react-forms
devThe@sitecore-jss/sitecore-jss-react-formspackage provides a set of React components and utilities for building forms within Sitecore JSS applications. It includes pre-defined field components, form management classes, and type definitions to ensure consistent form behavior and validation.Overview of Sitecore JavaScript Rendering SDK Proxy
devThe Sitecore JavaScript Rendering SDK Proxy is a module provided as part of the Sitecore JSS ecosystem. It is designed to facilitate headless development by providing middlewares and utilities specifically for working in a headless mode. It acts as a bridge to support server-side rendering and headless architectures within the Sitecore ecosystem.