@ryen/js v0.2.7

Ryen JS library

Frontend library to embed bots from Ryen.

Installation

Using npm

To install, simply run:

npm install @ryen/js

Directly in your HTML

<script type="module">
  import Ryen from 'https://cdn.jsdelivr.net/npm/@ryen/js@0.2/dist/web.js'

  Ryen.initStandard({
    ryen: 'my-ryen',
  })
</script>

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

Standard

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

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

<script type="module">
  import Ryen from 'https://cdn.jsdelivr.net/npm/@ryen/js@0.2/dist/web.js'

  Ryen.initStandard({
    ryen: 'my-ryen',
  })
</script>

<ryen-standard style="width: 100%; height: 600px; "></ryen-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 Ryen.

Here is an example:

<script type="module">
  import Ryen from 'https://cdn.jsdelivr.net/npm/@ryen/js@0.2/dist/web.js'

  Ryen.initPopup({
    ryen: 'my-ryen',
    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:

Ryen.open()

Ryen.close()

Ryen.toggle()

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

<button onclick="Ryen.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 Ryen.

Here is an example:

<script type="module">
  import Ryen from 'https://cdn.jsdelivr.net/npm/@ryen/js@0.2/dist/web.js'

  Ryen.initBubble({
    ryen: 'my-ryen',
    previewMessage: {
      message: 'I have a question for you!',
      autoShowDelay: 5000,
      avatarUrl: 'https://app.ryen.org/favicon.png',
    },
    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:

Ryen.showPreviewMessage()

Ryen.hidePreviewMessage()

Open or close the Ryen

You can use these commands:

Ryen.open()

Ryen.close()

Ryen.toggle()

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

<button onclick="Ryen.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:

Ryen.initStandard({
  ryen: 'my-ryen',
  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.

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