I. Intro
The badge function is an API interface that allows you to display a red number or dot in the upper-right corner of an app. This indicates the presence of unread messages within the app. The number on the badge represents the number of unread messages. When an app has unread messages, a badge will appear on it, and Workspace in the left navigation bar will also display the badge.
Note: This function can only be integrated into mini-program apps or web apps. If you have any questions, contact Support.
250px|700px|reset
II. Use the badge function
Turn on/off the badge
When users first enter an app with badge function, they will see a pop-up requesting permission to enable badges. Users can choose to enable or disable the badge function based on their preferences.
If users want to disable or re-enable the badge functionality at a later time, they can go to the badge settings page by clicking the ··· icon in the upper-right corner of the app and selecting Badge Settings. From there, they can enable or disable the badge function for the app.
Note: If users enable or disable the badge function on their desktops, it will also affect the badge status on their mobile devices, and the same applies in reverse.
250px|700px|reset
250px|700px|reset
III. Precautions
The number displayed on the badge
The badge supports displaying numbers within the range of 1 to 999. When the number of unread messages exceeds 999, only a red dot will be displayed instead of the specific number.
The badge number displayed on Workplace represents the sum of badge numbers from different apps within Workplace. The badge number of the same app will not be counted multiple times in total. For example, if only app A has the badge function in the Workspace and it appears twice with a badge number of 15, the total badge number displayed in the workspace will be 15, not 30.
Badge display
After an app with badge functionality is added to Workplace, the display effect of the badge will be affected by factors such as the type of workplace your organization has, the position of the app, and its position compared to other apps.
In the default Workplace
If an app is added as a recommended application by the administrator or added as a frequently used application by members themselves, the badge will be displayed normally. For more information, visit Get started with Workplace.
250px|700px|reset
If the administrator has enabled custom app grouping, the apps within the groups can display badges. If the administrator has not enabled custom app grouping and all app are listed under All Apps, badges will not be displayed for those apps.
250px|700px|reset
250px|700px|reset
In Custom Workplace
- Custom Workplaces starting with version 5.15 will display the badge.
- For apps within the App List block, the app badges will only be displayed on custom workspaces that are version 5.27 or above. If there are app groups created within the app list, when a specific app within a group has a badge, a red dot will also be displayed on the upper-right corner of the group icon.
- For embedded (web page-based) workspaces starting from version 5.18, badges will only be displayed on the upper-right corner of the Workspace icon in the navigation bar. It's important to note that the badge function for web apps needs to be developed separately by the organization.
- If you want to display badges for other blocks, you have the option to develop them separately. In apps where you implement badge functionality separately, the numbers on those badges will not be counted into the total displayed on the Workpace badge in the navigation bar.
IV. FAQs