@papercups-io/storytime

Track and record user sessions

1.0.6

latest

GitHub

npm

Version published: 2 years ago

Maintainers: 2

Weekly downloads: 678; decreased by-4.24%

Weekly downloads

Readme

Source

@papercups-io/storytime

Papercups screen sharing feature

Demo

Screenshot: Screen Shot 2020-11-02 at 2 35 02 PM

GIF: demo

Install

npm install --save @papercups-io/storytime

Usage

First, sign up at https://app.papercups.io/register to get your account token. Your account token is what you will use to pass in as the accountId prop below.

Using in HTML

Paste the code below between your <head> and </head> tags:

<!-- 
  Note that if you already have included the `window.Papercups` configuration with the chat widget, 
  you should **NOT** duplicate it here! All the config settings should be the same for now.
-->
<script>
  window.Papercups = {
    config: {
      // Pass in your Papercups account token here after signing up
      accountId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx',
      // Optionally pass in metadata to identify the customer
      customer: {
        name: 'Test User',
        email: 'test@test.com',
        external_id: '123',
      },
      // Optionally specify the base URL
      baseUrl: 'https://app.papercups.io',
    },
  };
</script>
<script
  type="text/javascript"
  async
  defer
  src="https://app.papercups.io/storytime.js"
></script>

:warning: Note that if you already have included the window.Papercups configuration with the chat widget, you should NOT duplicate it here!

If you already have the config set, just include this script below it:

<script
  type="text/javascript"
  async
  defer
  src="https://app.papercups.io/storytime.js"
></script>

Using as an NPM module

Place the code below in any pages on which you would like to render the widget. If you'd like to render it in all pages by default, place it in the root component of your app.

import {Storytime} from '@papercups-io/storytime';

const st = Storytime.init({
  // Pass in your Papercups account token here after signing up 
  accountId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx',
  // Optionally specify the base URL
  baseUrl: 'https://app.papercups.io',
});

// If you want to stop the session recording manually, you can call:
// st.finish();

// Otherwise, the recording will stop as soon as the user exits your website.

FAQs

What is @papercups-io/storytime?

Is @papercups-io/storytime popular?

Is @papercups-io/storytime well maintained?

Last updated on 04 Nov 2020

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket