Fluent Commerce Logo
Docs
Help & Feedback

Content in this track:

UX Framework - Overview

1

Component SDK - Overview

2

UX Framework - Component Library

3

UX Framework - Configuration Guide

4

UX Configuration - Common Concepts

5

Configure a drawer via manifest

6

Configure UI for Mixed Baskets

7

fc.mystique.fields.basicpack

8

End Of Track

9

Component SDK - Overview

Essential knowledge

Author:

Fluent Commerce

Changed on:

8 July 2024

Overview

General Principles and the Features of the SDK

Key points

  • General Principles
  • Features of the SDK
  • Developer setup

General Principles

The Component SDK allows clients and partners to develop new components to extend the functionality of the Fluent web apps.Areas of extension include:
new cards to display information from Fluent APIs or external sourcesnew form field types that work with rules to extend user action capabilityentirely new customised pages
No alt providedNo alt providedNo alt provided
Custom components are generic React components, but via provided hooks can also take advantage of core features of the UX framework, including:
  • configurable via the manifest (which means no-code updates to apps)
  • fetching and displaying data from the Fluent APIs
  • internationalization of any text labels based on the user profile
  • auto-adapt to workflows (generating new user action forms when the workflow changes)
  • showing and hiding content based on the logged-in user's roles and permissions

Features of the SDK

Hooks

Custom components can easily interact with OMX functionality via the provided hooks.

Utility Components

Some utility components are provided to make building custom components easier and more consistent.

Registries

Before a custom component can be used in an OMX web app, it must be registered with one of the three registries:
  • Component Registry - for standard in-page components
  • Field Registry - for interactive form field components
  • Template Registry - for adding new template helpers
Details on each can be found on the registries page.

Developer setup

Information on getting started, setting up your project, and unit testing can be found here.

Related content

Component SDK
Edited 593 days ago
The Component SDK allows clients and partners to develop new components to extend the functionality of the Fluent Web Apps.
Component SDK - Getting Started
Edited 798 days ago
Getting Started Guide for Component SDK
Debugging the Component SDK
Edited 798 days ago
Fluent Commerce

Fluent Commerce

Knowledge Tracks Related To This Topic

Getting started with OMX UX Framework
  • UX Framework - Overview
  • Component SDK - Overview
  • UX Framework - Component Library
  • UX Framework - Configuration Guide
  • UX Configuration - Common Concepts
  • Configure a drawer via manifest
  • Configure UI for Mixed Baskets
  • fc.mystique.fields.basicpack
    • 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