npm package: @leapchat.io/js
Description: Javascript library to display leapchats on your website
Latest version: 0.1.18

# Leapchat JS library

Frontend library to embed leapchats from [Leapchat](https://www.leapchat.io/).

## Installation

### Using npm

To install, simply run:

```bash
npm install @leapchat.io/js
```

### Directly in your HTML

```
<script type="module">
  import Leapchat from 'https://cdn.jsdelivr.net/npm/@leapchat.io/js@0.1/dist/web.js'

  Leapchat.initStandard({
    leapchat: 'my-leapchat',
  })
</script>

<leapchat-standard style="width: 100%; height: 600px; "></leapchat-standard>
```

## Standard

You can get the standard HTML and Javascript code by clicking on the "HTML & Javascript" button in the "Share" tab of your leapchat.

There, you can change the container dimensions. Here is a code example:

```html
<script type="module">
  import Leapchat from 'https://cdn.jsdelivr.net/npm/@leapchat.io/js@0.1/dist/web.js'

  Leapchat.initStandard({
    leapchat: 'my-leapchat',
  })
</script>

<leapchat-standard style="width: 100%; height: 600px; "></leapchat-standard>
```

This code is creating a container with a 100% width (will match parent width) and 600px height.

## Popup

You can get the popup HTML and Javascript code by clicking on the "HTML & Javascript" button in the "Share" tab of your leapchat.

Here is an example:

```html
<script type="module">
  import Leapchat from 'https://cdn.jsdelivr.net/npm/@leapchat.io/js@0.1/dist/web.js'

  Leapchat.initPopup({
    leapchat: 'my-leapchat',
    apiHost: 'http://localhost:3001',
    autoShowDelay: 3000,
  })
</script>
```

This code will automatically trigger the popup window after 3 seconds.

### Open or Close a popup

You can use these commands:

```js
Leapchat.open()
```

```js
Leapchat.close()
```

```js
Leapchat.toggle()
```

You can bind these commands on a button element, for example:

```html
<button onclick="Leapchat.open()">Contact us</button>
```

## Bubble

You can get the bubble HTML and Javascript code by clicking on the "HTML & Javascript" button in the "Share" tab of your leapchat.

Here is an example:

```html
<script type="module">
  import Leapchat from 'https://cdn.jsdelivr.net/npm/@leapchat.io/js@0.1/dist/web.js'

  Leapchat.initBubble({
    leapchat: 'my-leapchat',
    previewMessage: {
      message: 'I have a question for you!',
      autoShowDelay: 5000,
      avatarUrl: 'https://avatars.githubusercontent.com/u/16015833?v=4',
    },
    theme: {
      button: { backgroundColor: '#0042DA', iconColor: '#FFFFFF' },
      previewMessage: { backgroundColor: '#ffffff', textColor: 'black' },
      chatWindow: { backgroundColor: '#ffffff' },
    },
  })
</script>
```

This code will show the bubble and let a preview message appear after 5 seconds.

### Open or close the preview message

You can use these commands:

```js
Leapchat.showPreviewMessage()
```

```js
Leapchat.hidePreviewMessage()
```

### Open or close the leapchat

You can use these commands:

```js
Leapchat.open()
```

```js
Leapchat.close()
```

```js
Leapchat.toggle()
```

You can bind these commands on a button element, for example:

```html
<button onclick="Leapchat.open()">Contact us</button>
```

## Additional configuration

You can prefill the bot variable values in your embed code by adding the `prefilledVariables` option. Here is an example:

```js
Leapchat.initStandard({
  leapchat: 'my-leapchat',
  prefilledVariables: {
    'Current URL': 'https://my-site/account',
    'User name': 'John Doe',
  },
})
```

It will prefill the `Current URL` variable with "https://my-site/account" and the `User name` variable with "John Doe". More info about variables: [here](/editor/variables).

Note that if your site URL contains query params (i.e. https://leapchat.io?User%20name=John%20Doe), the variables will automatically be injected to the leapchat. So you don't need to manually transfer query params to the bot embed configuration.