Welcome to Highlight
Getting Started
Overview
Backend / Server
Client / Frontend
Fullstack Frameworks
Tips
Content-Security-Policy
Local Development
Monkey Patches
Performance Impact
Proxying Highlight
Session Search Deep Linking
Troubleshooting
Upgrading Highlight
Session Replay
Console Messages
HTML iframe Recording
Identifying Users
Live Mode
Network DevTools
Privacy
Rage Clicks
Recording Network Requests and Responses
Session Sharing
Session Shortcut
Tracking Events
Versioning Sessions
Error Monitoring
Grouping Errors
Sourcemaps
Versioning Errors
Product Features
Alerts
Analytics
Canvas
Comments
Environments
Frontend Observability
Keyboard Shortcuts
Performance Data
Segments
Session Search
Team Management
User Feedback
Web Vitals
WebGL
Integrations
Amplitude Integration
Clearbit Integration
Electron Integration
Front Plugin
Intercom Integration
Linear Integration
Mixpanel Integration
React.js Integration
Segment Integration
Sentry Integration
Slack Integration
Vercel Integration
highlight.run Changelog
5.0.0
5.0.1
5.1.0
5.1.1
5.1.2
5.1.3
5.1.4
5.1.5
Menu
Docs / Getting Started / Client / Frontend / Overview

Overview

Frameworks

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

Installing the SDK

Install highlight.run using your package manager.

# with npm npm install highlight.run # with yarn yarn add highlight.run
Copy
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 )
Copy
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'), )
Copy
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.