MessageActionsBoxComponent

The MessageActionsBox component displays a list of message actions (i.e edit), that can be opened or closed. You can find the list of the supported actions in the message interaction guide.

Example 1 - example message actions with the message component:

Basic usage

A typical use case for the MessageActionsBox component would be to use in your custom components that will completely override the message component.

@Component({
  selector: "app-custom-message",
  template: `
    <stream-message-actions-box
      [isOpen]="isActionBoxOpen"
      [isMine]="isMessageSentByCurrentUser"
    ></stream-message-actions-box>
    <!-- Other parts of the custom message component -->
  `,
})
export class CustomMessageComponent {
  @Input() message: StreamMessage;
  isActionBoxOpen: boolean;
  isMessageSentByCurrentUser: boolean;
}

Customization

• You can provide your own message actions box component (or just a template for the items) by the CustomTemplatesService.
• You can extend the built-in actions with custom actions, for more info see the MessageActionsService
• You can also provide a custom event handler method to be called when the message actions button is clicked, for more info see the MessageActionsService

Inputs and outputs

isOpen

• isOpen: boolean = false

Indicates if the list should be opened or closed. Adding a UI element to open and close the list is the parent’s component responsibility.

deprecated No need for this since theme-v2

Defined in

lib/message-actions-box/message-actions-box.component.ts:39

isMine

• isMine: boolean = false

Indicates if the message actions are belonging to a message that was sent by the current user or not.

Defined in

lib/message-actions-box/message-actions-box.component.ts:43

message

• message: undefined | StreamMessage<DefaultStreamChatGenerics>

The message the actions will be executed on

Defined in

lib/message-actions-box/message-actions-box.component.ts:47

enabledActions

• enabledActions: string[] = []

The list of channel capabilities that are enabled for the current user, the list of supported interactions can be found in our message interaction guide. Unathorized actions won’t be displayed on the UI.

Defined in

lib/message-actions-box/message-actions-box.component.ts:51

customActions

• customActions: CustomMessageActionItem<DefaultStreamChatGenerics>[] = []

A list of custom message actions to be displayed in the action box

In the next major release this will be released with messageReactionsService.customActions$

More information: /chat/docs/sdk/angular/services/MessageActionsService

Defined in

lib/message-actions-box/message-actions-box.component.ts:59

displayedActionsCount

• Readonly displayedActionsCount: EventEmitter<number>

The number of authorized actions (it can be less or equal than the number of enabled actions)

deprecated components should use messageReactionsService.getAuthorizedMessageActionsCount method

More information: /chat/docs/sdk/angular/services/MessageActionsService

Defined in

lib/message-actions-box/message-actions-box.component.ts:67

isEditing

• Readonly isEditing: EventEmitter<boolean>

An event which emits true if the edit message modal is open, and false when it is closed.

deprecated components should use messageReactionsService.messageToEdit$ Observable

More information: /chat/docs/sdk/angular/services/MessageActionsService

Defined in

lib/message-actions-box/message-actions-box.component.ts:75