Consistent Markdown Editor

Overview

Mattermost has established keyboard shortcuts and formatting controls in the center channel message input and the reply input. These controls and shortcuts increase efficiency, productivity and clarity in the messaging experience.

However, other parts of the app that should have the same capabilities are lacking the same controls and expected shortcuts.

https://mattermost.atlassian.net/browse/MM-56713

It’s recommended that we provide this functionality in the following places - in priority order:

Must haves

  1. Inline message editor

    1. in the center channel

    2. in the RHS

    3. in the Threads view

  2. Edit channel header modal

Nice to haves

  1. Playbook run status update modal

  2. Playbook status update template editor

  3. Playbook description editor

  4. Playbook summary editor

  5. Playbook retrospective template editor / Playbook run retrospective


Markdown editors in the Channels Product

Editing messages

The first priority would be to offer the standard controls in the inline editing input.

image-20240317-205449.png
Showing the formatting controls when editing a message in the center panel

Align with user’s active state of the formatting bar

If the user has the formatting bar hidden in the main message input, then we should honor this preference in the edit mode. If the user has the formatting bar showing in the main message input, then we should also carry that preference over in the edit mode.

Keyboard shortcuts

We should offer the same standardized keyboard shortcuts that are currently offered in the main message input as well.

Must haves

  • Bold - Command B

  • Italic - Command I

  • Link - Command Option K - or Command K if something is selected

  • Strikethrough - Shift X

Nice to haves:

  • Code - Command Option C

  • Bulleted List - Shift Option 7

  • Numbered List - Shift Option 8

  • Quote - Shift Option 9

In the RHS and Threads context

The above controls should also be available in the RHS and Threads view context.

image-20240317-210229.png
Editing in the RHS

Editing the channel header

In the modal for editing the channel header, we should also offer the standardized controls outlined above for formatting and keyboard shortcuts.


Markdown editors in the Playbooks Product

In each of the contexts below, we should offer the formatting bar controls for these markdown editors along with the keyboard controls outlined above.

Playbook run status updates

Playbook status update template

Playbook description

Playbook summary

Retrospective template