Sitecore JavaScript Rendering SDK (JSS)

repository·dev·Indexed 43 days ago

https://github.com/sitecore/jss

A 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.

Tokens
265.2K
Snippets
907
Records
1.4K
Agent score
54%

What's inside Sitecore JSS

  1. Overview of @sitecore-jss/sitecore-jss-rendering-host

    dev
    The @sitecore-jss/sitecore-jss-rendering-host package 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.
  2. Overview of Sitecore JSS for Angular

    dev
    The @sitecore-jss/sitecore-jss-angular module 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.
  3. Overview of Sitecore JavaScript Rendering SDK (JSS) core module

    dev
    The @sitecore-jss/sitecore-jss module 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.
  4. Overview of @sitecore-jss/sitecore-jss-nextjs utils

    dev

    The @sitecore-jss/sitecore-jss-nextjs package 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.
  5. Overview of @sitecore-jss/sitecore-jss-dev-tools

    dev
    The @sitecore-jss/sitecore-jss-dev-tools package 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.
  6. Overview of @sitecore-jss/sitecore-jss modules

    dev

    The @sitecore-jss/sitecore-jss package 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.
  7. Overview of @sitecore-jss/sitecore-jss-react-forms

    dev
    The @sitecore-jss/sitecore-jss-react-forms package 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.
  8. Overview of Sitecore JavaScript Rendering SDK Proxy

    dev
    The 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.