Developers

Skinning & Customization

Customize the Helpshift SDK to completely match the look and feel of your app.

Theming and Skinning

By default, the Helpshift SDK uses the HelpshiftConfig.plist file for theme related values. To skin your app, make sure you add HelpshiftConfig.plist into your XCode project and set values for attributes in HelpshiftConfig.plist

Update Helpshift Theme

If you want to update the Helpshift Theme from a file different from HelpshiftConfig.plist, use the below API call whenever you want to make the switch.

Example:

if(enableDarkMode) {
  [HelpshiftSupport updateThemeFromFile:@"HelpshiftConfigDark"];
} else {
  [HelpshiftSupport updateThemeFromFile:@"HelpshiftConfig"];
}

This API will return the status of the update operation. It will return YES if the theme has been successfully updated. NO otherwise
This API will return NO if the SDK session is already active when trying to change the theme.

Global Attributes

Window background color: Background color for all Helpshift views
Illustration color: Image masking color.
Primary title color: Text color for titles.
Secondary text color: Text color for description texts below titles.
Toolbar switch has icons: A boolean that switches between icons and text labels for toolbar items.

Button Global

Corner Radius: Radius for rounded button.
Has Shadow: A boolean that switches the button shadow on and off.


Primary button	Secondary button	Primary disabled button	Secondary disabled button

Primary button

Gradient top: The top color for buttons gradient background
Gradient bottom: The bottom color for buttons gradient background
Border color: The border color for button
Text color: The color for button text.

Secondary button

Gradient top: The top color for buttons gradient background
Gradient bottom: The bottom color for buttons gradient background
Border color: The border color for button
Text color: The color for button text.

Primary disabled button

Gradient top: The top color for buttons gradient background
Gradient bottom: The bottom color for buttons gradient background
Border color: The border color for button

Secondary disabled button

Gradient top: The top color for buttons gradient background
Gradient bottom: The bottom color for buttons gradient background
Border color: The border color for button

FAQ

Sidebar background color: The background color for the sidebar where FAQs are displayed.
Sidebar border color: The color of the sperator besides FAQ sidebar.
Sidebar active item text color: The color of the text of selected row.
Sidebar active item background color: The background color of the selected row.
Sidebar text color: The color of the row text.
Title color: Color of the FAQ title.
Body text color: Color of the FAQ body.
Link color: Color of the Hyperlinks in FAQ body.
Helpfullness label color: Color of the text at the bottom of FAQ that ask wether the FAQ was Helpful or not.

Conversation

Attachment color: Color of the attachment button
Attachment disabled color: Color of the attachment button when disabled
Composer border color: Color of the divider on New Issue filing screen
Composer background color: Color of the background.
Composer label text color: Color of text fields.
Text field text color: Color of the text fields text
Text field border color: Color of the text fields border
Text field background color: Color of the text fields background
Agent bubble text color: Color of the text in Agent's reply
Agent bubble link color: Color of the link in Agent's reply
Agent bubble background color: Color of the bubble with Agent's reply
User bubble text color: Color of the text in User's reply
User bubble link color: Color of the link in User's reply
User bubble background color: Color of the bubble with User's reply
Time stamp color: Color of the timestamp
Attachment type color: Color of the attachment type, size, file icon elements
Attachment download color: Color of the attachement download button
Special message text color: Color of the text in the special messages
Special message background color: Color of the background in the special messages
Special message border color: Color of the border in the special messages
Reveal in finder color: Color of the magnifying glass to reveal a downloaded file
End of conversation text color: Color of the text in dialog for Issue resolution
End of conversation dot color: Color of the dots in dialog for Issue resolution
Rating star color: Color of the stars in dialog for Issue resolution
Rating star hover color: Hovering Color of thestars in dialog for Issue resolution
Text field placeholder color: Color of the placeholder text in text input fields

Search

Border color: Color of the border on search screen.
Result hover color: Hovering color of the search results.
FAQ title color: Color of the FAQ titles shown in the search results
Preview text color: Color of the FAQ previews shown in the search results
Header text color: Color of the Heading in the Search screen
Search term highlight color: Color of highlighting in the Search screen