Frameworks

Get started with one of these guides if you're using a listed framework:

• React.js

• Next.js

• Vue.js

• Gatsby.js

• HTML

• SvelteKit

• Angular

Installing the SDK

Install highlight.run using your package manager.

# with npm
npm install highlight.run

# with yarn
yarn add highlight.run

Initialize

Initialize Highlight where your application starts.

import { H } from 'highlight.run'

H.init(
	'<YOUR_ORGANIZATION_ID>', // Get this from https://app.highlight.run/setup
)

Example

import React from 'react'
import { H } from 'highlight.run'

H.init('<YOUR_ORGANZATION_ID>') // Get this from https://app.hgihlight.run/setup

ReactDOM.render(
	<React.StrictMode>
		<App />
	</React.StrictMode>,
	document.getElementById('root'),
)

Verify

Start your app, go to it in the browser, then click around. Highlight will be recording your session and it will show up on https://app.highlight.run/sessions a few seconds after recording has started.