Track Page Change

Updates UserGuiding SDK's internal page URL attribute and sends an page_view event to user storage. Our SDK handles this in default settings. If you want more control over UserGuiding's updates to page changes if the URL or page history changes too much, you can disable the auto page view capturing and make calls to the page method instead.

Type Definition

type page = () => void

Example:

userGuiding.page()

Disabling Page View Auto Capture

Make sure to set this variable before loading the SDK.

window.userGuidingSettings = {
	disablePageViewAutoCapture: true
}

When you disable auto capture, you need to make page() calls on every page change and the first page when userGuiding is loaded.

Activate Troubleshooter

Displays the Troubleshooter.

Type Definition

activateTroubleshooter()

Example:

userGuiding.activateTroubleshooter()

Deactivate Troubleshooter

Closes the Troubleshooter.

Type Definition

deactivateTroubleshooter()

Example:

userGuiding.deactivateTroubleshooter()