OpenMax
Free Trial

Built-in plugins

The built-in composer plugins (@ mentions, # work-item references, and the planned emoji button): what they do, which plugin abilities they use, which host capabilities they need and what they send.

Built-in plugins

COMPOSER_PLUGINS (exported from @openmaxai/chat/composer) holds the built-in plugins; they are what ChatProvider installs when you don't pass plugins. Their toolbar buttons appear in the order of the table.

Plugin id Trigger Plugin abilities used requiredPorts Sends
emoji Planned none toolbar none The picked emoji is a character in the text, nothing else
mention @, @ trigger, toolbar, nodes, sendKeys + contributeSend identity, i18n @ plus the display name in the text, and mentions
work-reference #, # trigger, toolbar, nodes workItems [#label](resourceUri) in the text, nothing else

What each plugin ability means is on Composer plugins.

@ mentions

Plugin id mention.

What it does: typing @ or @, or pressing the @ toolbar button, opens candidates:

  • members of the conversation other than yourself, matched on display name;
  • "all" and "all agents" at the top, where the conversation allows them;
  • people outside the conversation, from an organization directory search on the typed text.

Picking one inserts a mention chip. The chip is one unit: the caret skips over it and one backspace deletes it. Mentioned people see the @me capsule in their thread.

Plugin abilities used:

Ability Details
trigger Triggers @ and @; sets keepPanelOpenWhenEmpty, so the panel opens even when no conversation member matches, and searches the directory; sets listbox, so screen readers hear the highlighted candidate
toolbar One button, id mention, on the toolbar by default; a click inserts @, which opens the candidate panel
nodes Node mention, holding the display name and either a member id or an "all" kind
sendKeys + contributeSend Send key mentions

Host capabilities needed: requiredPorts is ["identity", "i18n"].

  • identity: conversation members (listMembers), the current user (currentUserId) and the organization directory search (searchDirectory).
  • i18n: the labels of "all" and "all agents".

Both are required capabilities, so @ is there on every host.

What it sends:

  • Each chip becomes @ plus the display name in the text.
  • Structured mentions come along, in the order they appear in the text, each person or each kind of "all" once: a member is { type: "member", memberId }, "all" is { type: "all" } and "all agents" is { type: "all_agents" }.
  • With nobody mentioned, the mentions field is left out.

The host receives them as mentions on messaging.sendMessage; see Host capabilities.

# work-item references

Plugin id work-reference.

What it does: typing # or #, or pressing the # toolbar button, searches projects and issues for the typed text. A project can be expanded to list its issues in the same panel, by clicking its arrow or with ArrowLeft / ArrowRight. Picking one inserts a work-item chip, which is also one unit.

Plugin abilities used:

Ability Details
trigger Triggers # and #; the candidate panel handles the left and right arrow keys itself
toolbar One button, id work-reference, on the toolbar by default; a click inserts #, which opens the candidate panel
nodes Node work_reference, holding the label, resource URI, id and kind (project or issue)

It uses neither sendKeys nor contributeSend: everything about the reference is in the text.

Host capabilities needed: requiredPorts is ["workItems"]. Its search finds projects and issues, and also fetches a project's issues when the project is expanded. How to implement it: Composer · # work items.

workItems is an optional capability. On a host without it, the SDK does not install this plugin: # is a plain character and the toolbar has no # button, while @ still works.

What it sends: each chip becomes [#label](resourceUri) in the text, a Markdown link; no other structured data.

Emoji

Plugin id emoji. Planned

What it does: an emoji button on the toolbar. Pressing it opens an emoji panel, and the picked emoji is inserted at the cursor as text. The button is there both when the composer is collapsed and when it is expanded; expanded, it sits in the bottom bar.

Plugin abilities used:

Ability What
toolbar One button, id emoji, on the toolbar by default; the button's Panel is the emoji panel

It uses no trigger, nodes, sendKeys or contributeSend: an emoji is plain text.

Host capabilities needed: none. requiredPorts is empty, so every host can install it.

What it sends: the emoji is a character in the text; no other structured data.