Skip to content

docs: add extra remarks and troubleshoot section #24

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

Merged
merged 2 commits into from
May 23, 2020
Merged

docs: add extra remarks and troubleshoot section #24

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
00115dc
docs: add some extra remarks in readme
devrnt May 23, 2020
883ab5d
docs: add troubleshoot section in readme
devrnt May 23, 2020
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
17 changes: 16 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ const HomePage = () => {
* [API](#intercom)
* [Playground](#playground)
* [TypeScript](#typescript)
* [Troubleshoot](#troubleshoot)
* [Advanced](#advanced)

## API
Expand All @@ -56,6 +57,8 @@ const HomePage = () => {
### IntercomProvider
`IntercomProvider` is used to initialize the `window.Intercom` instance. It makes sure the initialization is only done once. If any listeners are passed, the `IntercomProvider` will make sure these are attached.

Place the `IntercomProvider` as high as possible in your application. This will make sure you can `useIntercom()` anywhere.

#### Props
| name | type | description | required | default |
|---------------------|------------------|-----------------------------------------------------------------------------------------|----------|---------|
Expand Down Expand Up @@ -96,7 +99,9 @@ const App = () => {
### useIntercom
Used to retrieve all methods bundled with Intercom. These are based on the official [Intercom docs](https://developers.intercom.com/installing-intercom/docs/javascript-api-attributes-objects). Some extra methods were added to improve convenience.

**Remark** - make sure `IntercomProvider` is wrapped around your component when calling `useIntercom()`
Make sure `IntercomProvider` is wrapped around your component when calling `useIntercom()`.

**Remark** - You can't use `useIntercom()` in the same component where `IntercomProvider` is initialized.

#### Methods
| name | type | description |
Expand Down Expand Up @@ -214,6 +219,16 @@ These props are `JavaScript` 'friendly', so [camelCase](https://en.wikipedia.org
**Remark** - if you want to pass custom properties, you should still use [snake_cased](https://en.wikipedia.org/wiki/Snake_case) keys.


## Troubleshoot
* I'm seeing "Please wrap your component with IntercomProvider.` in the console.
> Make sure `IntercomProvider` is initialized before calling `useIntercom()`. You only need to initialize `IntercomProvider` once. It is advised to initialize `IntercomProvider` as high as possible in your application tree.

> Make sure you aren't calling `useIntercom()` in the same component where you initialized `IntercomProvider`.

* I'm seeing `Some invalid props were passed to IntercomProvider. Please check following props: [properties]` in the console.
> Make sure you're passing the correct properties to the `IntercomProvider`. Check [IntercomProvider](#intercomprovider) to see all the properties.
> Mind that all the properties in `react-use-intercom` are camel cased, except for the `customAttributes` property in the `boot` and `update` method from `useIntercom`.

## Advanced
To reduce the amount of re-renders in your React application I suggest to make use of [`useCallback`](https://reactjs.org/docs/hooks-reference.html#usecallback)

Expand Down