This is documentation for Stream Chat React Native SDK v3, which is no longer actively maintained. For up-to-date documentation, see the latest version (v8).
SuggestionsContext
SuggestionsContext is provided by Channel component, to provide necessary values for managing autocomplete feature on underlying MessageInput component.
Value
closeSuggestions
Function to close the autocomplete suggestions popup.
| Type |
|---|
| function |
componentType
Current active component type, which is basically a first parameter to openSuggestions.
| Type |
|---|
| string | Element |
openSuggestions
Function to open the autocomplete suggestions popup. This function takes following two parameters:
component- You can either pass a string or a react element.- string -
enum('MentionsItem' | 'CommandsItem' | 'EmojisItem'). Based on value, one of the default components will be rendered as list item within suggestions list. - element - React element which takes
itemas a prop, which is a suggestion item within list set usingupdateSuggestions. This element is used to render item in the suggestions list.
- string -
title- component to render a title for suggestions list.
| Type |
|---|
| function |
suggestions
Current active list of suggestions, within suggestions list for autocomplete feature.
| Type |
|---|
{ data: array<object>, onSelect: function } |
suggestionsTitle
Title component of current active suggestions autocomplete list.
| Type |
|---|
| string | Element |
suggestionsViewActive
Weather the autocomplete suggestions list is open or not.
| Type |
|---|
| boolean |
updateSuggestions
Update the suggestions in autocomplete suggestions list. This function takes following two parameters:
suggestions-{ data: array<object>, onSelect: function }title- new title component for suggestions list.
| Type |
|---|
| function |