@papercups-io/storytime
Advanced tools
Comparing version 1.0.5 to 1.0.6-beta.0
@@ -43,2 +43,3 @@ import { Socket, Channel } from 'phoenix'; | ||
| stop?: () => void; | ||
| unsubscribe?: () => void; | ||
| constructor(config: Config); | ||
@@ -48,2 +49,3 @@ static init(config: Config): Storytime; | ||
| finish(): void; | ||
| handleVisibilityChange: (e?: any) => void; | ||
| cacheCustomerId: (customerId: string) => void; | ||
@@ -50,0 +52,0 @@ formatCustomerMetadata: (metadata: any) => {}; |
| { | ||
| "name": "@papercups-io/storytime", | ||
| "version": "1.0.5", | ||
| "version": "1.0.6-beta.0", | ||
| "description": "Track and record user sessions", | ||
@@ -5,0 +5,0 @@ "repository": { |
@@ -1,3 +0,89 @@ | ||
| # Storytime | ||
| # @papercups-io/storytime | ||
| WIP | ||
| > Papercups screen sharing feature | ||
| [](https://www.npmjs.com/package/@papercups-io/storytime) [](https://standardjs.com) | ||
| ## Demo | ||
| **Screenshot:** | ||
| <img width="1190" alt="Screen Shot 2020-11-02 at 2 35 02 PM" src="https://user-images.githubusercontent.com/5264279/97911075-b3ece700-1d18-11eb-875d-07db7c4f20b7.png"> | ||
| **GIF:** | ||
|  | ||
| ## Install | ||
| ```bash | ||
| 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: | ||
| ```html | ||
| <!-- | ||
| 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](https://github.com/papercups-io/chat-widget#using-in-html), you should **NOT** duplicate it here!_ | ||
| If you **already** have the config set, just include this script below it: | ||
| ```html | ||
| <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. | ||
| ```tsx | ||
| 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. | ||
| ``` |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
New alerts
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.91%
1943493
- Number of package files
- increased by5.26%
20
- Lines of code
- increased by1.24%
13104
- Number of lines in readme file
- increased by2150%
90
Worsened metrics
- Number of low quality alerts
- increased by100%
2
No dependency changes