This release - SDK-R v23.1.10 - is only compatible with Pega Infinity 23. This release is related to the main branch of the React SDK repository.
(If you currently are using the React SDK with Pega Infinity 8.8, update your SDK to
the SDK-R v8.8.20 - release/8.8.20 branch.)
The SDK-R v23.1.10 and v8.8.20 releases allow React SDK users to to take advantage of the latest SDK enhancements and fixes noted in What's New in the SDK? including:
- Added the use of TypeScript typedefs (from @pega/pcore-pconnect-typedefs) to SDK components. For more information, see Using type definitions
- Additional functionality including RichTextEditor and Dynamic Tabs components and many-to-many data reference support
- Updated Cosmos support to cosmos 4 (for custom Constellation components).
- Enhanced security including token storage and item obfuscation support.
- Bug fixes.
- Full set of merged PRs can be found in the react-sdk-components GitHub repo list of merged PRs. This release includes all PRs since (and including) #166 and #230.
This React SDK updates page provides details about all of the React SDK releases.
This (main branch) is the latest version of the React SDK. It is intended to be used with Infinity 8.8.0+. If you need to use Infinity 8.7.*, please use the release/8.8.10 branch instead of this main branch.
This version of the React SDK provides many new features that are documented here:
What's new in the SDK? and also outlined below:
The following list shows some of the key features and changes in this 8.23.11 release:
-
Added localization support. You can now implement localization in your custom and overridden SDK components.
-
Updated the lint settings in the DX Component Builder to enable publishing custom components with lint errors or warnings. You can modify the lint setting (lintAction) in the sdk-config.json file from “show” to “block” to disable publishing components with lint errors or warnings.
-
Updated support for the following npm packages:
- @pega/react-sdk-components: v8.23.11
- @pega/react-sdk-overrides: v8.23.11
- @pega/dx-component-builder-sdk: v8.23.16
For more information about the react-sdk-components and react-sdk-overrides packages, and enhancements and bug fixes in the packages, click here.
IMPORTANT: Please follow the guidelines documented here if you are upgrading from a previous version of React SDK: Upgrading the SDK
If you want to continue using the previous release you can checkout release/8.8.10
The React SDK provides Pega customers with the ability to build DX components that connect Pega’s ConstellationJS Engine APIs with a design system other than the Pega Constellation Design System.
The React SDK differs from out-of-the-box Constellation design system because it provides and demonstrates the use of a React design system that is not the Pega Constellation design system. The alternative design system used in this React SDK is Material UI.
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 (23.1.0+) running an application that is configured to run using the Constellation UI service. (If you need to use Infinity 8.8.*, please use the release/8.8.20 branch instead of this main branch.)
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: at this time, 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 detailed documentation, 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.
see Development
Stuck? Look at our Troubleshooting Constellation SDKs which covers resolutions for most of the common problems.
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