Skip to content

Commit 4fea732

Browse files
committed
📝update provider props documentation
1 parent ef6badd commit 4fea732

1 file changed

Lines changed: 16 additions & 9 deletions

File tree

README.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -157,13 +157,14 @@ export default class App extends React.Component {
157157
}
158158
```
159159

160-
You can customise the Help Scout beacon by passing the following props to the
160+
You can customise the Help Scout placeholder by passing the following props to the
161161
`HelpScout` component:
162162

163-
- `color`: The background color of the beacon
163+
- `color`: The background color of the placeholder
164164
- `icon`: Choose from `message`, `antenna`, `search`, `question`, `beacon`
165-
- `zIndex`: Changes the CSS index value of how the Beacon relates to other objects
165+
- `zIndex`: Changes the CSS index value of how the placeholder relates to other objects
166166
- `horizontalPosition`: Choose from `left` or `right`
167+
- `containerClass`: Class to be added to the placeholder element, defaults to `live-chat-loader-placeholder`
167168

168169
Currently the Help Scout component only supports the icon button style.
169170

@@ -192,8 +193,10 @@ export default class App extends React.Component {
192193
}
193194
```
194195

195-
You can customise the color of the Intercom widget by passing a `color` prop to
196-
the `Intercom` component.
196+
You can customise the Intercom placeholder icon by passing the following props to the `Intercom` component:
197+
198+
- `color`: The background color of the placeholder widget
199+
- `containerClass`: Class to be added to the placeholder element, defaults to `live-chat-loader-placeholder`
197200

198201
[Messenger Settings](https://developers.intercom.com/installing-intercom/docs/javascript-api-attributes-objects#messenger-attributes), User context and Company context settings can be set using `window.intercomSettings`. See the [official Intercom documentation](https://developers.intercom.com/installing-intercom/docs/javascript-api-attributes-objects#section-data-attributes) for more details.
199202

@@ -241,6 +244,7 @@ You can customise the Messenger widget by passing the following props to the
241244
currently not logged in to Facebook.
242245
- `greetingDialogDisplay`: Sets how the greeting dialog will be displayed.
243246
- `greetingDialogDelay`: Sets the number of seconds of delay before the greeting dialog is shown after the plugin is loaded.
247+
- `containerClass`: Class to be added to the placeholder element, defaults to `live-chat-loader-placeholder`
244248

245249
For a list of options, refer to [Facebook Customer Chat Plugin documentation](https://developers.facebook.com/docs/messenger-platform/discovery/customer-chat-plugin#customization).
246250

@@ -267,11 +271,12 @@ export default () => (
267271
)
268272
```
269273

270-
You can customise the Drift Messenger by passing the following props to the
274+
You can customise the Drift placeholder by passing the following props to the
271275
`Drift` component:
272276

273-
- `color`: The background color of the messenger
277+
- `color`: The background color of the placeholder
274278
- `icon`: Choose from `A`, `B`, `C`, `D`; you're presented with these preset icons when signing up for Drift, or in the "Drift Widget > Design > Widget icon" entry under the "App Settings" header on the Drift settings page.
279+
- `containerClass`: Class to be added to the placeholder element, defaults to `live-chat-loader-placeholder`
275280

276281
</details>
277282

@@ -297,7 +302,7 @@ export default () => (
297302
)
298303
```
299304

300-
You can customise the Userlike Widget by passing the following props to the
305+
You can customise the Userlike placeholder by passing the following props to the
301306
`Userlike` component:
302307

303308
- `color`: The contrasting color, can be `black` or `white`.
@@ -306,6 +311,7 @@ You can customise the Userlike Widget by passing the following props to the
306311
- `vOffset`: The amount of vertical margin.
307312
- `hOffset`: The amount of horizontal margin.
308313
- `style`: The shape style, can be `round` or `square`.
314+
- `containerClass`: Class to be added to the placeholder element, defaults to `live-chat-loader-placeholder`
309315

310316
</details>
311317

@@ -333,10 +339,11 @@ export default () => (
333339
)
334340
```
335341

336-
You can customise the Chatwoot Widget by passing the following props to the
342+
You can customise the Chatwoot placeholder by passing the following props to the
337343
`Chatwoot` component:
338344

339345
- `color`: The background color, set to same color value you choose in Chatwoot dashboard.
346+
- `containerClass`: Class to be added to the placeholder element, defaults to `live-chat-loader-placeholder`
340347

341348
</details>
342349

0 commit comments

Comments
 (0)