Skip to content
Shortcut: /, ⌘K or Ctrl+K

ComposeBox

Props, styling and a live ComposeBox example.

View as Markdown
ComposeBox
Sample data
@polymorfa/react

Customize

Offer file attachments: the attach button, drop and paste. Defaults to `true`. Turn it off when the composer's actions have no upload adapter.

File types the attach button offers, as for `<input accept>`.

Offer named file types. Omit to keep the single file picker.

Allow picking several files at once. Defaults to `true`.

Resolves the reply banner's quoted message.

Resolves the reply banner's quoted message without a controller.

Replaces the locale's `composer.placeholder`.

Rendered in the toolbar before the built-in buttons.

Rendered after the message field, before the send or mic button.

Show the emoji picker button. Defaults to `true`.

Show the voice note button. Defaults to `true` where the browser has `MediaRecorder` and `getUserMedia`.

Send a voice note as soon as it finishes uploading. Defaults to `true`.

Options for the "/" quick reply menu.

Called after a quick reply's text is inserted.

Rows the message field grows to before it scrolls. Defaults to 8.

ComposeBoxExample.jsx
npm install @polymorfa/react@dev @polymorfa/browser@dev
import { PolymorfaProvider, ComposeBox } from "@polymorfa/react";

const appearance = { theme: "light", variables: { colorPrimary: "#635bff" } };

export function ComposeBoxExample({ composer }) {
  return (
    <PolymorfaProvider tokenEndpoint="/api/polymorfa/token" appearance={appearance}>
      <style>{"/* Composer row alignment until the UI Kit stylesheet includes it. */\n.pmfa-composer .pmfa-input { min-height: 40px; padding-block: max(4px, calc((40px - 1.45em - 2px) / 2)); }\n.pmfa-chat-window .pmfa-composer .pmfa-input { min-height: 44px; padding-block: max(4px, calc((44px - 1.4em - 2px) / 2)); }\n.pmfa-chat-window .pmfa-composer-row .pmfa-btn-icon { min-height: 44px; margin-block: 0; }\n@media (max-width: 600px) { .pmfa-composer .pmfa-input { min-height: 44px; padding-block: max(4px, calc((44px - 1.45em - 2px) / 2)); } }"}</style>
      <ComposeBox
        controller={composer}
        attachments
        accept="image/*,application/pdf"
        attachmentKinds={["image", "document"]}
        multiple
        placeholder="Write a message…"
        emoji
        voiceNotes={false}
        voiceNoteAutoSend={false}
        quickReplies={[
          { id: "hello", shortcut: "hello", text: "Hi! How can I help?" }
        ]}
        maxRows={8}
      />
    </PolymorfaProvider>
  );
}

ComposeBox from @polymorfa/react. Choose props and styles above; the preview stays visible in every code view.

Props#

  • onSent() => void

    Called after a send.

  • classNamestring

    Class for the root.

  • classNamesSlotClassNames

    Classes keyed by slot.

  • attachmentsboolean

    Offer file attachments: the attach button, drop and paste. Defaults to true. Turn it off when the composer's actions have no upload adapter.

    Default true

  • acceptstring

    File types the attach button offers, as for <input accept>.

  • attachmentKindsreadonly AttachmentKind[]

    Offer named file types. Omit to keep the single file picker.

  • multipleboolean

    Allow picking several files at once. Defaults to true.

    Default true

  • conversationConversationController

    Resolves the reply banner's quoted message.

  • messagesreadonly ConversationMessage[]

    Resolves the reply banner's quoted message without a controller.

  • placeholderstring

    Replaces the locale's composer.placeholder.

    Default Locale text

  • startActionsReactNode

    Rendered in the toolbar before the built-in buttons.

  • endActionsReactNode

    Rendered after the message field, before the send or mic button.

  • emojiboolean

    Show the emoji picker button. Defaults to true.

    Default true

  • voiceNotesboolean

    Show the voice note button. Defaults to true where the browser has MediaRecorder and getUserMedia.

    Default true where supported

  • voiceNoteAutoSendboolean

    Send a voice note as soon as it finishes uploading. Defaults to true.

    Default true

  • quickRepliesreadonly QuickReplyOption[]

    Options for the "/" quick reply menu.

  • onQuickReply(option: QuickReplyOption) => void

    Called after a quick reply's text is inserted.

  • maxRowsnumber

    Rows the message field grows to before it scrolls. Defaults to 8.

    Default 8

  • controllerMessageComposerController

    Composer state.

  • createController() => MessageComposerController

    Factory for a controller the component owns.

Types#

Named types used in the props above.

@polymorfa/ui
type AttachmentKind =
  | "image"
  | "video"
  | "audio"
  | "document";

Styling#

Use className, classNames (a class for any slot, typed SlotClassNames), appearance variables and element styles. The Style panel applies changes to the live component. See Appearance.

Setup#

Use the provider and server route for your application. The preview above uses local sample data and controllers. Chat controllers and inbox data sources keep your data separate from the UI.