UserView Installation

Installation options

Choose the method that best fits your project's requirements.

You'll find your Upscope installation code within your Upscope dashboard. Simply add the code anywhere on your webpage, or, if you prefer, add it to a JavaScript file by removing the <script> and </script> 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

While you can install Upscope through Google Tag Manager or Segment, the preferred method is to paste the installation code directly on your website, as this will result in faster load times.

Installation remains the same whatever front end framework you use. Upscope 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 Upscope SDK:

npm install --save @upscopeio/sdk

Import the Upscope Object:

import Upscope from '@upscopeio/sdk';

Initialize Upscope:

Upscope("init", {
  apiKey: "YOUR_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 API key.

Installation

To incorporate Upscope 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';

&lt;UpscopeProvider apiKey="YOUR_API_KEY" enabled={true/false}&gt;
  {/* rest of your app */}
&lt;/UpscopeProvider&gt;

Upscope will share the entire page, regardless of where the UpscopeProvider is added in your component hierarchy.

Configuration

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:

&lt;UpscopeProvider apiKey="YOUR_API_KEY" enabled={true} uniqueId={user.email}&gt;
  {/* Your application code here */}
&lt;/UpscopeProvider&gt;

Using Upscope Functionality in Components

To use Upscope features in your individual components, you can use the useUpscope hook:

import { useUpscope } from '@upscopeio/react';

function YourComponent() {
  const {
    Upscope,       // 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

Upscope 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 (
    &lt;&gt;
      &lt;Masked&gt;
        {/* Sensitive Info */}
      &lt;/Masked&gt;
      &lt;NoRemoteControl&gt;
        {/* Control Elements */}
      &lt;/NoRemoteControl&gt;
    &lt;/&gt;
  );
}

To disable remote control on a particular element:

import { NoRemoteControl } from '@upscopeio/react';

function YourComponent() {
  return (
    &lt;&gt;
      &lt;NoRemoteControl&gt;
        &lt;label&gt;
          Accept Terms of Service
          &lt;input type="checkbox" /&gt;
        &lt;/label&gt;
      &lt;/NoRemoteControl&gt;
    &lt;/&gt;
  );
}

By following these steps and guidelines, you can fully integrate Upscope into your React application and leverage its features effectively.