StringHelper

A static utility class providing common string manipulation methods such as HTML encoding, camelCase conversion, regular expression escaping, and markdown-to-HTML processing.

StringHelper.encodeHtml('<script>alert("xss")</script>');
// '<script>alert("xss")</script>'

StringHelper.capitalize('hello'); // 'Hello'
StringHelper.hyphenate('fontSize'); // 'font-size'

Useful functions

Function	Description
encodeHtml	Encode HTML entities in a string
capitalize	Capitalize the first letter of a string
hyphenate	Convert camelCase string to hyphen-case
escapeRegExp	Escape special RegExp characters in a string

Functions

Functions are methods available for calling on the class

encodeAttributeSelector( attr, value )
: String

static
Escapes " and \ in CSS attribute selectors, e.g. [data-id="somevalue"]

Usage:
```
document.querySelector(StringHelper.cssAttributeQuery('data-id', 'id with & \\ chars'))
```
escapeRegExp( string )
: String

static

Escapes special RegExp characters.
generateUUID( )
: String

static

Generates a UUID. Uses Crypto.randomUUID() if available, otherwise generates a random UUID using Crypto.getRandomValues().
initHtmlEntities( mappings )

private

static

Initializes HTML entities used by encodeHtml and decodeHtml.
parseMarkdown( md )
: String

internal

static

Parses Markdown text into a structured format
stripDiacritics( str )
: String

static

Converts letters with diacritics to their base letter equivalents. For example, "Ångström" becomes "Angstrom".
toJavaScriptString( obj, options )
: String

internal

static

Converts an object into a JavaScript string (not JSON).

For example { a: 1, b: [2, 3] } -> "'{ a: 1, b: [2, 3] }'"
toJavaScriptValue( value, options )
: String

internal

static

Converts a value to a JavaScript string (not JSON).

For example a date to "new Date(y, m, d)", an array to "[...]" etc.
xss( strings, ...values )
: String

static
This is a tagged template function that performs HTML encoding on replacement values to avoid XSS (Cross-Site Scripting) attacks.

For example:
```
 eventRenderer(eventRecord) {
 return StringHelper.xss`${eventRecord.name}`;
 }
```
xssBR( )

internal

static
This is a tagged template function that performs HTML encoding on replacement values to avoid XSS (Cross-Site Scripting) attacks. Unlike xss, this method converts \n and \r characters into   tags.

For example:
```
 eventRenderer(eventRecord) {
 return StringHelper.xssBR`${eventRecord.name}`;
 }
```
See encodeHtmlBR.
decodeHtml( str )
: String

static

This method decodes HTML entities and returns the original HTML.

See also encodeHtml.
encodeHtml( str )
: String

static

This method encodes HTML entities and returns a string that can be placed in the document and produce the original text rather than be interpreted as HTML. Using this method with user-entered values prevents those values from executing as HTML (i.e., a cross-site scripting or "XSS" security issue).

See also decodeHtml.
encodeHtmlBR( str )
: String

internal

static

This method is similar to encodeHtml except that \n and \r characters in the given str are replaced by   tags after first being encoded by encodeHtml.
isHtml( text )
: Boolean

internal

static

Returns true if the provided text contains special HTML characters.
stripHtmlTags( str )
: String

static

Removes all HTML tags from the passed string and decodes HTML entities.
safeJsonParse( string )
: Object

static

Parses JSON inside a try-catch block. Returns null if the string could not be parsed.
safeJsonStringify( object, replacer, space )
: String

static

Stringifies an object inside a try-catch block. Returns null if an exception is encountered.

See JSON.stringify on MDN for more information on the arguments.
createId( inString )
: String

internal

static

Creates an alphanumeric identifier from any passed string. Encodes spaces and non-alpha characters.
joinPaths( paths, pathSeparator/ )
: String

internal

static

Joins all given paths together using the separator as a delimiter and normalizes the resulting path.
split( str, delimiter )
: String[]

internal

static
Returns the provided string split on whitespace. If the string is empty or consists of only whitespace, the returned array will be empty. If str is not a string, it is simply returned. This allows null or already split strings (arrays) to be passed through.

For example:
```
 console.log(StringHelper.split(' abc def xyz   '));
 > ['abc', 'def', 'xyz']
 console.log(StringHelper.split(''));
 > []
```
Compare to the standard split() method:
```
 console.log(' abc def xyz   '.split(/\s+/));
 > ['', 'abc', 'def', 'xyz', '']
 console.log(''.split(/\s+/));
 > ['']
```
capitalize( string )
: String

static

Capitalizes the first letter of a string, "myString" -> "MyString".
hyphenate( string )
: String

internal

static

Converts the passed camelCased string to a hyphen-separated string. eg "minWidth" -> "min-width"
hyphenateAttributeName( string )
: String

internal

static

Converts the passed camelCased string to a hyphen-separated attribute name when it has a recognized prefix. Use for e.g. dataUserId -> data-user-id or ariaDescribedBy -> aria-described-by.
separate( string )
: String

internal

static

Converts the passed camelCased string to a capitalized, space-separated string. eg "startDate" -> "Start date".
uncapitalize( string )
: String

static

Makes the first letter of a string lowercase, "MyString" -> "myString".

Source path

Core/helper/StringHelper.js

Inheritance tree1

StringHelper

StringHelper

Useful functions

See also

Functions

Source path

Inheritance tree1

Contents