Skip to content

Commit b1b210b

Browse files
committed
dosc: add chatwoot section to README
1 parent 51e2776 commit b1b210b

1 file changed

Lines changed: 32 additions & 1 deletion

File tree

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# React Live Chat Loader
22

33
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
4+
45
[![All Contributors](https://img.shields.io/badge/all_contributors-6-orange.svg?style=flat-square)](#contributors-)
6+
57
<!-- ALL-CONTRIBUTORS-BADGE:END -->
68

79
An npm module that allows you to mitigate the negative performance and user
@@ -126,7 +128,7 @@ You can pass the following props to the `LiveChatLoaderProvider` provider:
126128

127129
## Supported Providers
128130

129-
Currently there are five supported providers:
131+
Currently there are six supported providers:
130132

131133
<details>
132134
<summary>Help Scout</summary>
@@ -305,6 +307,35 @@ You can customise the Userlike Widget by passing the following props to the
305307

306308
</details>
307309

310+
<details>
311+
<summary> Chatwoot </summary>
312+
313+
To use Chatwoot import the `LiveChatLoaderProvider` and set the `provider` prop
314+
as `chatwoot` and the `providerKey` prop as your Chatwoot secret.
315+
316+
Then import the `Chatwoot` component.
317+
318+
```jsx
319+
import { LiveChatLoaderProvider, Chatwoot } from 'react-live-chat-loader'
320+
321+
export default () => (
322+
<LiveChatLoaderProvider
323+
providerKey="E33wn9ftxMDHZx18AaBkfPvY"
324+
provider="chatwoot"
325+
>
326+
/* ... */
327+
<Chatwoot />
328+
</LiveChatLoaderProvider>
329+
)
330+
```
331+
332+
You can customise the Chatwoot Widget by passing the following props to the
333+
`Chatwoot` component:
334+
335+
- `color`: The background color, set to same color value you choose in Chatwoot dashboard.
336+
337+
</details>
338+
308339
## Adding a provider
309340

310341
To contribute a new provider, follow these steps:

0 commit comments

Comments
 (0)