Customize the Helpshift SDK to completely match the look and feel of your app.
UIAppearance customisations are applied to Helpshift SDK by default. However if there is a conflicting property, then the value in HelpshiftConfig.plist will take precedence.
For example: If the app uses UIAppearance to change the colour of Navigation Bar title and also specifies a colour for the same property in the HelpshiftConfig.plist file, then the value in plist will be used. In order to use the UIAppearance value, the app must leave the corresponding entry in the plist blank.
Head over to Theming and Skinning if you want to customize your SDK integration's typeface, colors or background images. It is done via simple key-value pairs in a plist file.
If you want to change strings used in the SDK's UI or want to translate them as per device language, see String Customization.
To skin your app, make sure you add
HSThemes/HelpshiftConfig.plist into your XCode project and set values for attributes in
Font size & Font name must go together
Setting Font size attribute should always be accompanied by a relevant Font name, otherwise fonts may appear odd.
Helpshift comes with two default skinning configurations -
You may want to begin with a dark theme as base. To do so, in your XCode project, rename the file
HelpshiftConfig.plist and use that instead.
If you want to customize the skinning attributes of the Helpshift SDK, there are 2 options:
HelpshiftCustomConfig.plistand add this file to your application's main bundle.
Helpshift SDK will first look for the
HelpshiftCustomConfig.plist file in the Application's main bundle.
If it fails to find such a file, it will look for the
HelpshiftConfig.plist file in the Helpshift SDK's bundle.
We'll now walk through each group of customizations -
These attributes control the looks of in-app support over many screens.
Association of "Global Attributes" to UI elements -
With iOS 7, support UI is layered differently. As a consequence, background for section headers is transparent, hence it inherits from Background color in Global Attributes -
While iOS 7 allows developers to set a background color on search bars, it forbids one from controlling the Cancel button's color. While Apple may fix this soon, we're aware of this and are working on ways around this issue. You should avoid complete white (FFFFFF), and lighter shades for the "Background color" attribute so that Cancel button remains easily visible.
A retry badge is shown on messages in conversation screen, that fail to reach customers.
Add the font to your project. Edit your app's plist file
"Fonts provided by application" to it. Under the key, list out file names of all the fonts you want to use in your app and in support. If you've already listed such fonts, skip this step.
Copy the font's full name. To do this, select the font in Finder and hit Command ⌘+I (Get Info).
Paste the font name into HelpshiftConfig.plist, wherever necesary
Starting 5.10.0, if you need to apply font name and bold font name to Single FAQ screen, you need to add the font file name and bold font file name in HelpshiftConfig.plist
Test the font in simulator. Errors in font names are ignored by the SDK —
By default, the iOS SDK will follow the orientation of the ViewController that launched the Helpshift screen. If the ViewController is in portrait mode, the SDK will be locked to portrait orientation for the duration of the Helpshift session. If the ViewController is in landscape mode, the SDK will be locked to landscape orientation for the duration of the Helpshift session.
If you are having issues with skinning the SDK, head over to the Troubleshooting section for further information.