Developers
Start building
Themes/Theme SDK/Modules/inbox/Types: InboxView to InboxChatGlyphProps

Types: InboxView to InboxChatGlyphProps

The types of @poltura/theme-sdk/inbox, InboxView to InboxChatGlyphProps.

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

InboxView

What the chat shows right now.

availablerequiredboolean

Whether the store offers chat and the theme shows it.

onlinerequiredboolean

Whether someone is available to answer now.

openrequiredboolean

Whether the panel is open.

previewrequiredboolean

Whether the chat runs on sample data, as in the customizer, so nothing is sent.

unreadrequirednumber

How many team messages the shopper has not seen.

connectionrequiredInboxConnection

Whether the chat is live, connecting, reconnecting or offline.

typingrequiredboolean

Whether the other side is typing.

sendingrequiredboolean

Whether a message is being sent.

messagesrequiredInboxMessage[]

The conversation in order, oldest first.

pendingAttachmentsrequiredInboxPendingAttachment[]

The files picked and not sent yet.

appearancerequiredInboxAppearance

How the merchant set the chat up.

copyrequiredInboxCopy

Every text the chat shows.

knowledgerequiredInboxKnowledge

The help search inside the chat.

InboxRootProps

Props of InboxRoot.

childrenrequiredReactNode

The panel and the launcher, drawn inside the chat's frame.

classNamestring

Classes added to the frame.

InboxLauncherProps

Props of InboxLauncher.

childrenReactNode

Replaces the chat glyph inside the button.

classNamestring

Classes added to the button.

InboxPanelProps

Props of InboxPanel.

childrenrequiredReactNode

The header, the conversation and the composer.

classNamestring

Classes added to the panel.

InboxPanelHeaderProps

Props of InboxPanelHeader.

titlestring

Replaces the panel heading; defaults to the merchant's chat title.

childrenReactNode

Drawn in the header beside the title, such as extra buttons.

classNamestring

Classes added to the header.

InboxConversationProps

Props of InboxConversation.

renderMessage(message: InboxMessage) => ReactNode

Draws one message in place of the default bubble.

classNamestring

Classes added to the conversation.

InboxMessageListProps

Props of InboxMessageList.

renderMessage(message: InboxMessage) => ReactNode

Draws one message in place of the default bubble.

classNamestring

Classes added to the list.

InboxMessageBubbleProps

Props of InboxMessageBubble.

messagerequiredInboxMessage

The message to draw.

classNamestring

Classes added to the bubble.

InboxComposerProps

Props of InboxComposer.

placeholderstring

Replaces the message field's placeholder; defaults to the merchant's wording.

classNamestring

Classes added to the composer.

InboxOfflineFormProps

Props of InboxOfflineForm.

classNamestring

Classes added to the form.

InboxStatusLineProps

Props of InboxStatusLine.

classNamestring

Classes added to the status line.

InboxKnowledgeSearchProps

Props of InboxKnowledgeSearch.

placeholderstring

Replaces the search field's placeholder; defaults to the merchant's wording.

classNamestring

Classes added to the search.

InboxKnowledgeSuggestionsProps

Props of InboxKnowledgeSuggestions.

limitnumber

The most articles to suggest; defaults to the host's choice.

classNamestring

Classes added to the suggestions.

InboxKnowledgeArticleProps

Props of InboxKnowledgeArticle.

classNamestring

Classes added to the article.

InboxChatGlyphProps

Props of InboxChatGlyph.

sizenumber

The glyph's width and height in pixels; defaults to 24.

classNamestring

Classes added to the glyph.

Last updated