versia-pub/docs
2
0
Fork 0
mirror of https://github.com/versia-pub/docs.git synced 2026-03-13 02:49:16 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

refactor: 🔥 Move Custom Emojis Structure to same page as extension

Browse source
This commit is contained in:
Jesse Wierzbinski 2024-08-27 22:53:26 +02:00
parent b0bd14411d
commit d3a2d84a40
No known key found for this signature in database
4 changed files with 39 additions and 52 deletions
Download patch file Download diff file Expand all files Collapse all files

40
app/extensions/custom-emojis/page.mdx
View file

@ -7,6 +7,42 @@ export const metadata = {
The Custom Emojis extension adds support for adding personalized emojis to federated data. {{ className: 'lead' }}
## Structure Definition
<Row>
<Col>
<Properties>
<Property name="name" type="string" required={true}>
Emoji name, surrounded by identification characters (for example, colons: `:happy_face:`).
Name must match the regex `^[a-zA-Z0-9_-]+$`.
Identification characters must not match the name regex (must not be alphanumeric/underscore/hyphen). There may only be two identification characters, one at the beginning and one at the end.
</Property>
<Property name="content" type="ContentFormat" required={true} typeLink="/structures/content-format">
Emoji content. Must be an image format (`image/*`).
</Property>
</Properties>
</Col>
<Col sticky>
```jsonc {{ 'title': 'Example Emoji' }}
{
"name": ":happy_face:",
"content": {
"image/webp": {
"content": "https://cdn.example.com/emojis/happy_face.webp",
"remote": true,
"description": "A happy emoji smiling.",
}
}
}
```
</Col>
</Row>
## Rendering
To render custom emojis, clients **should** perform the following steps:
@ -37,8 +73,8 @@ Custom Emojis can be added to any entity with text content. The extension ID is
<Row>
<Col>
<Properties>
<Property name="emojis" type="CustomEmoji[]" required={true} typeLink="/structures/emoji">
[Custom emojis](/structures/emoji) to be added to the note.
<Property name="emojis" type="CustomEmoji[]" required={true} typeLink="/extensions/custom-emoji#structure-definition">
[Custom emojis](/extensions/custom-emoji#structure-definition) to be added to the note.
</Property>
</Properties>
</Col>