Themes/Theme SDK/Modules/inbox

inbox

The store's live chat: its state and actions, the complete widget and the parts it is built from.

On this page

import { … } from '@poltura/theme-sdk/inbox';

Hooks

Name	What it is
`useInbox`	The chat's view and actions: whether it is open, online or unread, the conversation, the help search and the merchant's wording and look.

Parts

Name	What it is
`InboxRoot`	The chat's frame: it pins the chat to its corner, applies the merchant's colours and shares the chat state with the parts inside it.
`InboxLauncher`	The round button that opens and closes the panel, with the unread count while the panel is closed.
`InboxPanel`	The chat panel that opens above the launcher.
`InboxPanelHeader`	The panel header with the title, whether someone is online and the close button.
`InboxConversation`	The conversation area: the message list, or the open help article in its place.
`InboxMessageList`	The messages of the conversation with day separators, the help search, suggestions and a jump to the latest message.
`InboxMessageBubble`	One message with its author, text, files and, for the shopper's own messages, how far it has been delivered.
`InboxComposer`	The message field with the attach and send buttons and the files waiting to be sent.
`InboxOfflineForm`	The contact form that replaces the composer while no one is online: name, email and a message sent as an email.
`InboxStatusLine`	The line above the composer that says the chat is reconnecting or that this is a preview.
`InboxKnowledgeSearch`	The help article search with its results, drawn only when the store offers help articles in the chat.
`InboxKnowledgeSuggestions`	A short list of help articles offered before the shopper writes, drawn only when there are some.
`InboxKnowledgeArticle`	The help article the shopper opened, with a button back to the results; draws nothing while none is open.
`InboxChatGlyph`	The speech bubble icon of the launcher.

Defaults

Name	What it is
`InboxWidget`	The complete live chat: the launcher and the panel with the conversation, the help search and the composer or the offline form.

Types

Name	What it is
`InboxActions`	What the shopper can do in the chat.
`InboxAppearance`	How the merchant set the chat up: which corner it sits in, its colour mode and its colours.
`InboxArticle`	A help article opened in full.
`InboxAttachment`	A file sent with a message.
`InboxAttachmentKind`	What kind of file a message carries.
`InboxAuthorKind`	Who wrote a message: the shopper, a team member, the AI assistant or the chat itself.
`InboxColors`	The colours of the chat in one colour mode, each a CSS colour or a design token reference such as `var(--card)`.
`InboxConnection`	The state of the chat's live connection to the store.
`InboxCopy`	Every text the chat shows, already resolved: the merchant's wording where set, the store language's otherwise.
`InboxDelivery`	How far a message the shopper sent has got.
`InboxKnowledge`	The help search inside the chat: whether it exists, what was asked, what was found and the article open now.
`InboxKnowledgeItem`	A help article found by a search, before it is opened.
`InboxMessage`	A message in the conversation.
`InboxPendingAttachment`	A file the shopper has picked and not sent yet.
`InboxState`	The chat's view and the actions the shopper can take.
`InboxView`	What the chat shows right now.
`InboxRootProps`	Props of `InboxRoot`.
`InboxLauncherProps`	Props of `InboxLauncher`.
`InboxPanelProps`	Props of `InboxPanel`.
`InboxPanelHeaderProps`	Props of `InboxPanelHeader`.
`InboxConversationProps`	Props of `InboxConversation`.
`InboxMessageListProps`	Props of `InboxMessageList`.
`InboxMessageBubbleProps`	Props of `InboxMessageBubble`.
`InboxComposerProps`	Props of `InboxComposer`.
`InboxOfflineFormProps`	Props of `InboxOfflineForm`.
`InboxStatusLineProps`	Props of `InboxStatusLine`.
`InboxKnowledgeSearchProps`	Props of `InboxKnowledgeSearch`.
`InboxKnowledgeSuggestionsProps`	Props of `InboxKnowledgeSuggestions`.
`InboxKnowledgeArticleProps`	Props of `InboxKnowledgeArticle`.
`InboxChatGlyphProps`	Props of `InboxChatGlyph`.

Last updated Oct 29, 2026