Settings

Updated August 30, 2024 09:54

The top-level attribute in navigation JSON.

"settings": {
    "locale": "en-us",
    "currency": "USD",
    "minimumFractionDigits": 2,
    "maximumFractionDigits": 2,
    "leaveApplicationWarning": true
  }

locale used to display date, time, and datetime value
MinimumFractionDigits, maximumFractionDigits used to display percent value
currency, locale, and minimumFractionDigits, maximumFractionDigits used to display currency value

Features

Currency Symbol

General

For the currency field, Portal will use currencySymbol in the global settings and display the symbol as the field prefix.
currency in the global settings becomes deprecated.

Status

Release Available	Status	Framework Name
2.9	Current	TBC

Code JSON

"settings": {
  "currencySymbol": "£"}

The global settings can indicate that the currency symbol is a suffix.

"settings": {
  "currencySymbol": "€",
  "currencySymbolAsSuffix": true
}

At the field level (as currency), users can override the global settings.

// prefix does not display
"fieldUi": {
  "fieldType": "currency",
  "format": { "options": {...}, "prefix": false }
}

// custom prefix string
"fieldUi": {
  "fieldType": "currency",
  "format": { "options": {...}, "prefix": "..."}
}

// same as suffix

Configurable Loading Page (Mui only)

General

In global settings, users can specify the loadingPageUrl to customize an <iframe> as the global loading animation for save, submit, and query
- "settings": { "loadingPageUrl": "/apex/clcommon__PortalLoadingPage", … }
A common use case is to make the global loading animation and the animation in the splash page consistent by using the same VF page.

Status

Release Available	Status	Framework Name
3.5	Current	Mui

Splash Page Configuration

General

Custom Visualforce Components can be used as Portal Splash pages

Status

Release Available	Status	Framework Name
3.5	Current	TBC

Implementation Example

CustomPortalSplashPage is a Custom Visualforce Component created locally within the Salesforce org and can be used as a Splash page as shown below.

Be sure to set showDefaultLoadingPage as FALSE

<c:IncludePortal2 navName="playground_loading" theme="mui" showDefaultLoadingPage="false">        <c:CustomPortalSplashPage ></c:CustomPortalSplashPage>    </c:IncludePortal2>