Pages

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

This example shows you how to incorporate Frosmo-managed content in a React application using the Frosmo React Connector. You first create a plain modification with a single variation that is displayed to all visitors in the page header. The content of the modification is a Frosmo logo that links to the Frosmo home page. You then personalize the modification by only displaying it to visitors who have not opened the logo link.

This example uses Create React App as its development environment and single-page application template.

This example assumes that the Frosmo SPA module is enabled for your site.

Since this example is designed for a single person to complete, the workflow is slightly different from the generic development workflow, which assumes two people working on the content. In this example, you first create the placement and modification in the Frosmo Control Panel, and you then work with React. This is purely for convenience. You could equally well reverse the order and follow the generic workflow.

To create the content:

  1. Create the placement and modification for the content in the Frosmo Control Panel.
  2. Install and run Create React App.
  3. Add your Frosmo scripts to Create React App.
  4. Install the React Connector to Create React App.
  5. Create the FrosmoPlacement and other components for the content in Create React App.
  6. Personalize the content in the Control Panel.

Creating the placement and modification

Creating the placement

To create the placement:

  1. In the Control Panel, select Modifications > Placements.
  2. Click Create placement.
  3. Define the following settings:

    • Name: Enter "Frosmo Logo".
    • Target element: Select CSS selector, and enter "frosmo-logo" as the selector name.
    • Display method: Leave this field to its default value.

    Placement settings

  4. Click Save.

You have created the placement. For more information about placement settings, see Creating and editing a placement.

Creating the modification

To create and activate the modification:

  1. In the Control Panel, select Modifications > Overview.
  2. Click Create modification.
  3. Enter "Frosmo Logo" as the modification name, select Personalization as the modification case, and click Create. You could also select another case, but since this modification needs only the one variation, Personalization is the natural choice here.

    Creating the modification

    The Basic settings view opens.

  4. Select the placement for the modification:
    1. In the Placement section, click Select placement.

      Selecting the placement for the modification

    2. Select the Frosmo Logo placement you created earlier.

      Selecting the placement for the modification

    3. Click Save.
  5. Define the content for the modification:
    1. In the Content section, click the variation name.

      Defining the content for the modification

    2. In the variation settings, make sure the selected content type is Custom content, which is the default setting.
    3. In the Content field, enter the following code:

      <a href="https://frosmo.com/" target="_blank" rel="noopener noreferrer">
        <img
          src="https://d2wzl9lnvjz3bh.cloudfront.net/message_files/2083/65511/9146/frosmo-logo.png"
          alt="frosmo-logo"
        />
      </a>
    4. Click Save.
    5. In the Content section, click the quick menu button for the variation, and select Activate.

      Defining the content for the modification

    6. If you want to disable the comparison group for the modification, click the quick menu button for the group, and select Deactivate.
  6. Disable basic conversion tracking and, if enabled, Google Analytics tracking for the modification:

    1. In the Advanced settings section, click Define settings.

      Disabling tracking for the modification

    2. Disable Conversion tracking and GA tracking.

      Disabling tracking for the modification

    3. Click Save.

    Since the modification is used purely for example purposes, and since the modification will not even be displayed on your actual site, you do not want to attribute conversions to or send Google Analytics events for the modification based on the clicks, displays, and true displays the modification receives. For more information about conversions and conversion attribution, see Data tracking overview and Conversion attribution.

    As a rule, do not disable basic conversion tracking for a modification.

    If the Frosmo Platform is not integrated with Google Analytics for your site, the GA tracking setting is not available.

  7. Activate the modification:
    1. At the bottom of the Basic settings view, click Activate.
    2. To confirm, click Activate.

You have created and activated the modification. For more information about modification settings, see Creating and editing a modification.

The content is now set up in the Frosmo Platform and ready to be used in a React application.

Installing and running Create React App

To install and run Create React App on your local computer or development server, follow the getting started instructions in the Create React App documentation.

Create React App without Frosmo

Figure: Create React App without Frosmo

For more information about Create React App, see:

Adding the Frosmo scripts to Create React App

To use the placement and modification in your React application, you need to integrate the application with the Frosmo Platform. You do this by adding the Frosmo scripts for your site to the application.

Since Create React App will use the same Frosmo scripts as your actual site, the data tracking that applies to the site will also apply to the application. Depending on what data tracking has been implemented for the site, the application may generate tracking data that skews your actual site statistics. In creating the modification, you've already disabled basic conversion tracking for the modification, so at least no conversions will be attributed to the modification based on the clicks, displays, and true displays it receives.

To add the Frosmo scripts to Create React App:

  1. Get the Frosmo <script> elements for your site. For more information, see Creating and managing sites.
  2. Edit the /public/index.html file of the application, add the <script> elements to the end of the <head> element, and save the file.

    Frosmo scripts in Create React App

  3. To check that the platform is successfully integrated with the application, open the browser console, and enter frosmo.easy. If the integration platform and application are integrated, the console displays information about the frosmo.easy object.

    Frosmo Platform successfully integrated

    If the object is undefined, or if the console displays an error, check that the <script> elements in /public/index.html are correct.

Installing the React Connector to Create React App

To install the React Connector to your React application, follow the instructions in Installing the React Connector.

Creating the React components

With the content ready for use on the platform side, and with your application set up for interacting with the platform, all that remains is to create the React components that retrieve and render the content in the application. In this example, you only need to modify the /src/App.js file in Create React App.

