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

ChatDrawer

Props, styling and a live ChatDrawer example.

View as Markdown
ChatDrawer
Sample data
@polymorfa/react

Customize

Custom footer; takes precedence over the built-in composer.

Alias of `controller`.

Renders the built-in composer and wires message Reply to it.

Move focus into the drawer when it first mounts open. Defaults to `false`; focus always moves when `open` changes to `true`.

composerProps17 props

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 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.

Presentation-only: never reloads history or cancels a send.

Show a Reply action on each message.

ChatDrawerExample.jsx
npm install @polymorfa/react@dev @polymorfa/browser@dev
import { useState } from "react";
import { PolymorfaProvider, ChatDrawer } from "@polymorfa/react";

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

export function ChatDrawerExample({ conversation, composer }) {
  const [open, setOpen] = useState(true);
  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>
      <ChatDrawer
        controller={conversation}
        composerController={composer}
        open={open}
        title="Avery Morgan"
        autoFocus={false}
        composerProps={{
          attachments: true,
          accept: "image/*,application/pdf",
          attachmentKinds: ["image", "document"],
          multiple: true,
          emoji: true,
          voiceNotes: false,
          voiceNoteAutoSend: false,
          placeholder: "Write a message…",
          maxRows: 8,
          quickReplies: [
            { id: "hello", shortcut: "hello", text: "Hi! How can I help?" }
          ]
        }}
        onClose={() => setOpen(false)}
      />
    </PolymorfaProvider>
  );
}

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

Props#

  • openboolean

    Shows the drawer. Nothing renders while it is false.

    Default true

  • onClose() => void

    Called by the close button and by Escape inside the drawer.

  • composerReactNode

    Custom footer; takes precedence over the built-in composer.

  • titlestring

    Drawer title and accessible name.

  • conversationConversationController

    Alias of controller.

  • composerControllerMessageComposerController

    Renders the built-in composer and wires message Reply to it.

  • createComposerController() => MessageComposerController

    Factory for a composer the drawer owns.

  • autoFocusboolean

    Move focus into the drawer when it first mounts open. Defaults to false; focus always moves when open changes to true.

    Default false

  • composerPropsOmit<ComposeBoxProps, "controller" | "createController" | "conversation">

    Props for the built-in composer.

  • classNamestring

    Same as MessageList.

  • classNamesSlotClassNames

    Same as MessageList.

  • controllerConversationController

    Conversation to render.

  • createController() => ConversationController

    Conversation to render.

  • messageFilter(message: ConversationMessage) => boolean

    Presentation-only: never reloads history or cancels a send.

  • renderMessage(message: ConversationMessage) => ReactNode

    Same as MessageList.

  • renderAttachmentRenderAttachment

    Same as MessageList.

  • onReply(message: ConversationMessage) => void

    Show a Reply action on each message.

composerProps#

  • 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

  • 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

Types#

Named types used in the props above.

@polymorfa/ui
type AttachmentKind =
  | "image"
  | "video"
  | "audio"
  | "document";
@polymorfa/react
type RenderAttachment = (attachment: MessageAttachment, message: ConversationMessage) => ReactNode;

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.