Fluent Commerce Logo
Docs
Help & Feedback

Content in this track:

Extending the UX Framework with the Component SDK

1

Building Custom Components with the Component SDK

2

Setting Up Your Component SDK Project

3

Client Scenario: Building a Product Availability Map

4

Creating and Registering a Custom Component

5

Configuring Custom Components via the Manifest

6

Accessing User and Location Context with the useAuth Hook

7

Integrating a Third-Party Map Component

8

Adding Nested (Child) Components

9

Accessing Page Query Data

10

Style and Theme Your Component

11

Make Your Component Interactive

12

Configuring Components with Settings

13

Configuring Components with Dynamic Attributes

14

Extending Forms with Custom Field Components

15

Implementing a Custom Form Field

16

Enhance Your Custom Fields: Leveraging Existing Components from the Registry

17

Fetching Data with the useQuery Hook

18

Completing the Custom Form Field: Outputting the Result

19

Creating Custom Template Helpers

20

Unit Testing Custom Components

21

Deploying a Custom Component Plugin

22

End Of Track

23

Creating Custom Template Helpers

Essential knowledge

Authors:

Cameron Johns, Cille Schliebitz, Anita Gu

Changed on:

3 Feb 2025

Overview

This lesson explores the creation and registration of custom template helpers within the Component SDK. Template helpers are powerful utilities that can be used within Manifest documents for tasks like styling, formatting, and calculations. We'll demonstrate how to create a custom template helper, in this case, one that bolds entity references, showcasing how to leverage the `TemplateRegistry` and its utility methods for generating formatted HTML.

Key points

  • Template Helpers: Template helpers are reusable functions that can be called within Manifest documents to perform various operations.
  • Use Cases: Template helpers can be used for styling, formatting, calculations, and other data transformations.
  • `TemplateRegistry`: The `TemplateRegistry` is used to register custom template helpers, making them available for use in Manifests.
  • HTML Formatting: The lesson demonstrates creating a template helper that bolds entity references using `TemplateRegistry` utility methods for formatted HTML generation.
  • Customizability: Custom template helpers extend the functionality of Manifests, allowing for greater flexibility and control over data presentation.
Another useful feature of the Component SDK is the ability to create custom helpers for the Manifest document. The UX Framework provides a number of these as standard, but you can also create and register your own.You can use them for various things such as:
  • Styling
  • Formatting
  • Calculations
Example:Let's say that you would like to style all entity references displayed in a specific style, such as bold.You can create a "bold" template like this:No alt provided
Cameron Johns

Cameron Johns

Contributors:
Cille Schliebitz
Anita Gu

Knowledge Tracks Related To This Topic

Component SDK
  • Extending the UX Framework with the Component SDK
  • Building Custom Components with the Component SDK
  • Setting Up Your Component SDK Project
  • Client Scenario: Building a Product Availability Map
  • Creating and Registering a Custom Component
  • Configuring Custom Components via the Manifest
  • Accessing User and Location Context with the useAuth Hook
  • Integrating a Third-Party Map Component
  • Adding Nested (Child) Components
  • Accessing Page Query Data
  • Style and Theme Your Component
  • Make Your Component Interactive
  • Configuring Components with Settings
  • Configuring Components with Dynamic Attributes
  • Extending Forms with Custom Field Components
  • Implementing a Custom Form Field
  • Enhance Your Custom Fields: Leveraging Existing Components from the Registry
  • Fetching Data with the useQuery Hook
  • Completing the Custom Form Field: Outputting the Result
  • Creating Custom Template Helpers
  • Unit Testing Custom Components
  • Deploying a Custom Component Plugin
    • Building Blocks
    Building Blocks
    Packages & Modules
    All UI Components
    Workflows
    Settings
    Interface Contracts
    All Rules
    By Type
    All Types
    Knowledge Tracks
    Extend Knowledge
    Glossary
    All How-to Guides
    Sitemap
    Topics
    Use Cases
    Helpful Resources
    Platform Limits
    Support Policy
    Service Level Agreement (SLA) - Enterprise
    Deprecation Policy
    Extend Knowledge Content – Terms and Conditions
    System and Organization Controls (SOC) 3 Report
    Data Privacy Addendum
    Security Policy
    Quick Links
    For Partners
    Customer Resources
    Webinars and Events
    Certifications
    Training Resources
    Knowledge Tracks
    Builders Portal
    Product Update Newsletter
    Industry Blogs & Events Newsletter
    Trust Center Portal

    Copyright © 2024-2026 Fluent Retail Pty Ltd (trading as Fluent Commerce). Unless otherwise expressly stated in a current written agreement with Fluent Commerce or any of its affiliates or on any single page of the docs.fluentcommerce.com site, use of the materials on this site is strictly limited to viewing by individuals over 18 years old for legitimate commercially appropriate reasons; and any downloading, copying or other actions or uses of any kind or by any means of the materials on this site, including by artificial intelligence tools, is strictly prohibited. All other rights reserved.

    Fluent Logo