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.

Sign up for GitHub

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

Jump to bottom

Chatplugin overview section #1207

Merged
merged 1 commit into from
Mar 11, 2021
Merged

Chatplugin overview section #1207

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
52 changes: 48 additions & 4 deletions docs/docs/sources/chatplugin/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,57 @@ sidebar_label: Overview
---

import TLDR from "@site/src/components/TLDR";
import ButtonBox from "@site/src/components/ButtonBox";
import ButtonBoxList from "@site/src/components/ButtonBoxList";
import HammerAndWrenchSVG from "@site/static/icons/hammer-and-wrench.svg";

<TLDR>

Airy's Live Chat Plugin is an **open-source chat widget** that you can put on your website to chat with your visitors.
Airy's Live Chat Plugin is an open-source chat widget that is fully customizable
and included in Airy Core

</TLDR>

The Airy Live Chat Plugin is a fully-featured
[source](/getting-started/glossary#source) that enables conversations with
anonymous website visitors through a web chat plugin.
## Introduction

Having a Live Chat plugin on your website has become essential. Connect with
your website visitors, communicate with them in real time, or use a bot to
automate FAQs.

Airy’s Live Chat Plugin comes out of the box fully working, but thanks to its
open-source nature and React Render Props you can customize everything about it.

Out of the box Airy’s Live Chat Plugin supports:

- Full customization of look, feel and features
- All message types, including emojis
- Rich Messaging: Templates, cards & carousels
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Templates and cards are the same right?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

templates in Facebook, cards in Google. better to have all mentioned for people who only know one of the terms


## How it's build

The Airy Live Chat Plugin is JavaScript library built with
[preact](https://preactjs.com/)and
[TypeScript](https://www.typescriptlang.org/).

The library makes heavy use of [render
props](https://reactjs.org/docs/render-props.html) so that you can customize its
behavior in every aspect. The library handles all the
[communication](/api/endpoints/chatplugin.md) with Airy Core transparently for
you.

## Customization

Completely customize your Live Chat and make it match your brand:

<ButtonBoxList>
<ButtonBox
icon={() => <HammerAndWrenchSVG />}
title='Learn more about the customization of your Chat Plugin'
description='From colors to shapes and sizes: everything is editable'
link='/sources/chatplugin/customization'
/>
</ButtonBoxList>

## Supported message types

TODO