Installation
Overview
UserView can be installed using one of the following methods:
- Installing via Script Tag - Directly add the code snippet to your web page.
- Installing via NPM - Ideal for projects using a Node.js environment.
- Installing via React - For React-based applications.
Choose the method that best fits your project's requirements.
You'll find your installation code within your UserView dashboard. Simply add the code anywhere on your webpage, or, if you prefer, add it to a JavaScript file by removing the tags from the code.
Recommendation: Make sure that the code loads as fast as possible by adding it as one of the first things that execute on the page.
Warning
Installation remains the same whatever front end framework you use. UserView works fine with React, Angular, and most other modern JavaScript frameworks. All you need to do is add the code to the page.
- Install the SDK
npm install --save @upscopeio/sdk - Import the Upscope Object
import Upscope from '@upscopeio/sdk'; - Initialize
Upscope("init", { apiKey: "<public_api_key>" });
Note: You can use the Upscope object wherever required, and call the same functions that are available with the regular installation. Initialization (init) needs to be called first and must include your public API key.
Public API Key
You can find yours in the installation page of your UserView dashboard.
Installation
To incorporate UserView into your React project, first install the React-specific package using npm:
npm install --save @upscopeio/react
Import the UpscopeProvider component and wrap your main application component with it.
import { UpscopeProvider } from '@upscopeio/react';
<UpscopeProvider apiKey="<public_api_key>" enabled={true/false}>
{/* rest of your app */}
</UpscopeProvider>
Entire page shared
UpscopeProvider is added in your component hierarchy.Configuration
Public API Key
You can find yours in the installation page of your UserView dashboard.
The UpscopeProvider accepts props that you can use for additional configuration settings. These settings are similar to the ones you would specify using the init function in the standard SDK. For example, to specify a unique identifier for a user, you can do:
<UpscopeProvider apiKey="<public_api_key>" enabled={true} uniqueId={user.email}>
{/* Your application code here */}
</UpscopeProvider>
Using Functionality in Components
To use UserView features in your individual components, you can use the useUpscope hook:
import { useUpscope } from '@upscopeio/react';
function YourComponent() {
const {
Upscope, // SDK object
shortId, // Connected shortId or undefined
getLookupCode, // Asynchronous function to get lookup code
listen, // Event listener function
reset, // Reset function
isSharing // Boolean indicating active session
} = useUpscope();
// Your component logic here
}
Additional Utilities: Masking and Disabling Remote Control
UserView offers utility components to mask sensitive data and disable remote control on specific UI elements.
To mask sensitive information:
import { Masked, NoRemoteControl } from '@upscopeio/react';
function YourComponent() {
return (
<>
<Masked>
{/* Sensitive Info */}
</Masked>
<NoRemoteControl>
{/* Control Elements */}
</NoRemoteControl>
</>
);
}
To disable remote control on a particular element:
import { NoRemoteControl } from '@upscopeio/react';
function YourComponent() {
return (
<>
<NoRemoteControl>
<label>
Accept Terms of Service
<input type="checkbox" />
</label>
</NoRemoteControl>
</>
);
}
By following these steps and guidelines, you can fully integrate UserView into your React application and leverage its features effectively.
Testing on a Local or Staging Environment
When you test on your own computer or in a staging environment that is not publicly accessible, you might notice some odd rendering issues.
This is because our proxy server is unable to reach your CSS and media files and therefore can't properly edit them to render on the Agent side.
We try to automatically detect if you are on a URL that looks like localhost (e.g. http://127.0.0.1/, http://localhost/, etc.), and send the content of CSS files directly from the Visitor's browser to the Agent's browser.
You can add more URLs for browser proxying in your dashboard settings.
Iframe Support
UserView will work with iframes without you needing to do anything when these are hosted on the same domain. This means that the part of the URL between :// and the first / is exactly the same (i.e. app.acme.com and dashboard.acme.com are considered different domains).
In this case, you only need to add the script to the outermost frame (i.e. the parent page).
You don't need to do anything to make UserView work cross-domain if iframes aren't involved.
Different Domains
To make UserView work when you have iframes on different domains/subdomains, you'll need to add the code to all the iframes. This is the code you get from your dashboard's installation page.
The iframes will connect automatically.
Using the SDK
When You Have a Lot of Visitors
If your website has a lot of Visitors (i.e. over 5,000 connected at once), you might want to only connect Visitors who actually need help.
You can easily do this by passing autoconnect: false to the configuration, like this (or by turning this off in the dashboard):
// Rest of the installation code...
Upscope('init', {
autoconnect: false
})
The visitor will be connected automatically if they have recently been in a Session, and will also automatically connect if they are shown the lookup code through any means.
You can also manually connect the Visitor by calling Upscope('connect');
CSP Rules
If you use Content Security Policy rules to protect your website, you'll need to add the following URLs to allow UserView to work correctly.
script-src 'self' https://code.upscope.io https://js.upscope.io;
connect-src wss://*.upscope.io https://*.upscope.io;
media-src https://js.upscope.io;
img-src https://app.upscope.io https://app-cdn.upscope.io;
Prototype.js
To make UserView compatible with some older versions of Prototype, include the following code before the installation code.
<script>
if (window.Prototype) {
delete Object.prototype.toJSON;
delete Array.prototype.toJSON;
delete Hash.prototype.toJSON;
delete String.prototype.toJSON;
}
</script>