react-mentions 3.1.0 → 3.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -10
- package/dist/react-mentions.cjs.dev.js +409 -52
- package/dist/react-mentions.cjs.prod.js +410 -41
- package/dist/react-mentions.esm.js +407 -50
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
|
|
8
8
|
A React component that let's you mention people in a textarea like you are used to on Facebook or Twitter.
|
|
9
9
|
|
|
10
|
-
Used in production at [Signavio](https://signavio.com), [State](https://state.com), [Snips](https://snips.ai), [Swat.io](https://swat.io), [GotDone](https://www.gotdone.me), [Volinspire](https://volinspire.com), [Marvin](https://amazingmarvin.com), [Timely](https://timelyapp.com), [GuideFitter](https://www.guidefitter.com/), [Evite](https://www.evite.com/), [Publer](https://publer.me/), and [you?](https://github.com/signavio/react-mentions/edit/master/README.md)
|
|
10
|
+
Used in production at [Signavio](https://signavio.com), [State](https://state.com), [Snips](https://snips.ai), [Swat.io](https://swat.io), [GotDone](https://www.gotdone.me), [Volinspire](https://volinspire.com), [Marvin](https://amazingmarvin.com), [Timely](https://timelyapp.com), [GuideFitter](https://www.guidefitter.com/), [Evite](https://www.evite.com/), [Publer](https://publer.me/), [Kontentino](https://www.kontentino.com/), and [you?](https://github.com/signavio/react-mentions/edit/master/README.md)
|
|
11
11
|
|
|
12
12
|
## Getting started
|
|
13
13
|
|
|
@@ -54,15 +54,16 @@ You can find more examples here: [demo/src/examples](https://github.com/signavio
|
|
|
54
54
|
|
|
55
55
|
The `MentionsInput` supports the following props for configuring the widget:
|
|
56
56
|
|
|
57
|
-
| Prop name
|
|
58
|
-
|
|
|
59
|
-
| value
|
|
60
|
-
| onChange
|
|
61
|
-
| singleLine
|
|
62
|
-
| onBlur
|
|
63
|
-
| allowSpaceInQuery
|
|
64
|
-
| suggestionsPortalHost
|
|
65
|
-
| inputRef
|
|
57
|
+
| Prop name | Type | Default value | Description |
|
|
58
|
+
| --------------------------- | ------------------------------------------------------- | -------------- | -------------------------------------------------------------------------------------- |
|
|
59
|
+
| value | string | `''` | The value containing markup for mentions |
|
|
60
|
+
| onChange | function (event, newValue, newPlainTextValue, mentions) | empty function | A callback that is invoked when the user changes the value in the mentions input |
|
|
61
|
+
| singleLine | boolean | `false` | Renders a single line text input instead of a textarea, if set to `true` |
|
|
62
|
+
| onBlur | function (event, clickedSuggestion) | empty function | Passes `true` as second argument if the blur was caused by a mousedown on a suggestion |
|
|
63
|
+
| allowSpaceInQuery | boolean | false | Keep suggestions open even if the user separates keywords with spaces. |
|
|
64
|
+
| suggestionsPortalHost | DOM Element | undefined | Render suggestions into the DOM in the supplied host element. |
|
|
65
|
+
| inputRef | React ref | undefined | Accepts a React ref to forward to the underlying input element |
|
|
66
|
+
| allowSuggestionsAboveCursor | boolean | false | Renders the SuggestionList above the cursor if there is not enough space below |
|
|
66
67
|
|
|
67
68
|
Each data source is configured using a `Mention` component, which has the following props:
|
|
68
69
|
|