Incase, you’d like to use the SDK instead of the chrome extension, please follow the steps below.
Note: Before you start recording your content, you need to install Hexus.js in your web app.
Hexus.js is a tiny piece of JavaScript code, which is loaded asynchronously in your web app, so it won’t affect your page load speed.
The installation is simple and only requires 3 quick steps:
Hexus.js can be installed in one of 2 ways:
We also have specific instructions for special apps/tools:
Example projects are available on the private GitHub link included in your license.
The Hexus private npm hosts the following packages.
@hexus/hexus-capture
@hexus/hexus-search
Locale files are available in the package, but can also be imported from @hexus/hexus/locale/<locale_code>
.
Create a new file in your project root folder and name it .npmrc
.
Copy the contents below to the file:
Replace $HEXUS_NPM_TOKEN
with your private HEXUS npm token as shown on the customer portal under your license details.
HEXUS scoped packages are now automatically installed from the HEXUS repository.
Sometimes the package manager will stick to the test version, in that situation you can try the following before re-installing:
npm uninstall @hexus/hexus
.node_modules
folder and package-lock.json
file.@hexus/hexus
.Only do this if you did not complete Step 2A.
Copy-paste the following snippet into your HTML document before the ending </body>
tag:
Important: Make sure to replace the placeholders with real, dynamic values from your app!
Other example projects are available on the private GitHub link included in your license.
Ensure that you have installed the @hexus/hexus
package.
Integrate Hexus into your application to utilize its demo creation capabilities.
Integrate the demo recording and playback functionality into your application.
You can also capture click-through events using Hexus by utilizing its built-in methods.
This setup assumes that @hexus/hexus
provides the necessary methods (init
, startRecording
, stopRecording
, playDemo
, and captureClick
) to handle demo creation and click-through capturing. Adjust the implementation details as necessary based on the specific features and methods provided by the SDK.
Improve your self-serve UX by offering keyboard-enabled searching of Hexus content, demos navigation across pages, and shortcuts to powerful actions
Other Example projects are available on the private GitHub link included in your license.
First, ensure that you have installed the @hexus/hexus-search
package as described previously.
To display the recorded demos, you need to retrieve the saved data and render it in your application. Here’s an example using React:
To use the search functionality and display component in your application, you can integrate it as follows:
This is a basic example to get you started with recording and displaying search results using the @hexus/hexus-search
package in your application. You can expand on this by adding more features and improving the user interface as needed, adding shortcuts etc.
Incase, you’d like to use the SDK instead of the chrome extension, please follow the steps below.
Note: Before you start recording your content, you need to install Hexus.js in your web app.
Hexus.js is a tiny piece of JavaScript code, which is loaded asynchronously in your web app, so it won’t affect your page load speed.
The installation is simple and only requires 3 quick steps:
Hexus.js can be installed in one of 2 ways:
We also have specific instructions for special apps/tools:
Example projects are available on the private GitHub link included in your license.
The Hexus private npm hosts the following packages.
@hexus/hexus-capture
@hexus/hexus-search
Locale files are available in the package, but can also be imported from @hexus/hexus/locale/<locale_code>
.
Create a new file in your project root folder and name it .npmrc
.
Copy the contents below to the file:
Replace $HEXUS_NPM_TOKEN
with your private HEXUS npm token as shown on the customer portal under your license details.
HEXUS scoped packages are now automatically installed from the HEXUS repository.
Sometimes the package manager will stick to the test version, in that situation you can try the following before re-installing:
npm uninstall @hexus/hexus
.node_modules
folder and package-lock.json
file.@hexus/hexus
.Only do this if you did not complete Step 2A.
Copy-paste the following snippet into your HTML document before the ending </body>
tag:
Important: Make sure to replace the placeholders with real, dynamic values from your app!
Other example projects are available on the private GitHub link included in your license.
Ensure that you have installed the @hexus/hexus
package.
Integrate Hexus into your application to utilize its demo creation capabilities.
Integrate the demo recording and playback functionality into your application.
You can also capture click-through events using Hexus by utilizing its built-in methods.
This setup assumes that @hexus/hexus
provides the necessary methods (init
, startRecording
, stopRecording
, playDemo
, and captureClick
) to handle demo creation and click-through capturing. Adjust the implementation details as necessary based on the specific features and methods provided by the SDK.
Improve your self-serve UX by offering keyboard-enabled searching of Hexus content, demos navigation across pages, and shortcuts to powerful actions
Other Example projects are available on the private GitHub link included in your license.
First, ensure that you have installed the @hexus/hexus-search
package as described previously.
To display the recorded demos, you need to retrieve the saved data and render it in your application. Here’s an example using React:
To use the search functionality and display component in your application, you can integrate it as follows:
This is a basic example to get you started with recording and displaying search results using the @hexus/hexus-search
package in your application. You can expand on this by adding more features and improving the user interface as needed, adding shortcuts etc.