@openlettermarketing/olc-react-sdk NPM

Integration Guide

OLC React SDK Integration Guide

Introduction

The OLC React SDK allows developers to integrate a customizable template builder into their applications. This guide provides step-by-step instructions to help you install, configure, and use the SDK.

1. Installation

Start by installing the OLC React SDK via NPM.

npm install @openlettermarketing/olc-react-sdk

2. Importing and Initializing the SDK

After installation, import the SDK into your React application and configure the required properties to initialize the TemplateBuilder component.

Complete coverage usage:.

The following example shows the demo of all props minimalist usage, For the real case integration, see integration example.

import TemplateBuilder from '@openlettermarketing/olc-react-sdk';

const templateBuilderProps = {
  container: document.getElementById('element-id'),
  secretKey: 'your-secret-key',
  publicApiKey: 'your-api-key',
  platformName: 'Your Platform Name',
  createTemplateRoute: '/create-template',
  templateBuilderRoute: '/edit-template',
  olcTemplate: yourTemplateObject,
  sandbox: true,
  onReturnAndNavigate () {
    // TODO: Define what happens when the user returns and navigates.
  },
  async onGetOneTemplate (payload) => {
    // TODO: Fetch a specific template.
  },
  async onGetTemplates (payload) => {
    // TODO: Fetch all templates.
  },
  async onGetCustomFields () => {
    // TODO: Fetch custom fields for the templates.
  },
  async onSubmit (payload) => {
    // TODO: Handle the submission of a template.
  },
  styles: {
    root: {
      // Custom CSS properties for the root element.
    },
  },
};

TemplateBuilder(templateBuilderProps);

3. Configuration through Props

The SDK uses several properties to manage its behavior. Below is a breakdown of key props:

Prop name	Type	Description	Required	Example / Usage
`container`	HTMLDivElement	An HTML DOM element to render the template builder component.	✓	`document.getElementById('template-builder-container')`
`secretKey`	string	That key is used to communicate Polotno Editor (Builder) with API requests.	✓	`'your-secret-key'`
`publicApiKey`	string	publicApiKey is used for basic authentication between the OLC and the client platform.	✓	`'your-api-key'`
`platformName`	string	The name of your platform.	⤫	`'My App'`
`createTemplateRoute`	string	The route/path for creating new templates. (begins with slash `/`)	⤫	`'/create-template'`
`templateBuilderRoute`	string	The route/path for editing existing templates. (begins with slash `/`)	⤫	`'/edit-template'`
`olcTemplate`	object	The template object to be edited or used as a base.	⤫	`{ ... }`
`sandbox`	boolean	The sandbox setting can be either true or false. Set to true for demo purposes and false for production.	⤫	`true`
`allowSenderFields`	boolean	The allowSenderFields prop can be set to either true or false. When set to true, it makes the sender fields visible in the custom fields section.	⤫	`true`
`allowPropertyFields`	boolean	The allowPropertyFields prop can be set to either true or false. When set to true, it makes the property fields visible in the custom fields section.	⤫	`true`
`excludedFields`	string	The excludedFields prop allows you to remove specific fields from the custom fields section by their key	⤫	`['{{C.EMAIL}}','{{SPF.LAST_NAME}}']`
`templateGalleryModal`	boolean	The templateGalleryModal prop can be set to either true or false. When set to false, it disables the template gallery modal and activates the sidebar gallery in the template builder.	⤫	`true`
`onReturnAndNavigate`	function	An event which triggers when a user navigates away.	⤫	`onReturnAndNavigate () { ... }`
`onGetOneTemplate`	function	An event which triggers when fetching a specific template.	⤫	`onGetOneTemplate ( payload ) { ... }`
`onGetTemplates`	function	An event which triggers when fetching all templates.	⤫	`onGetTemplates ( payload ) { ... }`
`onGetCustomFields`	function	An event which triggers when fetching custom fields for templates.	⤫	`onGetCustomFields () { ... }`
`onSubmit`	function	An event which triggers upon template submission.	⤫	`onSubmit () { ... }`
`destroy`	function	An event that destroys the template builder instance and cleans up all associated components and cache. Call this function when unmounting the template builder component to ensure proper cleanup and avoid memory leaks.	⤫	`templateBuilderInstance.destroy()`
`styles`	object	An object of JSS props for customize styling of template builder.	⤫	`{ root: { ... } }`

4. API Integration

To integrate the SDK’s API, ensure that your backend securely communicates with the OLC Backend, returning the necessary data to the SDK frontend.

5. Customization and Styling

The SDK allows for extensive customization of the template builder’s appearance. Use the styles prop to apply custom CSS properties and match the look and feel of your application.

6. Real-case of usage

Below is an example of how to use the SDK within a React component:

import { useEffect } from 'react';

// SDKs
import TemplateBuilder from '@openlettermarketing/olc-react-sdk';

// styles
import '@blueprintjs/core/lib/css/blueprint.css';

const App = () => {
  useEffect(() => {
    TemplateBuilder({
      container: document.getElementById('template-builder-container'),
      secretKey: 'your-secret-key',
      publicApiKey: 'your-api-key',
      sandbox: false,
      async onSubmit (payload) {
        console.log('Template submitted:', payload);
        // Implement your submission logic here
      },
    });
  }, []);

  return (
    <>
      {/** ... */}
      <div id="template-builder-container" />
    </>
  );
}

export default App;