Skip to main content

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

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:37

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:41

message​

• message: undefined | StreamMessage<DefaultStreamChatGenerics>

The message the actions will be executed on

Defined in​

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

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:49

customActions​

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

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

Defined in​

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

displayedActionsCount​

• Readonly displayedActionsCount: EventEmitter<number>

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

Defined in​

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

isEditing​

• Readonly isEditing: EventEmitter<boolean>

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

Defined in​

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

Did you find this page helpful?