SDK-R v24.1.10 is only compatible with Pega Infinity '24.1 and is related to the release/24.1.10 branch of the React SDK repository.
Note: The main branch is the active development branch for future versions of React SDK.
This release allows React SDK users to take advantage of the latest SDK enhancements and fixes. For more information, see What's New in SDK-R 24.1.10.
This React SDK updates page provides details about all of the React SDK releases.
IMPORTANT: Please follow the guidelines documented here if you are upgrading from a previous version of React SDK: Upgrading the SDK
The React SDK combined with Pega's client orchestration APIs provides a guided iterative development workflow experience that accelerates integrating Pega’s Constellation DX API with an alternative (non-Pega) UI. Integrating an alternative design system is achieved using DX Components.
A DX component contains logic and presentation tags to merge the alternate design system with Pega’s client orchestration APIs.
The alternative design system used in the React SDK is Material UI. For more information about Constellation SDKs, see the Constellation SDKs documentation.
A summary of the latest updates to the @pega/react-sdk-components and @pega/react-sdk-overrides used by the React SDK can be found in react-sdk-components KeyReleaseUpdates.md.
This version of the React SDK assumes that you have access to a Pega Infinity server (24.1.0+) running an application that is configured to run using the Constellation UI service.
The MediaCo sample application is already configured as a Constellation application and can be found in the React SDK download associated with this repo which is available at https://community.pega.com/marketplace/components/react-sdk. The OAuth 2.0 Client Registration records associated with the MediaCo application are available in the same React SDK download. For more information about the MediaCo sample application, see MediaCo sample application.
The React SDK has been tested with:
- node 18.12.1/18.13.0
- npm 8.19.2/8.19.3 - Note: Do not use npm 9
Future updates to the SDK will support more recent LTS versions of node as Constellation supports them.
Before installing and running the SDK code, refer to Downloading the Constellation SDK files for steps to prepare your Infinity server and node environment so you can proceed with the steps in the next section.
The following procedures provide an overview of installing Constellation SDKs and running the application. For more information, see Installing and configuring Constellation SDKs.
You can find more details on how to integrate the latest React SDK into your development workflow and also instructions on the new using the new DX Component Builder for SDK features.
For more information, see Development.
If you are facing any issues, please see Troubleshooting Constellation SDKs.
This project is licensed under the terms of the Apache 2 license.
You can see the full license here or directly on apache.org.
We welcome contributions to the React SDK project.
Refer to our guidelines for contributors if you are interested in contributing to the project.
- KeyReleaseUpdates.md: A summary of the latest updates to the @pega/react-sdk-components and
@pega/react-sdk-overrides used by the React SDK can be found in the
react-sdk-components package's KeyReleaseUpdates.md.
- To see if there are updates in the @pega/react-sdk-components and @pega/react-sdk-overrides packages published in a newer version than is currently installed, you can check the package's main GitHub repo's KeyReleaseUpdates.md.
- Material UI
- Constellation SDKs Documentation
- Troubleshooting Constellation SDKs
- MediaCo sample application