To add the content to your application:

  1. Open the /src/App.js file in your editor.
  2. Replace the existing content with the following code. This code strips the page of everything but the React logo and rewrites the App component as a class.

    import React, { Component } from 'react';
    import logo from './logo.svg';
    import './App.css';
    
    class App extends Component {
      render() {
        return (
          <div className="App">
            <header className="App-header">
              <img src={logo} className="App-logo" alt="logo" />
            </header>
          </div>
        );
      }
    }
    
    export default App;
  3. Import the FrosmoPlacement component from the frosmo-react module.

    import { FrosmoPlacement } from 'frosmo-react';
  4. Add a FrosmoPlacement component as the first piece of content inside the <div> element, before the <img> element. Configure the component as follows:

    • Define the id prop as "frosmo-logo". This allows the React Connector to associate the component to the placement and modification you created earlier.
    • Define the defaultComponent prop as {DefaultContent}. This sets the DefaultContent component, which you'll create later, as the initial content of the component.
    • Define the component content as <FrosmoLogo />. This sets the FrosmoLogo component, which you'll create later, as the actual content of the component.

    For more information about the props, see Using the FrosmoPlacement component.

    <FrosmoPlacement id="frosmo-logo" defaultComponent={DefaultContent}>
      <FrosmoLogo />
    </FrosmoPlacement>
  5. Create the DefaultContent component. 

    class DefaultContent extends Component {
      render() {
        return (
          <p>I will be replaced by modification content?</p>
        );
      }
    }
  6. Create the FrosmoLogo component. Get the modification content from the content property of the frosmoModificationContext prop, and use the dangerouslySetInnerHTML element attribute provided by React to display the content. For more information about the prop, see Using the FrosmoPlacement component. For more information about the attribute, see the React documentation.

    class FrosmoLogo extends Component {
      render() {
        const content = { __html: this.props.frosmoModificationContext.content };
        return (
          <div dangerouslySetInnerHTML={content} />
        );
      }
    }
  7. Save the file. Create React App automatically refreshes in your browser and now displays the Frosmo logo above the React logo.

    Create React App with Frosmo

Here's the full source code for /src/App.js:

App.js source code
import React, { Component } from 'react';
import logo from './logo.svg';
import './App.css';
import { FrosmoPlacement } from 'frosmo-react';

class App extends Component {
  render() {
    return (
      <div className="App">
        <header className="App-header">
          <FrosmoPlacement id="frosmo-logo" defaultComponent={DefaultContent}>
            <FrosmoLogo />
          </FrosmoPlacement>
          <img src={logo} className="App-logo" alt="logo" />
        </header>
      </div>
    );
  }
}

class DefaultContent extends Component {
  render() {
    return (
      <p>I will be replaced by modification content?</p>
    );
  }
}

class FrosmoLogo extends Component {
  render() {
    const content = { __html: this.props.frosmoModificationContext.content };
    return (
      <div dangerouslySetInnerHTML={content} />
    );
  }
}

export default App;

Personalizing the content

In this example, you personalize the content by only displaying it to visitors who have not opened the logo link. You do this by creating the appropriate segment and assigning the modification to that segment. Here, the segment is based on a trigger that tracks the Frosmo Logo modification for clicks.

To personalize the content:

Copying the modification ID

To copy the modification ID:

  1. In the Control Panel, select Modifications > Overview.
  2. Find and copy the ID of the Frosmo Logo modification.

    Copying the modification ID

You now have the modification ID you need for the trigger.

Creating the trigger

To create the trigger:

  1. In the Control Panel, select Triggers.
  2. Click Create trigger.
  3. Define the following settings:

    • Name: Enter "Frosmo Logo modification click".
    • Evaluation point: Select Core event, and select Modification click as the event.
    • Rules: Click Add new rule, click Event data, and define the trigger rule as: The data value of the Modification ID property is exactly <Frosmo Logo modification ID>

    Trigger settings

  4. Click Save.

You have created the trigger. For more information about trigger settings, see Creating and editing a trigger.

Creating the segment

To create the segment:

  1. In the Control Panel, select Data Management > Segmentation > Segments.
  2. Click Create segment.
  3. Click Add new rule, and select Trigger.
  4. Define the segmentation rule as: The visitor has triggered Frosmo Logo modification click more than or equal to 1 times, with each trigger event counted.

    Segmentation rule settings

  5. Select Description, and enter "Has clicked the Frosmo logo" as the segment name.
  6. Click Save.

You have created the segment. For more information about segment settings, see Creating and editing a segment.

Updating the modification to use the segment

To update the modification to use the segment:

  1. In the Control Panel, select Modifications > Overview.
  2. In the modifications list, find the Frosmo Logo modification, and click the modification name to open the modification settings.
  3. In the Segments section, click Define segments.

    Updating the modification to use the segment

  4. Click Select segments.
  5. Select the Has clicked the Frosmo logo segment you created earlier.

    Updating the modification to use the segment

  6. At the bottom of the view, click Select.
  7. In the segment selection, select is not.

    Updating the modification to use the segment

    Updating the modification to use the segment

  8. At the bottom of the view, click Save.

You have update the modification. For more information about modification settings, see Creating and editing a modification.

If you now click the Frosmo logo and then refresh the page, the logo is no longer displayed, since you've been added to the Has clicked the Frosmo logo segment. Instead, the application displays the default content for the FrosmoPlacement component.

Create React App personalized to not display the Frosmo logo

Figure: Create React App personalized to not display the Frosmo logo

And you're done with this example!