Skip to content
UI extensions, tab customizations and more 🎉 CHT 5.2 is here!

.header_tabs

Configuring app header tab icons

app_settings.js .header_tabs

As of 3.10.0, app header tabs can be configured by modifying the header_tabs section in the app settings. The header_tabs section consists of key:value pairs, where the key is the name of the tab to configure. These values can also be changed from the Admin console, on the Images page under the “Header tabs icons” tab.

As of 5.2.0, the ordering of the app header tabs can be customized by setting the weight property. Tabs with a lower weight value will be displayed first (higher on the bar). The tab with the lowest weight will be the one loaded when the user first opens the app.

{
  "messages": {
    "icon": "fa-user",
    "weight": 42
  },
  "tasks": {
    "resource_icon": "medic-health-center"
  },
  "analytics": {
    "icon": "fa-flag",
    "resource_icon": "icon-treatment",
    "weight": 0.5
  }
}

Available tabs

tab namedefault FontAwesome iconDefault Weight
messagesfa-envelope1
tasksfa-flag2
reportsfa-list-alt3
contactsfa-user4
analyticsfa-bar-chart-o5

app_settings.js .header_tabs.<tab_name>

propertytyperequireddescription
iconstringnoFontAwesome icon name
resource_iconstringnoResource icon name.
weightnumbernoAdded in 5.2.0. The numerical “weight” used to determine the tab ordering. Lower values come first.

Note

Selected Resource icons take precedence over selected FontAwesome icons.
If the selected Resource icon does not exist, the default icon will be displayed.
If the selected FontAwesome icon does not exist, the default icon will be displayed.
If the selected Resource icon is not an svg that supports css color filling, the icon will have a static color for every state (inactive, active and hovered). Colors will change only for > FontAwesome icons and css fillable svg icons.
The Admin console Resource icon dropdowns only supports selecting svg icons. If mismatched Resource Icons are selected, they will be deselected upon saving.
Resource icons images will be sized to 24 x 24px when displayed.

Last updated on

Did this documentation help you ?