Class MessageComposer<CustomAttrs>

The MessageComposer component displays the composer content for sending a new message. It adds a selection field as a header control so the user can enter the recipient(s) of their message.

Type Parameters

CustomAttrs extends IMessageComposerAttrs = IMessageComposerAttrs

Hierarchy (View Summary)

ComposerBody<CustomAttrs>
- MessageComposer

Index

Constructors

Properties

Methods

data headerItems oninit onsubmit focusOnSelector initAttrs

Constructors

constructor

new MessageComposer<
CustomAttrs extends
IMessageComposerAttrs<CustomAttrs> = IMessageComposerAttrs,
>(): MessageComposer<CustomAttrs>
Type Parameters
- CustomAttrs extends IMessageComposerAttrs<CustomAttrs> = IMessageComposerAttrs
Returns MessageComposer<CustomAttrs>
Inherited from ComposerBody.constructor

Properties

`Protected`recipients

recipients: Stream<User[]>

Methods

data

data(): Record<string, unknown>
Get the data to submit to the server when the discussion is saved.

Returns Record<string, unknown>
- Defined in extensions/messages/js/src/forum/components/MessageComposer.tsx:100

headerItems

headerItems(): ItemList<Children>
Build an item list for the composer's header.

Returns ItemList<Children>
Overrides ComposerBody.headerItems
- Defined in extensions/messages/js/src/forum/components/MessageComposer.tsx:53

oninit

oninit(vnode: Vnode<CustomAttrs, MessageComposer<CustomAttrs>>): void
Parameters
- vnode: Vnode<CustomAttrs, MessageComposer<CustomAttrs>>
Returns void
Inherit Doc
Overrides ComposerBody.oninit
- Defined in extensions/messages/js/src/forum/components/MessageComposer.tsx:39

onsubmit

onsubmit(): void
Handle the submit event of the text editor.

Returns void
Overrides ComposerBody.onsubmit
- Defined in extensions/messages/js/src/forum/components/MessageComposer.tsx:123

`Static`focusOnSelector

focusOnSelector(): string
Returns string
Overrides ComposerBody.focusOnSelector
- Defined in extensions/messages/js/src/forum/components/MessageComposer.tsx:28

`Static`initAttrs

initAttrs(attrs: IMessageComposerAttrs): void
Initialize the component's attrs.

This can be used to assign default values for missing, optional attrs.
Parameters
- attrs: IMessageComposerAttrs
Returns void
Overrides ComposerBody.initAttrs
- Defined in extensions/messages/js/src/forum/components/MessageComposer.tsx:30