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 | | templateGalleryModal | boolean | The templateGalleryModal setting can be either true or false. Set to true for modal view and false for sidebar template gallery. | ⤫ | true | | designerQueryAmount | number | The designerQueryAmount prop is used in the "Hire a Designer" card within the template gallery section to display the specified amount. | ⤫ | 25 | | allowedAddOns | string[ ] | The allowedAddOns prop lets you specify which add-ons appear in the add-ons section by providing their keys as an array of strings. You can add or remove add-ons as needed by updating this array. | ⤫ | ['property_offer','gsv'] | | 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 | | allowedTemplateSections | string[ ] | The allowedTemplateSections prop lets you control which sections appear in the template gallery by adding or removing them as needed. | ⤫ | ['my_templates', 'team_templates'] | | restrictedProducts | number[] | The restrictedProducts prop filters products on the product selection screen, allowing you to show or hide products as needed. Simply include the product IDs in the array to filter out specific products. | ⤫ | [9, 11, 13] | | excludedFields | string[ ] | The excludedFields prop allows you to remove specific fields from the custom fields section by their key | ⤫ | ['{{C.EMAIL}}','{{SPF.LAST_NAME}}'] | | hideCurvedTextEffect | boolean | Hides the Polotno "Curved text" control from the text Effects menu. Defaults to true so users cannot apply the curved text effect in the template builder. | ⤫ | true | | 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 () { ... } |
onCreateCustomTemplateQuery | function | A callback function that is triggered after a custom template query is successfully created. This is typically used when you allow users to request a custom-designed template from within the template builder. | ⤫ | async onCreateCustomTemplateQuery(payload) { ... } | | onDuplicateTemplate | function | Callback triggered when duplicating an existing template. Should return a Promise resolving the newly created duplicated template name. | ⤫ | async onDuplicateTemplate(payload) { ... } | | allowedTemplateSections | string[] | Array of section keys that control which sections are visible in the template gallery. | ⤫ | ['my_templates', 'team_templates'] | | restrictedProducts | number[] | Array of product IDs to restrict product selection. | ⤫ | [9, 11, 13] | | disallowedProducts | string[] | Specifies products that should be excluded entirely by their keys/IDs. Useful when you want to hide certain products regardless of what other filters allow. | ⤫ | ['postcard_4x6', 'letter_8.5x11'] | | propertyOfferCost | number | Dynamic cost value for property offers shown in the builder. | ⤫ | 10 | | customPropertyOfferCost | number | Custom cost value that overrides propertyOfferCost when needed (e.g., user-specific discounts). | ⤫ | 7.5 | | gsvCost | number | Cost value associated with adding a Google Street View image to a template. | ⤫ | 1.25 |
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,
      hideCurvedTextEffect: true,
      async onSubmit (payload) {
        console.log('Template submitted:', payload);
        // Implement your submission logic here
      },
    });
  }, []);

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

export default App;