discourse/plugins/chat/assets/stylesheets/common/chat-message-blocks.scss

.chat-message__blocks {
  padding-block: 0.5em;
  display: flex;
  flex-direction: column;
  gap: 0.5em;
}

.chat-message__block {
  .block__actions {
    display: flex;
    gap: 0.5em;
  }

  .block__button {
    .emoji {
      height: 18px;
      width: 18px;
    }
  }
}
DEV: adds blocks support to chat messages (#29782) Blocks allow BOTS to augment the capacities of a chat message. At the moment only one block is available: `actions`, accepting only one type of element: `button`. <img width="708" alt="Screenshot 2024-11-15 at 19 14 02" src="https://github.com/user-attachments/assets/63f32a29-05b1-4f32-9edd-8d8e1007d705"> # Usage ```ruby Chat::CreateMessage.call( params: { message: "Welcome!", chat_channel_id: 2, blocks: [ { type: "actions", elements: [ { value: "foo", type: "button", text: { text: "How can I install themes?", type: "plain_text" } } ] } ] }, guardian: Discourse.system_user.guardian ) ``` # Documentation ## Blocks ### Actions Holds interactive elements: button. #### Fields \| Field \| Type \| Description \| Required? \| \|--------\|--------\|--------\|--------\| \| type \| string \| For an actions block, type is always `actions` \| Yes \| \| elements \| array \| An array of interactive elements, maximum 10 elements \| Yes \| \| block_id \| string \| An unique identifier for the block, will be generated if not specified. It has to be unique per message \| No \| #### Example ```json { "type": "actions", "block_id": "actions_1", "elements": [...] } ``` ## Elements ### Button #### Fields \| Field \| Type \| Description \| Required? \| \|--------\|--------\|--------\|--------\| \| type \| string \| For a button, type is always `button` \| Yes \| \| text \| object \| A text object holding the type and text. Max 75 characters \| Yes \| \| value \| string \| The value returned after the interaction has been validated. Maximum length is 2000 characters \| No \| \| style \| string \| Can be `primary` , `success` or `danger` \| No \| \| action_id \| string \| An unique identifier for the action, will be generated if not specified. It has to be unique per message \| No \| #### Example ```json { "type": "actions", "block_id": "actions_1", "elements": [ { "type": "button", "text": { "type": "plain_text", "text": "Ok" }, "value": "ok", "action_id": "button_1" } ] } ``` ## Interactions When a user interactions with a button the following flow will happen: - We send an interaction request to the server - Server checks if the user can make this interaction - If the user can make this interaction, the server will: * `DiscourseEvent.trigger(:chat_message_interaction, interaction)` * return a JSON document ```json { "interaction": { "user": { "id": 1, "username": "j.jaffeux" }, "channel": { "id": 1, "title": "Staff" }, "message": { "id": 1, "text": "test", "user_id": -1 }, "action": { "text": { "text": "How to install themes?", "type": "plain_text" }, "type": "button", "value": "click_me_123", "action_id": "bf4f30b9-de99-4959-b3f5-632a6a1add04" } } } ``` * Fire a `appEvents.trigger("chat:message_interaction", interaction)` 2024-11-19 14:07:58 +08:00			`.chat-message__blocks {`
			`padding-block: 0.5em;`
			`display: flex;`
			`flex-direction: column;`
			`gap: 0.5em;`
			`}`

			`.chat-message__block {`
			`.block__actions {`
			`display: flex;`
			`gap: 0.5em;`
			`}`

			`.block__button {`
			`.emoji {`
			`height: 18px;`
			`width: 18px;`
			`}`
			`}`
			`}`