MarkdownEditor

The error message to display

Current value of the editor as a multiline markdown string.

Called when the value changes.

Called when the textarea gains focus.

Accepts Markdown and returns rendered HTML. To prevent XSS attacks, the HTML should be sanitized and/or come from a trusted source.

Disable the editor and all related buttons. Users can still switch between preview & edit modes.

Placeholder text to show when the editor is empty. By default, no placeholder will be shown.

Maximum number of characters the markdown can hold (includes formatting characters like *).

Force the editor to take up the full height of the container and disallow resizing. Only use when the container height is tall enough that the user will never want to expand the input further, ie when it takes the full height of the viewport.

ID of the describing element.

ID of the labelling element.

Optionally control the view mode. If uncontrolled, leave this undefined.

If viewMode is controlled, this will be called on change.

Called when the user presses Ctrl/Cmd + Enter. Should almost always be wired to the same event as clicking the primary actionButton.

Minimum number of visible lines of text in the editor.

Maximum number of visible lines of text in the editor. Has no effect if fullHeight = true.

Array of all possible emojis to suggest. Leave undefined to disable emoji autocomplete.

Skin tone preference used for rendering applicable emoji suggestions between 1-5. 0 can be used as a default value. See: https://github.com/github/g-emoji-element?tab=readme-ov-file#skin-tones for more information.

Array of all possible mention suggestions. Leave undefined to disable @-mention autocomplete.

Array of all possible references to suggest. Leave undefined to disable #-reference autocomplete.

Uploads a file to a hosting service and returns the URL. If not provided, file uploads will be disabled.

Array of allowed file types. If onUploadFile is defined but this array is not, all file types will be accepted. You can still reject file types by rejecting the onUploadFile promise, but setting this array provides a better user experience by preventing the upload in the first place.

Callback when files are rejected due to unsupported file types. Useful for analytics tracking.

Control whether the editor font is monospace.

Control whether the input is required.

The name that will be given to the textarea.

To enable the saved replies feature, provide an array of replies.

Callback when the saved replies picker is opened

Control whether URLs are pasted as plain text instead of as formatted links (if the user has selected some text before pasting). Defaults to false (URLs will paste as links). This should typically be controlled by user settings.

Users can always toggle this behavior by holding shift when pasting.

Optional banner to display inside the editor, below the input area. Typically used for error, info, or warning messages. Use MarkdownEditor.ErrorBanner for error messages to get consistent styling and accessibility.

Note: File upload errors (from drag-and-drop/paste) take priority over this banner and will be displayed instead when present.

Use hovercards for team mentions in preview mode

Optional class name

When true, displays a skeleton loading state instead of the textarea.

Props that only apply to the new hybrid Markdown editing experience. Will be forwarded through to the HybridMarkdownEditor component and will not have any effect unless hybrid mode is selected.