Form Record Presence

Adds an avatar when another user is viewing the record at the same time. If 2 other users are viewing the record, their avatars are both displayed. If more than 2 are present, the first 2 user avatars are displayed with a third overflow trigger “avatar”.

Overview

  • Release version
    Zurich
  • Available sinceTokyo
  • A11Y WCAG 2.1 AA

Anatomy

  1. User presence status bar: Displays up to 2 user avatars; also displays a third overflow trigger avatar when more than 2 users are present
  2. User presence overflow: Popup that displays when the overflow trigger avatar is clicked: displays all other users viewing the record

Subcomponents

See the usage guidelines for avatar

See the usage guidelines for popover

See the usage guidelines for tooltip

See the usage guidelines for contact card

Usage

Add form record presence to a record page in a configurable workspace and use it to indicate when 1 or more other users are viewing the same record and to initiate communication with those users.

Configurations

Learn how to customize form record presence by configuring the available properties.

Presets and controllers

This component contains a preset configuration that automatically configures properties and event handlers for a component, making the component ready to work when you add it to a page. A preset is designed to suit a specific use case. However, you can override preset property values with a custom configuration if you find it necessary for your design. Preset values that you override aren’t upgraded when updates are available. If you don’t want to use the preset values provided, select the option to configure the component manually. You can apply one preset to a single instance of a component on a page. For more information, see Presets.

A preset is always associated with a controller, which acts as a data resource for the component. Controllers provide the configuration data and event bindings the component needs to function in your experience. By selecting a preset, the required controller is added to the page. By adding a controller to the page, any new applicable components will have that controller's preset. For more information about how controllers work, see Controllers. For instructions on using the data inspector to view the default presets for a component, see View properties and events in the Controller API.

Design recommendations

Learn how to apply form record presence in your design.

Alignment and positioning

Position this component on the record in the upper right in the view in the left of the quick actions area.

Behavior

Learn how form record presence behaves when the display changes or a user interacts with the component.

Responsive behaviors

Form record presence displays the avatars of the first 2 concurrent users. When more than 2 users are viewing the record, the component displays an overflow avatar with a counter, showing the number of additional users.

Shows avatars for the first two users viewing a record and the overflow counter indicating the number of additonal users

Interactions

Learn how form record presence responds when a user interacts with it.

Viewing concurrent users

The user selects the overflow trigger avatar to view all concurrent users of the record. A popover appears containing the user list and conact icons. When the user list exceeds 11 users, a horizontal scroll bar appears in the popover.

Overflow trigger avatar selected showing all additional concurrent users of the record

Contacting a user

If the user has the Openframe plugin installed, they can initiate an outbound call to another user's business phone number by selecting the phone icon on the popover list. To send an email, the user selects a letter icon in the popover list.

Viewing user contact info

The user can access a contact card popup for each active viewer by selecting their avatar. The contact card can contain a user’s name and avatar, and optional information such as their job title,
and contact information, or a subset based on what is available.

Usability

Form record presence complies with all internationalization and accessibility requirements.

Internationalization

When this component is used in a platform configured for a right-to-left (RTL) language, form record presence flips in its orientation. The order of importance changes to right-to-left in the form record presence status bar but remains top to bottom in the popover list.

Accessibility

Learn how to access the elements of form record presence through keyboard interactions.

Form record presence tab order

Tab order of current users' avatars moving from left to right

Overflow tab order

Tab order of current users in the overflow tab from top phone icon to top email icon to second row and so on