DocumentionUmo EditorConfigurationUsers

Related Users Configuration

Used to configure data for related users, including user IDs, user names, etc., for scenarios such as โ€œmentioning users (i.e., @ users)โ€. Added in v6.0.0

Default Configuration

{
  users: [],
  onMentionSearch: null,
}

Configuration Description

users

Description: Data for related users.

Type: Array

Default Value: []

Configuration Items:

  • users[].id: String, user ID.
  • users[].label: String, user name.
  • users[].avatar: String, avatar URL.
  • users[].color: String, user color, used to quickly distinguish different users.
  • users[].name / users[].nickname: Business-specific name fields that can be extended as needed.
  • users[].bio: String, user bio or other additional information. Added in v11.0.0

onMentionSearch

Description: Custom search method for mention users. Added in v11.0.0

Type: function

Default Value: null

Parameters:

  • query: String, the mention query string entered by the user.

Return Value: Promise, resolved with a user list.