Fluent Commerce Logo
Docs
Help & Feedback
Sign In

Escaping / unescaping of values in UX Framework

Essential knowledge

Author:

Fluent Commerce staff

Changed on:

10 Mar 2024

Overview

Character escaping and unescaping are crucial for data integrity and security in UX frameworks. This document focuses on the Mustache.js templating engine, which escapes HTML by default to prevent XSS attacks. When special characters like ampersands need to be displayed, the framework offers unescaping methods to ensure correct and secure rendering.

This overview highlights the significance of proper value escaping and the techniques for accurately rendering special characters within the UX framework.

Key points

  • Mustache.js Templating: The UX framework utilizes mustache.js for templating, which automatically escapes HTML characters. This is important for preventing XSS (Cross-Site Scripting) attacks and ensuring data is displayed as intended.
  • Unescaping Variables: To display special characters properly, such as ampersands, you must unescape variables using triple mustaches, e.g., 
    `{{{variable}}}`
    , or the 
    `&`
    symbol in the variable tag, e.g., 
    `{{&variable}}`
    .
  • Correct Display of Values: Escaping or unescaping variables correctly is crucial for the accurate representation of data within the UX. This ensures that special characters are rendered as intended, maintaining the integrity of the information displayed to users.

Problem

See the 

`PICK&PACK`
value below, where the actual order status is 
`PICK&PACK`

No alt provided

Solution

The UX framework templating is based on mustache.js (https://mustache.github.io/)

By default, all variables are HTML-escaped. If you want to render unescaped HTML, use the triple mustache, e.g. 

`{{{status}}}`
. You can also use 
`&`
to unescape a variable, e.g. 
`{{&status}}`
. This will display the value correctly

No alt provided
Fluent Commerce staff

Fluent Commerce staff

Building Blocks
All Building Blocks
Packages & Modules
UI Components
Workflows
Settings
Interface Contracts
Rules
By Type
All Types
Courses
Extend
Glossary
How-to Guides
Knowledge Tracks
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

Copyright © 2024 Fluent Retail Pty Ltd (trading as Fluent Commerce). All rights reserved. No materials on this docs.fluentcommerce.com site may be used in any way and/or for any purpose without prior written authorisation from Fluent Commerce. Current customers and partners shall use these materials strictly in accordance with the terms and conditions of their written agreements with Fluent Commerce or its affiliates.

Fluent Logo