Overview

As most UI configurations are primarily made from the OneTrust tenant, this section is optional. If your app has a use case where it needs to make additional configurations (e.g. font family) otherwise not available to be configured in the tenant or if it needs to control the UI configurations locally, you can use this custom configuration functionality.

UI elements are configured through a plist supplied by OneTrust. See the Sample App for a demo.

Import the Custom UI Property List

1. Download the Sample App from your tenant. Steps here.
2. After unzipping the file:
   1. Access the OTPublishersHeadlessSDK-XCFramework
   2. Select your corresponding file (if tvOS, select OTPublishersHeadlessSDKtvOS. If iOS, select the other one)
   3. Select OTPublishersHeadlessSDK.xcframework > ios-arm64
   4. OTPublishersHeadlessSDK.framework > OTSDK-UIConfig-iOS.plist

tvOS will follow the same steps but with tvos file labels.

3. Copy the plist file into your app. Select 'Copy items if needed' to ensure the plist is added to the application folder hierarchy.
4. Edit the UI elements in the plist as necessary.

👍

Do not add any rows or change the keys itself in the plist. Only change the values of existing properties.

Styles set in the plist will be given priority over server values when rendering the UI if the custom config property is set.

Configure the SDK

1. As part of the UIConfigurator protocol, set shouldUseCustomUIConfig() to true.
2. As part of the UIConfigurator protocol, conform to customUIConfigFilePath().
   1. While conforming to this method, provide the path to the plist.

//iOS and tvOS

//Conform to this in order to customize the UI locally
OTPublishersHeadlessSDK.shared.uiConfigurator = self

extension AppDelegate: UIConfigurator {
    func shouldUseCustomUIConfig() -> Bool {
      return true
    }
    
    func customUIConfigFilePath() -> String? {
      //path to plist file
      let customPath = Bundle.main.path(forResource: "OTSDK-UIConfig-iOS", ofType: "plist")
      return customPath
    }
}

Customize the UI

This section describes the UI elements that can be configured.

Table of contents:

1. Customizing the Global Theme
2. Customizing the Navigation Bar
3. Customizing the Banner View
4. Customizing the Preference Center View
5. Customizing the Purpose Details View
6. Customizing the Vendor List View
7. Customizing the Vendor Details View
8. Customizing the SDK List View
9. Customizing the App Tracking Transparency Pre and Settings Prompt View
10. Custom Fonts

Customizing the Global Theme

All global theme related customizations are listed under globalTheme. This is a common theme that will be applied across all UI views.

The following are the customizations available:

Customizing Page Headers (Navigation Bar)

All page header related customizations are listed underpageHeader in the plist. This is a common theme that will be applied to all the SDK view navigation bars.

The following are the customizations available:

📘

Note

• When a custom fontName is provided, at least one of the fontSize or fontTextStyle should also be provided in order for it to reflect.
• In order for dynamic font sizes to be supported, the application will have to provide a valid value for fontTextStyle if customizing the fonts.

Customizing the Banner UI

All banner view related customizations are listed under bannerTheme in the plist.

The following are the customizations available for the Banner View:

Here's a list of possible UI styles that can be changed under each applicable element above:

📘

Note

• When a custom fontName is provided, at least one of the fontSize or fontTextStyle should also be provided in order for it to reflect.
• In order for dynamic font sizes to be supported, the application will have to provide a valid value for fontTextStyle if customizing the fonts.

Customizing the Preference Center UI

All preference center view related customizations are listed under preferenceCenterTheme in the plist.

The following customizations are available for the Preference Center View:

Here's a list of possible UI styles that can be changed under each applicable element above:

📘

Note

• When a custom fontName is provided, at least one of the fontSize or fontTextStyle should also be provided in order for it to reflect.
• In order for dynamic font sizes to be supported, the application will have to provide a valid value for fontTextStyle if customizing the fonts.

Customizing the Purposes Details UI

All purpose detail view related customizations are listed under purposeDetailsTheme in the plist.

The following customizations are available for the Purpose Details View:

Here's a list of possible UI styles that can be changed under each applicable element above:

📘

Note

• When a custom fontName is provided, at least one of the fontSize or fontTextStyle should also be provided in order for it to reflect.
• In order for dynamic font sizes to be supported, the application will have to provide a valid value for fontTextStyle if customizing the fonts.

Customizing the Vendor List UI

All vendor list view related customizations are listed under vendorListTheme in the plist.

The following customizations are available for the Vendor List View:

Here's a list of possible UI styles that can be changed under each applicable element above:

📘

Note

• When a custom fontName is provided, at least one of the fontSize or fontTextStyle should also be provided in order for it to reflect.
• In order for dynamic font sizes to be supported, the application will have to provide a valid value for fontTextStyle if customizing the fonts.

Customizing the Vendor Details UI

All vendor list view related customizations are listed under vendorDetailsTheme in the plist.

The following UI Elements are the customizations available for the Vendor Details View:

Here's a list of possible UI styles that can be changed under each applicable element above:

📘

Note

• When a custom fontName is provided, at least one of the fontSize or fontTextStyle should also be provided in order for it to reflect.
• In order for dynamic font sizes to be supported, the application will have to provide a valid value for fontTextStyle if customizing the fonts.

Customizing the SDK List UI

All SDK List view related customizations are listed under sdkListTheme in the plist.

The following UI Elements are the customizations available for the SDK List View:

Here's a list of possible UI styles that can be changed under each applicable element above:

📘

Note

• When a custom fontName is provided, at least one of the fontSize or fontTextStyle should also be provided in order for it to reflect.
• In order for dynamic font sizes to be supported, the application will have to provide a valid value for fontTextStyle if customizing the fonts.

Customizing the App Tracking Transparency Pre and Settings Prompt

All ATT pre and settings prompt view related customizations are listed under permissionConsentTheme in the plist.

The following UI Elements are the customizations available for the ATT Prompt View:

Here's a list of possible UI styles that can be changed under each applicable element above:

📘

Note

• When a custom fontName is provided, at least one of the fontSize or fontTextStyle should also be provided in order for it to reflect.
• In order for dynamic font sizes to be supported, the application will have to provide a valid value for fontTextStyle if customizing the fonts.

Custom Fonts

To change the font:

1. Add custom fonts to Xcode (if custom): Apple documentation
2. Reference the font in the fontName key of the plist. Ensure you specify a fontSize for the custom font to take effect.