Flarum (2.x)
Preparing search index...
@flarum/mentions
forum/mentionables/UserMention
UserMention
Class UserMention
Hierarchy (
View Summary
)
MentionableModel
<
User
,
AtMentionFormat
>
UserMention
Index
Constructors
constructor
Properties
format
Methods
enabled
initial
Results
matches
max
Store
Matched
Results
replacement
search
suggestion
type
Constructors
constructor
new
UserMention
(
format
:
AtMentionFormat
)
:
UserMention
Parameters
format
:
AtMentionFormat
Returns
UserMention
Properties
format
format
:
AtMentionFormat
Methods
enabled
enabled
()
:
boolean
Returns
boolean
initial
Results
initialResults
()
:
User
[]
Returns
User
[]
matches
matches
(
model
:
User
,
typed
:
string
)
:
boolean
Parameters
model
:
User
typed
:
string
Returns
boolean
max
Store
Matched
Results
maxStoreMatchedResults
()
:
null
Returns
null
replacement
replacement
(
user
:
User
)
:
string
Uses the user ID so autocomplete works regardless of the username's characters.
Parameters
user
:
User
Returns
string
search
search
(
typed
:
string
)
:
Promise
<
User
[]
>
Parameters
typed
:
string
Returns
Promise
<
User
[]
>
suggestion
suggestion
(
model
:
User
,
typed
:
string
)
:
Children
Parameters
model
:
User
typed
:
string
Returns
Children
type
type
()
:
string
Returns
string
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
format
Methods
enabled
initial
Results
matches
max
Store
Matched
Results
replacement
search
suggestion
type
Flarum (2.x)
Loading...
Uses the user ID so autocomplete works regardless of the username's characters.