Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added images to chat docs #145

Merged
merged 2 commits into from
Nov 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions chat.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: 'Chat'
sidebarTitle: 'Overview'
---

<Frame>![Chat hero image](/public/images/chat-hero.png)</Frame>

_Chat is currently in Beta. This will not effect the reliability of this feature but we are heavily iterating and improving on the featureset._

Our Chat widget lets you embed a live chat interface on your website or app, allowing your customers to reach out to you without leaving your site. You can then respond to these messages directly from Plain.
Expand Down
9 changes: 9 additions & 0 deletions chat/customization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,15 @@
title: 'Customization'
---

<Frame>![Customise chat](/public/images/chat-customisation.png)</Frame>

## General customization

You can customize the chat widget to match your brand and user experience. You can change various aspects of the chat widget including both the appearance and behavior.




<Accordion title="General customization code">
<Snippet file="chat/customization.mdx" />
</Accordion>
Expand Down Expand Up @@ -34,6 +39,8 @@ set a label based on the page the user is on.

### Chat buttons

<Frame>![Chat buttons image](/public/images/chat-button-customisation.png)</Frame>

You can configure the primary chat button and any additional chat buttons that appear on the intro screen with text and an icon using the `chatButtons` array.

You can also pass `threadDetails` to a chat button to set fields on the thread when the user creates a chat from that specific button. If you provide the same field
Expand All @@ -45,6 +52,8 @@ in both the top-level `threadDetails` and a chat button, any single value fields

### Chat forms

<Frame>![Chat forms image](/public/images/chat-forms.png)</Frame>

Similar to chat buttons, chat forms allow you to set fields on the thread when the user creates a chat. These are specific to each `chatButton`.

<Accordion title="Chat forms code">
Expand Down
Binary file added public/images/chat-button-customisation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/chat-customisation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/chat-forms.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/chat-hero.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.