# inbox (/themes/sdk/reference/inbox) ```ts import { … } from '@poltura/theme-sdk/inbox'; ``` ## [Hooks](/themes/sdk/reference/inbox/hooks) [#hooks] | Name | What it is | | --- | --- | | [`useInbox`](/themes/sdk/reference/inbox/hooks#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](/themes/sdk/reference/inbox/parts-1) [#parts] | Name | What it is | | --- | --- | | [`InboxRoot`](/themes/sdk/reference/inbox/parts-1#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`](/themes/sdk/reference/inbox/parts-1#inboxlauncher) | The round button that opens and closes the panel, with the unread count while the panel is closed. | | [`InboxPanel`](/themes/sdk/reference/inbox/parts-1#inboxpanel) | The chat panel that opens above the launcher. | | [`InboxPanelHeader`](/themes/sdk/reference/inbox/parts-1#inboxpanelheader) | The panel header with the title, whether someone is online and the close button. | | [`InboxConversation`](/themes/sdk/reference/inbox/parts-1#inboxconversation) | The conversation area: the message list, or the open help article in its place. | | [`InboxMessageList`](/themes/sdk/reference/inbox/parts-1#inboxmessagelist) | The messages of the conversation with day separators, the help search, suggestions and a jump to the latest message. | | [`InboxMessageBubble`](/themes/sdk/reference/inbox/parts-1#inboxmessagebubble) | One message with its author, text, files and, for the shopper's own messages, how far it has been delivered. | | [`InboxComposer`](/themes/sdk/reference/inbox/parts-1#inboxcomposer) | The message field with the attach and send buttons and the files waiting to be sent. | | [`InboxOfflineForm`](/themes/sdk/reference/inbox/parts-1#inboxofflineform) | The contact form that replaces the composer while no one is online: name, email and a message sent as an email. | | [`InboxStatusLine`](/themes/sdk/reference/inbox/parts-1#inboxstatusline) | The line above the composer that says the chat is reconnecting or that this is a preview. | | [`InboxKnowledgeSearch`](/themes/sdk/reference/inbox/parts-1#inboxknowledgesearch) | The help article search with its results, drawn only when the store offers help articles in the chat. | | [`InboxKnowledgeSuggestions`](/themes/sdk/reference/inbox/parts-1#inboxknowledgesuggestions) | A short list of help articles offered before the shopper writes, drawn only when there are some. | | [`InboxKnowledgeArticle`](/themes/sdk/reference/inbox/parts-1#inboxknowledgearticle) | The help article the shopper opened, with a button back to the results; draws nothing while none is open. | | [`InboxChatGlyph`](/themes/sdk/reference/inbox/parts-2#inboxchatglyph) | The speech bubble icon of the launcher. | ## [Defaults](/themes/sdk/reference/inbox/defaults) [#defaults] | Name | What it is | | --- | --- | | [`InboxWidget`](/themes/sdk/reference/inbox/defaults#inboxwidget) | The complete live chat: the launcher and the panel with the conversation, the help search and the composer or the offline form. | ## [Types](/themes/sdk/reference/inbox/types-1) [#types] | Name | What it is | | --- | --- | | [`InboxActions`](/themes/sdk/reference/inbox/types-1#inboxactions) | What the shopper can do in the chat. | | [`InboxAppearance`](/themes/sdk/reference/inbox/types-1#inboxappearance) | How the merchant set the chat up: which corner it sits in, its colour mode and its colours. | | [`InboxArticle`](/themes/sdk/reference/inbox/types-1#inboxarticle) | A help article opened in full. | | [`InboxAttachment`](/themes/sdk/reference/inbox/types-1#inboxattachment) | A file sent with a message. | | [`InboxAttachmentKind`](/themes/sdk/reference/inbox/types-1#inboxattachmentkind) | What kind of file a message carries. | | [`InboxAuthorKind`](/themes/sdk/reference/inbox/types-1#inboxauthorkind) | Who wrote a message: the shopper, a team member, the AI assistant or the chat itself. | | [`InboxColors`](/themes/sdk/reference/inbox/types-1#inboxcolors) | The colours of the chat in one colour mode, each a CSS colour or a design token reference such as `var(--card)`. | | [`InboxConnection`](/themes/sdk/reference/inbox/types-1#inboxconnection) | The state of the chat's live connection to the store. | | [`InboxCopy`](/themes/sdk/reference/inbox/types-1#inboxcopy) | Every text the chat shows, already resolved: the merchant's wording where set, the store language's otherwise. | | [`InboxDelivery`](/themes/sdk/reference/inbox/types-1#inboxdelivery) | How far a message the shopper sent has got. | | [`InboxKnowledge`](/themes/sdk/reference/inbox/types-1#inboxknowledge) | The help search inside the chat: whether it exists, what was asked, what was found and the article open now. | | [`InboxKnowledgeItem`](/themes/sdk/reference/inbox/types-1#inboxknowledgeitem) | A help article found by a search, before it is opened. | | [`InboxMessage`](/themes/sdk/reference/inbox/types-1#inboxmessage) | A message in the conversation. | | [`InboxPendingAttachment`](/themes/sdk/reference/inbox/types-1#inboxpendingattachment) | A file the shopper has picked and not sent yet. | | [`InboxState`](/themes/sdk/reference/inbox/types-1#inboxstate) | The chat's view and the actions the shopper can take. | | [`InboxView`](/themes/sdk/reference/inbox/types-2#inboxview) | What the chat shows right now. | | [`InboxRootProps`](/themes/sdk/reference/inbox/types-2#inboxrootprops) | Props of [`InboxRoot`](/themes/sdk/reference/inbox/parts-1#inboxroot). | | [`InboxLauncherProps`](/themes/sdk/reference/inbox/types-2#inboxlauncherprops) | Props of [`InboxLauncher`](/themes/sdk/reference/inbox/parts-1#inboxlauncher). | | [`InboxPanelProps`](/themes/sdk/reference/inbox/types-2#inboxpanelprops) | Props of [`InboxPanel`](/themes/sdk/reference/inbox/parts-1#inboxpanel). | | [`InboxPanelHeaderProps`](/themes/sdk/reference/inbox/types-2#inboxpanelheaderprops) | Props of [`InboxPanelHeader`](/themes/sdk/reference/inbox/parts-1#inboxpanelheader). | | [`InboxConversationProps`](/themes/sdk/reference/inbox/types-2#inboxconversationprops) | Props of [`InboxConversation`](/themes/sdk/reference/inbox/parts-1#inboxconversation). | | [`InboxMessageListProps`](/themes/sdk/reference/inbox/types-2#inboxmessagelistprops) | Props of [`InboxMessageList`](/themes/sdk/reference/inbox/parts-1#inboxmessagelist). | | [`InboxMessageBubbleProps`](/themes/sdk/reference/inbox/types-2#inboxmessagebubbleprops) | Props of [`InboxMessageBubble`](/themes/sdk/reference/inbox/parts-1#inboxmessagebubble). | | [`InboxComposerProps`](/themes/sdk/reference/inbox/types-2#inboxcomposerprops) | Props of [`InboxComposer`](/themes/sdk/reference/inbox/parts-1#inboxcomposer). | | [`InboxOfflineFormProps`](/themes/sdk/reference/inbox/types-2#inboxofflineformprops) | Props of [`InboxOfflineForm`](/themes/sdk/reference/inbox/parts-1#inboxofflineform). | | [`InboxStatusLineProps`](/themes/sdk/reference/inbox/types-2#inboxstatuslineprops) | Props of [`InboxStatusLine`](/themes/sdk/reference/inbox/parts-1#inboxstatusline). | | [`InboxKnowledgeSearchProps`](/themes/sdk/reference/inbox/types-2#inboxknowledgesearchprops) | Props of [`InboxKnowledgeSearch`](/themes/sdk/reference/inbox/parts-1#inboxknowledgesearch). | | [`InboxKnowledgeSuggestionsProps`](/themes/sdk/reference/inbox/types-2#inboxknowledgesuggestionsprops) | Props of [`InboxKnowledgeSuggestions`](/themes/sdk/reference/inbox/parts-1#inboxknowledgesuggestions). | | [`InboxKnowledgeArticleProps`](/themes/sdk/reference/inbox/types-2#inboxknowledgearticleprops) | Props of [`InboxKnowledgeArticle`](/themes/sdk/reference/inbox/parts-1#inboxknowledgearticle). | | [`InboxChatGlyphProps`](/themes/sdk/reference/inbox/types-2#inboxchatglyphprops) | Props of [`InboxChatGlyph`](/themes/sdk/reference/inbox/parts-2#inboxchatglyph). |