Frontend

Bloomreach provides SDKs for integrating Bloomreach Content with single-page applications (SPAs).

HST for SPA SDK integration uses the Delivery API to let an external single-page application consume content and render pages.

Experience Manager SPA integration uses postMessage-based communication between a Single Page Application and Bloomreach Content.

Use the SPA SDK to integrate a single-page application with Bloomreach Content.

Single-Page Application integration with Bloomreach Content uses the @bloomreach/spa-sdk and @bloomreach/react-sdk libraries.

URL Rewriter rules reverse-proxy an external Single Page Application so it is served from the same host as Bloomreach Content.

SPA SDKs are JavaScript and TypeScript libraries maintained by Bloomreach for JavaScript-based front ends.

The Bloomreach SPA SDK GitHub repository contains example projects for multiple frontend frameworks at https://github.com/bloomreach/spa-sdk/tree/main/examples.

The Delivery API, formerly the Page Model API, is a REST API endpoint for single-page applications (SPAs).

Bloomreach Commerce Accelerator includes built-in support for Single Page Applications and exposes Commerce Model objects through the Delivery API in JSON format.

Delivery API 0.9 is the default API version in brXM 14.x and is not supported in brXM 15 and later.

The Delivery API, formerly Page Model API, is enabled in the delivery tier by configuring the Delivery API path on a virtual host or mount.

JSON Web Token (JWT) authentication provides access to preview data for a channel through the Delivery API.

Bloomreach Content provides two primary APIs for Single Page Application (SPA) integration: the Delivery API and the Content REST API.

The HstRequest and HstRequestContext APIs contribute model objects to the Delivery API, formerly the Page Model API, through setModel(String, Object).

Bloomreach Content uses built-in Jackson Mixin Types to control how HST Content Beans serialize to JSON.

Delivery API v0.9 exposes Swagger API documentation at /swagger.json by default, and the endpoint path is configurable with pagemodelapi.v09.apiDocPath in /WEB-INF/hst-config.properties.

The Delivery API reserves specific field names for internal use and standard properties.

An Open UI page tool is configured as a frontend:uiExtension node under /hippo:configuration/hippo:frontend/cms/ui-extensions.

An Open UI document field extension is configured as a frontend:uiExtension node under /hippo:configuration/hippo:frontend/cms/ui-extensions.

A page tool in Bloomreach Content uses the Open UI extension library to display information about the current page or interact with page-level data through a custom UI extension.

Bloomreach Content supports custom document field extensions in the content editor.

A Document Field Extension acts as a field within a document type and appears in the document editing template like any other field.

The Bloomreach Open UI Extension JavaScript Client Library provides a stable public API for custom UI extensions and handles communication with the CMS UI by abstracting window.postMessage.

A page tool is an external web application displayed alongside a page in Experience manager, and it extends Bloomreach Content with third-party functionality.

Open UI extensions use a style guide to match the Bloomreach Content user interface.

Bloomreach Content page tools are custom UI extensions for pages in the Experience Manager.

Open UI dialogs run inside an iframe with a header bar that contains a title and a close button.

Commerce Open UI Pickers work in non-Bloomreach Commerce Accelerator projects on brXM v14.6.1 or later.

The Content Component is implemented by org.onehippo.cms7.essentials.components.EssentialsContentComponent.

The Document Component exposes a document’s content as a Java bean to the rendering template, such as JSP or Freemarker.

The List Component runs repository queries against documents and passes the results to the rendering template.

The List Picker Component exposes up to 10 manually selected related documents as Java beans to the rendering template.

The News component is implemented by org.onehippo.cms7.essentials.components.EssentialsNewsComponent and extends the List component.

The Events component is implemented by org.onehippo.cms7.essentials.components.EssentialsEventsComponent.

The Carousel Component uses the class org.onehippo.cms7.essentials.components.EssentialsCarouselComponent.

The Image Component retrieves an image or image set from the repository and makes it available to the rendering template.

The Video Component uses the implementation class org.onehippo.cms7.essentials.components.EssentialsVideoComponent.

The Facets Component uses Bloomreach Content faceted navigation to filter and refine search results based on document properties.

The Search Component uses the class org.onehippo.cms7.essentials.components.EssentialsSearchComponent.

The Menu Component renders a manually maintained HST menu in a site component.

Dynamic Components are available in brXM 14.3.0 and later.

BaseHstDynamicComponent is the class name for the Base Dynamic Component, available in brXM 14.3.0 and later.

The DocumentQueryDynamicComponent extends the Base Dynamic Component to support document queries and result listing.

The Dynamic Menu Component renders the contents of a single selected site menu tree in the Page Model API.

Dynamic component configuration uses hst:componentdefinition nodes in the component catalog to expose parameters through the Delivery API and render configuration dialogs in the Channel Editor UI.

The hst:manageContent tag renders a Manage Content button in Bloomreach Content channel previews.

The hst:cmseditmenu tag renders an Edit menu button in the Channel Editor when the channel is previewed in the CMS.

Manage content and Edit menu buttons in Bloomreach Content render as <a> elements with the hst-fab class.

Child HstComponent instances can be rendered explicitly by name or aggregated dynamically in a JSP or Freemarker template.

Generic templates render multiple content types with a consistent layout in Bloomreach Content.

An HST Component can render its output inside a wrapper element to make the component markup easier to target from client-side code such as JavaScript.

Search query results in the Bloomreach Content delivery tier render from an HstQueryResult object returned by either the Fluent Search API or the Legacy Search API.

Rich text image rendering can override the image variant stored in content at render time.

Inline images on detail pages use a context-aware lightbox that defaults to the threecolumn image variant.

The HstRequestContext interface exposes preview-detection methods for request context in templates.

The document editor includes a View menu that lists all channels where the current document can be previewed.

Web files are static web resources such as CSS, JavaScript, images, fonts, and templates managed in the Bloomreach Content content repository.

Bloomreach Content keeps live and preview configurations separate for channels.

Web Files use aggressive browser and intermediary caching, with the HST framework setting the Expires header to one year.

Rich text content renders links as relative URLs by default, including both href and src attributes.

Bloomreach Content generates context aware, canonical, preferred, and navigationStateful URLs for content delivery and navigation.

The org.hippoecm.hst.content.beans.standard.HippoBean interface provides getAvailableTranslations() to retrieve all available translations for a bean.

Channel settings participate in the preview and live configuration cycle only when the hst:channel node is located under the hst:workspace node in the non-inherited HST configuration for the current channel.

Switch template support configures multiple Freemarker template variants for a component.

The HST tag library substitutes variables in content at runtime when message keys or variables are not known at compile time.

Partial page rendering URLs let a navigational URL target a specific dynamic page fragment managed by the WCMS instead of rendering the full page.

Editing a menu item in the Channel Editor locks the entire menu, preventing other users from editing that menu until the changes are published or discarded.

Static I18N in the delivery tier (HST) uses Java resource bundles and virtual host configuration.