User Avatar
You can use the User Avatar UI Pattern to display a user's initials or their image in a circular badge.
How to use the User Avatar UI Pattern
The following example demonstrates how you can display the initials of the registered users on your platform.
-
In Service Studio, in the Toolbox, search for
User Avatar.The User Avatar widget is displayed.
-
From the Toolbox, drag the User Avatar widget into the Main Content area of your application's screen.
-
To create an aggregate (in this example to retrieve all the users on the platform), right-click the screen name and select Fetch Data from Database.
-
To add a database entity, click the screen, and from the Select Source pop-up, select the relevant entity and click OK. In this example, we select the User entity.
The aggregate GetUsers is created.
-
To reopen your screen, select the Interface tab, and double-click on your screen name.
-
Select the User Avatar widget, and on the Properties tab, from the Name drop-down, select Expression Editor.
-
In the Expression Editor, enter the following expression and click DONE.
GetUsers.List.Current.User.NameNote: You can also add the expression by navigating through the Expression Editor's Scope tree and double-clicking on the Name output parameter.
The Name property is now set to display the Name property of the aggregate you created earlier, which gets and displays the names of the registered users on your platform.
-
On the Properties tab, you can also customize User Avatar's look and feel by setting any of the optional properties, for example, the color, shape, and size. The following example displays a blue, medium-sized, circle badge.
After following these steps and publishing the module, you can test the pattern in your app.
Properties
| Property | Description |
|---|---|
| Name (Text): Optional | The initials that appear inside the user avatar. Set this to a data source that contains the value you want to display. Examples
|
| Image (Binary Data): Optional | The users image. |
| Color (Color Identifier): Optional | Set the badge's background color. Red, orange, yellow, lime, green, blue, violet, and pink are just some of predefined colors available for the badge. Examples
|
| Size (Size Identifier): Optional | Set the badge's size. Small and medium are the predefined sizes available for the badge. Examples
|
| Shape (Shape Identifier): Optional | Set the badge's shape. Rounded, soft rounded, and sharp are the predefined shapes available for the badge. Examples
|
| IsLight (Boolean): Optional | Specify the badge's background and text color. Examples
|
| ExtendedClass (Text): Optional | Add custom style classes to the User Avatar UI Pattern. You define your custom style classes in your application using CSS. Examples
|