Skip to content

Allow data function to return a promise #611

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/afraid-rice-refuse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"react-mentions": minor
---

Data functions can now return a promise. This is useful when fetching the suggestions asynchronously.
53 changes: 30 additions & 23 deletions src/MentionsInput.js
Original file line number Diff line number Diff line change
@@ -278,7 +278,7 @@ class MentionsInput extends React.Component {
scrollFocusedIntoView={this.state.scrollFocusedIntoView}
containerRef={this.setSuggestionsElement}
suggestions={this.state.suggestions}
customSuggestionsContainer ={this.props.customSuggestionsContainer}
customSuggestionsContainer={this.props.customSuggestionsContainer}
onSelect={this.addMention}
onMouseDown={this.handleSuggestionsMouseDown}
onMouseEnter={this.handleSuggestionsMouseEnter}
@@ -489,7 +489,7 @@ class MentionsInput extends React.Component {
// Handle input element's change event
handleChange = (ev) => {
isComposing = false
if(isIE()){
if (isIE()) {
// if we are inside iframe, we need to find activeElement within its contentDocument
const currentDocument =
(document.activeElement && document.activeElement.contentDocument) ||
@@ -687,7 +687,11 @@ class MentionsInput extends React.Component {

updateSuggestionsPosition = () => {
let { caretPosition } = this.state
const { suggestionsPortalHost, allowSuggestionsAboveCursor, forceSuggestionsAboveCursor } = this.props
const {
suggestionsPortalHost,
allowSuggestionsAboveCursor,
forceSuggestionsAboveCursor,
} = this.props

if (!caretPosition || !this.suggestionsElement) {
return
@@ -739,9 +743,9 @@ class MentionsInput extends React.Component {
// is small enough to NOT cover up the caret
if (
(allowSuggestionsAboveCursor &&
top + suggestions.offsetHeight > viewportHeight &&
top + suggestions.offsetHeight > viewportHeight &&
suggestions.offsetHeight < top - caretHeight) ||
forceSuggestionsAboveCursor
forceSuggestionsAboveCursor
) {
position.top = Math.max(0, top - suggestions.offsetHeight - caretHeight)
} else {
@@ -761,12 +765,12 @@ class MentionsInput extends React.Component {
// is small enough to NOT cover up the caret
if (
(allowSuggestionsAboveCursor &&
viewportRelative.top -
highlighter.scrollTop +
suggestions.offsetHeight >
viewportHeight &&
suggestions.offsetHeight <
caretOffsetParentRect.top - caretHeight - highlighter.scrollTop) ||
viewportRelative.top -
highlighter.scrollTop +
suggestions.offsetHeight >
viewportHeight &&
suggestions.offsetHeight <
caretOffsetParentRect.top - caretHeight - highlighter.scrollTop) ||
forceSuggestionsAboveCursor
) {
position.top = top - suggestions.offsetHeight - caretHeight
@@ -901,28 +905,31 @@ class MentionsInput extends React.Component {
const { children, ignoreAccents } = this.props
const mentionChild = Children.toArray(children)[childIndex]
const provideData = getDataProvider(mentionChild.props.data, ignoreAccents)
const syncResult = provideData(

const callback = this.updateSuggestions.bind(
null,
this._queryId,
childIndex,
query,
this.updateSuggestions.bind(
null,
this._queryId,
childIndex,
query,
querySequenceStart,
querySequenceEnd,
plainTextValue
)
querySequenceStart,
querySequenceEnd,
plainTextValue
)
if (syncResult instanceof Array) {

const result = provideData(query, callback)

if (result instanceof Array) {
this.updateSuggestions(
this._queryId,
childIndex,
query,
querySequenceStart,
querySequenceEnd,
plainTextValue,
syncResult
result
)
} else if (result && typeof result.then === 'function') {
result.then(callback)
}
}

68 changes: 65 additions & 3 deletions src/MentionsInput.spec.js
Original file line number Diff line number Diff line change
@@ -51,7 +51,10 @@ describe('MentionsInput', () => {
it.todo('should be possible to close the suggestions with esc.')

it('should be able to handle sync responses from multiple mentions sources', () => {
const extraData = [{ id: 'a', value: 'A' }, { id: 'b', value: 'B' }]
const extraData = [
{ id: 'a', value: 'A' },
{ id: 'b', value: 'B' },
]

const wrapper = mount(
<MentionsInput value="@">
@@ -64,13 +67,69 @@ describe('MentionsInput', () => {
wrapper.find('textarea').simulate('select', {
target: { selectionStart: 1, selectionEnd: 1 },
})
wrapper.find('textarea').getDOMNode().setSelectionRange(1, 1)
wrapper
.find('textarea')
.getDOMNode()
.setSelectionRange(1, 1)

expect(
wrapper.find('SuggestionsOverlay').find('Suggestion').length
).toEqual(data.length + extraData.length)
})

it('handles an async data function that executes the callback', () => {
function dataFunc(query, callback) {
callback(data)
}

const wrapper = mount(
<MentionsInput value="@">
<Mention trigger="@" data={dataFunc} />
</MentionsInput>
)

wrapper.find('textarea').simulate('focus')
wrapper.find('textarea').simulate('select', {
target: { selectionStart: 1, selectionEnd: 1 },
})
wrapper
.find('textarea')
.getDOMNode()
.setSelectionRange(1, 1)

expect(
wrapper.find('SuggestionsOverlay').find('Suggestion').length
).toEqual(data.length)
})

it('handles an async data function that returns a promise', async () => {
function dataFunc() {
return Promise.resolve(data)
}

const wrapper = mount(
<MentionsInput value="@">
<Mention trigger="@" data={dataFunc} />
</MentionsInput>
)

wrapper.find('textarea').simulate('focus')
wrapper.find('textarea').simulate('select', {
target: { selectionStart: 1, selectionEnd: 1 },
})
wrapper
.find('textarea')
.getDOMNode()
.setSelectionRange(1, 1)

await new Promise((resolve) => setTimeout(resolve, 0))
wrapper.update()

expect(
wrapper.find('SuggestionsOverlay').find('Suggestion').length
).toEqual(data.length)
})

it('should scroll the highlighter in sync with the textarea', () => {
const wrapper = mount(
<MentionsInput
@@ -133,7 +192,10 @@ describe('MentionsInput', () => {
})

it('should accept a custom regex attribute', () => {
const data = [{ id: 'aaaa', display: '@A' }, { id: 'bbbb', display: '@B' }]
const data = [
{ id: 'aaaa', display: '@A' },
{ id: 'bbbb', display: '@B' },
]
const wrapper = mount(
<MentionsInput value=":aaaa and :bbbb and :invalidId">
<Mention