@bloomreach/react-sdk

Bloomreach React SDK

Bloomreach React SDK provides simplified headless integration with Bloomreach Experience Manager for React-based applications. This library interacts with the Page Model API and Bloomreach SPA SDK and exposes a simplified declarative React interface over the Page Model.

What is Bloomreach Experience Manager?

Bloomreach Experience Manager (brXM) is an open and flexible CMS designed for developers and marketers. As the original headless CMS, brXM allows developers to build quickly and integrate with the systems. While it’s built for speed, it also provides top-notch personalization and channel management capabilities for marketers to drive results.

Features

• brXM Page React component;
• brXM Components React component;
• Manage Content Button;
• Manage Menu Button;
• Context API support;
• Hooks API support;
• Next.js support;
• React Router and Next Routes support;
• Enzyme and Jest support.

Get Started

Installation

To get the SDK into your project with NPM:

npm install @bloomreach/react-sdk

And with Yarn:

yarn add @bloomreach/react-sdk

Usage

The following code snippet renders a simple page with a Banner component.

import React from 'react';
import axios from 'axios';
import { BrComponent, BrPage, BrPageContext, BrProps } from '@bloomreach/react-sdk';

function Banner({ component }: BrProps) {
  return <div>Banner: {component.getName()}</div>;
}

export default function App() {
  const config = { /* ... */ };

  return (
    <BrPage configuration={config} mapping={{ Banner }}>
      <header>
        <BrPageContext.Consumer>
          { page => <Link to={page.getUrl('/')} />Home</Link> }
        </BrPageContext.Consumer>
        <BrComponent path="menu"><Menu /></BrComponent>
      </header>
      <section>
        <BrComponent path="main" />
      </section>
      <BrComponent path="footer">
        <footer><BrComponent /></footer>
      </BrComponent>
    </BrPage>
  );
}

Configuration

The BrPage component supports several options you may use to customize page initialization. These options will be passed to the initialize function from @bloomreach/spa-sdk. See here for the full configuration documentation.

Mapping

The BrPage component provides a way to link React components with the brXM ones. It requires to pass the mapping property that maps the component type with its representation.

• The Container Items can be mapped by their labels.

  import NewsList from './components/NewsList';
  
  return <BrPage mapping={{ 'News List': NewsList }} />;
  

• The Containers can be only mapped by their type, so you need to use constants from @bloomreach/spa-sdk. By default, the React SDK provides an implementation for all the container types as it's defined in the documentation.

  import { TYPE_CONTAINER_INLINE } from '@bloomreach/spa-sdk';
  import MyInlineContainer from './components/MyInlineContainer';
  
  return <BrPage mapping={{ [TYPE_CONTAINER_INLINE]: MyInlineContainer }} />;
  

  From within the Container component, the Container Items can be accessed via the children property. This can be used to reorder or wrap child elements.

  export default function MyInlineContainer() {
    return (
      <div>
        {React.Children.map(props.children, child => (
          <span className="float-left">
            {child}
          </span>
        ))}
      </div>
    );
  }
  

• The Components can be mapped by their names. It is useful for a menu component mapping.

  import Menu from './components/Menu';
  
  return <BrPage mapping={{ menu: Menu }} />;
  

Inline Mapping

There is also another way to render a component. In case you need to show a static component or a component from the abstract page, you can use inline component mapping.

return <BrComponent path="menu"><Menu /></BrComponent>

It is also possible to point where the component's children are going to be placed.

return (
  <BrComponent path="footer">
    <footer><BrComponent /></footer>
  </BrComponent>
);

The component data in case of inline mapping can be accessed via the BrComponentContext.

return (
  <BrComponentContext.Consumer>
    {component => (
      <BrComponent path="footer">
        <footer>
          &copy; {component.getName()}
          <BrComponent />
        </footer>
      </BrComponent>
    )}
  </BrComponentContext.Consumer>
);

Or by using React Hooks.

import { BrComponentContext } from '@bloomreach/react-sdk';

export default function Menu() {
  const component = React.useContext(BrComponentContext);

  return <ul>{component.getName()}</ul>;
}

Reference

The React SDK is using Bloomreach SPA SDK to interact with the brXM. The complete reference of the exposed JavaScript objects can be found here.

BrPage

This is the entry point to the page model. This component requests and initializes the page model, and then renders the page root component with React children passed to this component. The component also sets the page object into BrPageContext.

Property	Required	Description
configuration	yes	The configuration of the SPA SDK.
mapping	yes	The brXM and React components mapping.
page	no	Preinitialized page instance or prefetched page model. Mostly that should be used to transfer state from the server-side to the client-side.

BrComponent

This component points to where children or some component should be placed. BrComponent can be used inside BrPage or mapped components only. If React children are passed, then they will be rendered as-are. Otherwise, it will try to render all children components recursively.

Property	Required	Description
path	no	The path to a component. The path is defined as a slash-separated components name chain relative to the current component (e.g. main/container). If it is omitted, all the children will be rendered.

BrManageContentButton

This component places a button on the page that opens the linked content in the document editor. The button will only be shown in preview mode.

Property	Required	Description
content	yes	The content entity to open for editing.

BrManageMenuButton

This component places a button on the page that opens the linked menu in the menu editor. The button will only be shown in preview mode.

Property	Required	Description
menu	yes	The related menu model.

BrComponentContext

The React Context holding the current brXM Component.

BrPageContext

The React Context holding the current brXM Page.

Links

• SPA integration concept.
• Page Model API introduction.
• Bloomreach SPA SDK.

FAQ

• Information about common problems and possible solutions can be found on the troubleshooting page.
• Information about the recommended setup can be found on the best practices page.

License

Published under Apache 2.0 license.