User Profile

11min

By default, the user profile in includes various menu options, such as Personal Information, Notifications, Settings, and more. Certain user information and UI elements can be customized to fit specific needs.

Default Profile screen
Default Profile screen


Default profile setup





Solution switching

Available if the user has access to multiple solutions.

Personal information

Includes the logged-in user's name, email, avatar, and the option to delete the user account.

Notifications

Displays all notifications sent to the user, with options to mark all as read and filter by All, Read, or Unread.

Secondary identities

Refers to additional authentication methods required beyond primary login credentials, such as OAuth. Users can connect, refresh, or remove an identity.

Settings

Includes app settings such as color theme (light/dark mode), language selection, and region changes, if applicable.

Troubleshooting

Provides logging settings to help debug and troubleshoot app issues.

Support

Allows users to ask support a question. This setting can be hidden via a flag in the build configuration.

Logout

Allows the currently logged-in user to log out of the app.

Allowing users to update their profile

You can allow users to update specific information in their profile using the action.update-profile. This action can be configured within a in various ways, such as: • An action button • A jig-header link or icon • In an event, e.g., onPress

The following information can be updated when using the action:

  • firstName
  • lastName
  • displayName
  • avatarUrl
action-update-profile (button)
action-jig-header
action-onpress


Customize or extend the Profile screen

The Profile screen can be extended by adding Components that allow additional user information to be displayed. This can be achieved through the following steps:

  1. Define a containing the components you want to display on the Profile screen.
  2. Set the jigId in the profile property within the index.jigx file.

You can create a as the first screen a new user sees when they log into the app to capture their details. This updates the Profile screen. Once updated, the screen can be configured with conditions to prevent it from appearing again. This is especially useful in scenarios where devices are shared among multiple employees, such as contractors or engineers.

Properties

Description

Profile

Adding the property with it's values to the index.jigx file will insert the referenced s into the header section of the Profile screen.

isPersonalInfoMenuItemVisible

Determine whether the Personal Information menu should be hidden (false) or visible (true). The default setting is true. This menu opens a screen displaying the user's name, email, and avatar, and provides an option to delete the account. Customizing the Profile screen allows this information to be integrated directly, eliminating the need for a menu option.

jigId

Provide the jigId for the s that will be displayed in the Profile screen.

Considerations

  • No additional padding is added to the s, which may affect the screen's UI. You can use properties such as background or padding to ensure proper content alignment. This issue is particularly noticeable when using list-items versus custom components or other components.
  • When combining or using custom components, it is recommended to manually add padding and margins for consistent spacing and layout.

Examples and code snippets

Extended Profile screen with hidden personal information menu

Extended Profile
Extended Profile


In this example, the Profile screen is extended to display the user's avatar along with their details in an expander component. Additionally, the personal information menu option is hidden from the list.

user-detail.jigx
index.jigx


Extended Profile screen with list

This example demonstrates how to add a list of emergency contacts to a , which is referenced in the index.jigx file to extend the Profile screen.

Profile extended with list
Profile extended with list

emergency-list.jigx
index.jigx
datasource


Extended Profile screen using custom components (alpha)

Custom Profile
Custom Profile


In this example, the Profile screen has been extended to display the user's avatar, name, and email address using a custom component to create the required UI layout. This custom component is placed within a card in the user-profile . A standard list component that displays the region and department.

The list component allows users to update their department and region by configuring a rightElement with an onPress event.

user-data.jigx
user-profile.jigx
index.jigx
datasource