Skip to content

Commit

Permalink
Clarify that shortcode must be a string
Browse files Browse the repository at this point in the history
Signed-off-by: Sumner Evans <[email protected]>
  • Loading branch information
sumnerevans committed Jun 30, 2023
1 parent 5424ea8 commit 2ac5328
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions proposals/4027-custom-images-in-reactions.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,14 @@ This proposal suggests two changes to events with the `m.annotation` relation.
should render the referenced image instead of the key text.

2. When the annotation's key is an MXC URI, a new (optional) `shortcode` key can
be added to the content of the event with a textual name for the image.
be added to the content of the event with a textual name for the image. This
field must be a string and should start and end with the `:` (colon)
character.

This shortcode should be shown by clients in situations such as hovering over
the annotation, as alt-text, or if the client does not support rendering
images.

The shortcode should start and end with the `:` (colon) character.

Example custom image reaction event content

```json
Expand Down

0 comments on commit 2ac5328

Please sign in to comment.