Version: Next

Getting started

Prerequisites#

This is what you need before working with pelcro-react-js.

Have a configured site on Pelcro platform.
Add Pelcro JS SDK to your site pages.
Set window.Pelcro.environment.ui = " " as you'll be using your react app as the UI.

Setup#

npm
yarn

npm install @pelcro/react-pelcro-js

Create React App Template#

The fastest way to kickstart your app with Pelcro is using our official create-react-app template

To use this template, add --template @pelcro/cra-template when creating a new app.

For example:

npx create-react-app my-app --template @pelcro/cra-template

# or

yarn create react-app my-app --template @pelcro/cra-template

For more information, please refer to:

Getting Started – How to create a new app.
User Guide – How to develop apps bootstrapped with Create React App.

Interactive example#

Elements are completely customizable. You can customize Elements to match the look and feel of your site.
This example is the quickest way to integrate elements UI into your website, using our default modals.

Browsers support#

Last 8 Android Chrome versions
Last 8 desktop Chrome versions
Last 2 iOS Safari versions
Last 2 iOS Chrome versions
Latest desktop Safari version
Latest desktop Edge version
Latest Samsung mobile version

This does not mean that the elements won't function properly on other modern browsers, it means that the user might not get the best possible experience.

Something missing?#

If you find issues with the documentation or have suggestions on how to improve the documentation or the project in general, please file an issue for us.