MessageInputContext

The MessageInputContext is established within the MessageInput component. The value is the combination of the MessageInputProps, MessageInputState (returned by the useMessageInputState hook), and cooldownTimerState (returned by the useCooldownTimer hook). It provides data to the Input UI component and its children. Use the values stored within this context to build a custom Input UI component. You can access the context values by calling the useMessageInputContext custom hook.

Basic Usage

Pull values from context with our custom hook:

const { autocompleteTriggers, handleSubmit } = useMessageInputContext();

Values

additionalTextareaProps

Additional props to be passed to the underlying AutoCompleteTextarea component, available props.

attachments

An array of attachments added to the current message. Every attachment object carries attribute localMetadata that is internally used to manage the attachment state in the composer (update, remove attachments from the state, keep reference to uploaded files, keep information about the file upload state). The localMetadata object is discarded from each attachment object before sending the resulting message to the server. The attachments array does not contain attachments created by URL enrichment. These scraped attachments are kept in linkPreviews map.

autocompleteTriggers

A mapping of the current triggers permitted in the currently active channel.

cancelURLEnrichment

Function cancels all the scheduled or in-progress URL enrichment queries and resets the state.

clearEditingState

Function to clear the editing state while editing a message.

closeCommandsList

Function to manually close the list of supported slash commands.

closeMentionsList

Function to manually close the list of potential users to mention.

cooldownInterval

If slow mode is enabled, the required wait time between messages for each user.

cooldownRemaining

If slow mode is enabled, the amount of time remaining before the connected user can send another message.

disabled

If true, disables the text input.

disableMentions

If true, the suggestion list will not display and autocomplete @mentions.

dismissLinkPreview

Function called when a single link preview is dismissed.

doFileUploadRequest

Function to override the default file upload request.

doImageUploadRequest

Function to override the default image upload request.

emojiIndex

Custom class constructor to override default NimbleEmojiIndex from ‘emoji-mart’.

emojiPickerIsOpen

If true, signifies the EmojiPicker component is currently open.

emojiPickerRef

React mutable ref placed on the EmojiPicker container div.

errorHandler

Custom error handler function to be called with a file/image upload fails.

findAndEnqueueURLsToEnrich

A function responsible for initiating URL discovery and their subsequent enrichment. It is available only if link preview rendering is enabled. Link previews are disabled by default.

focus

If true, focuses the text input on component mount.

grow

If true, expands the text input vertically for new lines.

handleChange

Function that runs onChange to the underlying textarea component.

handleEmojiKeyDown

Opens the EmojiPicker component on Enter or Spacebar key down.

handleSubmit

Function that runs onSubmit to the underlying textarea component.

hideSendButton

Allows to hide MessageInput’s send button. Used by MessageSimple to hide the send button in EditMessageForm. Received from MessageInputProps.

insertText

Function to insert text into the value of the underlying textarea component.

isThreadInput

Signals that the MessageInput is rendered in a message thread (Thread component).

isUploadEnabled

If true, file uploads are enabled in the currently active channel.

linkPreviews

A Map of LinkPreview objects (a union type of LinkPreviewState and OGAttachment) indexed by string representing link URL. The link URL value is provided by OGAttachment.og_scrape_url.

shouldSubmit

Currently, Enter is the default submission key and Shift+Enter is the default combination for the new line. If specified, this function overrides the default behavior specified previously.

maxFilesLeft

The maximum number of allowed uploads minus the current number of successful uploads.

maxRows

Max number of rows the underlying textarea component is allowed to grow.

mentionAllAppUsers

If true, the suggestion list will search all app users for an @mention, not just current channel members/watchers.

mentioned_users

An array of users mentioned in the current message.

mentionQueryParams

Object containing filters/sort/options overrides for an @mention user query.

message

If provided, the existing message will be edited on submit.

minRows

Min number of rows the underlying textarea will start with. The grow on MessageInput prop has to be enabled for minRows to take effect.

noFiles

If true, disables file uploads for all attachments except for those with type ‘image’.

numberOfUploads

The number of successfully uploaded files for the current message.

onPaste

Function that runs onPaste to the underlying textarea component.

onSelectEmoji

Function that runs on select of an emoji in the EmojiPicker component.

onSelectUser

Function that runs on select of a user in the suggestion list following an @mention.

openCommandsList

Function to manually open the list of supported slash commands.

openEmojiPicker

Function to open the EmojiPicker component.

openMentionsList

Function to manually open the list of potential users to mention.

overrideSubmitHandler

Function to override the default submit handler.

parent

When replying in a thread, the parent message object.

publishTypingEvent

If true, triggers typing events on text input keystroke.

removeAttachments

Function to remove an attachment objects from the attachments array in the MessageInputState.

const Component = () => {
  const { attachments, removeAttachments } = useMessageInputContext();

  return (
    <div>
      {attachments.map((att) => (
        <button onClick={() => removeAttachments([att.localMetadata.id])}>
          Remove
        </button>
      ))}
    </div>
  );
};

setCooldownRemaining

React state hook function that sets the cooldownRemaining value.

setText

Function that overrides and sets the text value of the underlying textarea component.

showCommandsList

If true, show the list of supported slash commands above the text input.

showMentionsList

If true, show the list of potential users to mention above the text input.

text

The current input value of the underlying textarea component.

textareaRef

React mutable ref placed on the underlying textarea component.

uploadAttachment

Uploads the file that comes as a part of the attachment object argument. The function expects the attachment object to contain attribute localMetadata, which in turn should contain file attribute referring to the file to be uploaded and an attribute id with attachment’s unique identifier string. The localMetadata object is discarded when the message is posted.

So the minimum required attachment object for upload would be:

type MinimumUploadAttachment = {
  localMetadata: {
    file: File | Blob;
    id: string;
  };
};

The function returns undefined if, custom upload function (doImageUploadRequest, doFileUploadRequest) fails.

uploadNewFiles

Function to upload an array of files and store the results as LocalAttachment objects in attachments array of the MessageInputContext.

upsertAttachments

Function that adds or updates attachments array in MessageInputState. Accepts an array of objects.

const Component = () => {
  const { upsertAttachments } = useMessageInputContext();

  const handleSelect = (location) => {
    upsertAttachments([
      {
        type: "geolocation",
        longitude: location.longitude,
        latitude: location.latitude,
        name: location.name,
      },
    ]);
  };

  // ...
};

useMentionsTransliteration

If true, will use an optional dependency to support transliteration in the input for mentions. See: https://github.com/sindresorhus/transliterate