export const metadata = {
    title: "Reactions Extension",
    description: "The Reactions Extension allows users to react to posts with emojis",
}

# Reactions Extension

The Reactions Extension allows users to express their reactions ("react") to posts with emojis. {{ className: 'lead' }}

## Federation

User reactions are (like every other entity) federated to all followers, and can be displayed to clients depending on the privacy settings of the associated [Note](/entities/note).

## Entity Definition

<Row>
    <Col>
        <Properties name="Reaction">
            <Property name="type" type="string" required>
                Must be `pub.versia:reactions/Reaction`.
            </Property>
            <Property name="author" type="Reference" required typeLink="/types#reference">
                [Reference](/types#reference) to the [User](/entities/user) that is reacting.
            </Property>
            <Property name="object" type="Reference" required typeLink="/types#reference">
                [Reference](/types#reference) to the [Note](/entities/note) attached to the reaction.
            </Property>
            <Property name="content" type="string" required>
                Emoji content of reaction. May also be arbitrary text, or [Custom Emoji](/extensions/custom-emojis) if supported.

                Clients are encouraged to disfavour text in favour of emoji where possible.
            </Property>
        </Properties>
    </Col>

    <Col sticky>

    ```jsonc {{ title: "Example Entity" }}
    {
        "id": "6f27bc77-58ee-4c9b-b804-8cc1c1182fa9",
        "type": "pub.versia:reactions/Reaction", // [!code focus]
        "created_at": "2021-01-01T00:00:00.000Z",
        "author": "6e0204a2-746c-4972-8602-c4f37fc63bbe", // [!code focus:3]
        "object": "example.com:f08a124e-fe90-439e-8be4-15a428a72a19",
        "content": "😀",
    }
    ```
    
    </Col>
</Row>

## Note Collections

The Likes extension adds the following collections to the [Note](/entities/note) entity:

- `pub.versia:reactions/Reactions`: [URI Collection](/structures/collection#uri-collection) of all the reactions to the note.

## Interaction Types

<Note>
    This section only applies to implementors of the [Interaction Controls Extension](/extensions/interaction-controls).
</Note>

This extension registers the following interaction types:
- `pub.versia:reactions#React`, for adding a Reaction to a Note.