Types: InboxView to InboxChatGlyphProps
The types of @poltura/theme-sdk/inbox, InboxView to InboxChatGlyphProps.
Ezen az oldalon
import { … } from '@poltura/theme-sdk/inbox';InboxView
What the chat shows right now.
availablerequiredbooleanWhether the store offers chat and the theme shows it.
onlinerequiredbooleanWhether someone is available to answer now.
openrequiredbooleanWhether the panel is open.
previewrequiredbooleanWhether the chat runs on sample data, as in the customizer, so nothing is sent.
unreadrequirednumberHow many team messages the shopper has not seen.
connectionrequiredInboxConnectionWhether the chat is live, connecting, reconnecting or offline.
typingrequiredbooleanWhether the other side is typing.
sendingrequiredbooleanWhether a message is being sent.
messagesrequiredInboxMessage[]The conversation in order, oldest first.
pendingAttachmentsrequiredInboxPendingAttachment[]The files picked and not sent yet.
appearancerequiredInboxAppearanceHow the merchant set the chat up.
copyrequiredInboxCopyEvery text the chat shows.
knowledgerequiredInboxKnowledgeThe help search inside the chat.
InboxRootProps
Props of InboxRoot.
childrenrequiredReactNodeThe panel and the launcher, drawn inside the chat's frame.
classNamestringClasses added to the frame.
InboxLauncherProps
Props of InboxLauncher.
childrenReactNodeReplaces the chat glyph inside the button.
classNamestringClasses added to the button.
InboxPanelProps
Props of InboxPanel.
childrenrequiredReactNodeThe header, the conversation and the composer.
classNamestringClasses added to the panel.
InboxPanelHeaderProps
Props of InboxPanelHeader.
titlestringReplaces the panel heading; defaults to the merchant's chat title.
childrenReactNodeDrawn in the header beside the title, such as extra buttons.
classNamestringClasses added to the header.
InboxConversationProps
Props of InboxConversation.
renderMessage(message: InboxMessage) => ReactNodeDraws one message in place of the default bubble.
classNamestringClasses added to the conversation.
InboxMessageListProps
Props of InboxMessageList.
renderMessage(message: InboxMessage) => ReactNodeDraws one message in place of the default bubble.
classNamestringClasses added to the list.
InboxMessageBubbleProps
Props of InboxMessageBubble.
messagerequiredInboxMessageThe message to draw.
classNamestringClasses added to the bubble.
InboxComposerProps
Props of InboxComposer.
placeholderstringReplaces the message field's placeholder; defaults to the merchant's wording.
classNamestringClasses added to the composer.
InboxOfflineFormProps
Props of InboxOfflineForm.
classNamestringClasses added to the form.
InboxStatusLineProps
Props of InboxStatusLine.
classNamestringClasses added to the status line.
InboxKnowledgeSearchProps
Props of InboxKnowledgeSearch.
placeholderstringReplaces the search field's placeholder; defaults to the merchant's wording.
classNamestringClasses added to the search.
InboxKnowledgeSuggestionsProps
Props of InboxKnowledgeSuggestions.
limitnumberThe most articles to suggest; defaults to the host's choice.
classNamestringClasses added to the suggestions.
InboxKnowledgeArticleProps
Props of InboxKnowledgeArticle.
classNamestringClasses added to the article.
InboxChatGlyphProps
Props of InboxChatGlyph.
sizenumberThe glyph's width and height in pixels; defaults to 24.
classNamestringClasses added to the glyph.